broadcom.endevor.create_package (7.7.2) — module

Install collection

Install with ansible-galaxy collection install broadcom.endevor:==7.7.2

Add to requirements.yml

  collections:
    - name: broadcom.endevor
      version: 7.7.2

Description

The create package module lets you create a package in Endevor.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create package from local file with endevor profile set up
  broadcom.endevor.create_package:
    package: packageName
    from_file: localfile.txt
    description: package description
    instance: ENDEVOR

Inputs

    
host:
    description:
    - Specifies the base host name.
    required: false
    type: str

port:
    description:
    - Specifies the port number.
    required: false
    type: str

user:
    description:
    - Specifies the user name.
    required: false
    type: str

maxrc:
    default: 8
    description:
    - The maximum value of the return code of a successful action. When the return code
      is greater than the maxrc value, the module fails.
    required: false
    type: int

notes:
    description:
    - Notes for package.
    required: false
    type: str

backout:
    default: true
    description:
    - Set this option to false (or specify --no-backout) if you don't want to have the
      backout facility available for this package. By default backout is enabled.
    required: false
    type: bool

package:
    description:
    - Name of the Endevor package.
    required: false
    type: str

instance:
    description:
    - Specifies Endevor Web Services dataSource name.
    required: false
    type: str

password:
    description:
    - Specifies the user's password.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Specifies the protocol used for connecting to Endevor Rest API.
    required: false
    type: str

sharable:
    description:
    - Specify this option if the package can be edited by more than one person when in
      In-edit status.
    required: false
    type: bool

base_path:
    description:
    - Specifies the base path used for connecting to Endevor Rest API.
    required: false
    type: str

cert_file:
    description:
    - The file path to a certificate file to use for authentication.
    - ''
    - 'Note: The CLI does not support certificate files that require a password. For more
      information, search Troubleshooting PEM Certificates in Zowe Docs.'
    required: false
    type: path

from_file:
    description:
    - Use this input to provide source file.
    required: false
    type: str

from_text:
    description:
    - Provides a string to use as input SCL.
    required: false
    type: str

promotion:
    description:
    - Specify this option to define the package as a promotion package.
    required: false
    type: bool

report_dir:
    description:
    - Directory for saving reports from Endevor SCM locally, if wasn't specified. Defaults
      to current directory.
    required: false
    type: str

description:
    description:
    - Allows you to associate a 50-character description when creating or updating package.
    required: true
    type: str

from_member:
    description:
    - Use this input to provide source member name in the data set.
    required: false
    type: str

report_file:
    description:
    - File name for saving reports from Endevor SCM locally.
    required: false
    type: str

from_dataset:
    description:
    - Use this input to provide source data set name.
    required: false
    type: str

from_package:
    description:
    - Directs the Create/Update action to copy the SCL from the package you specify into
      the package you are creating or updating.
    required: false
    type: str

to_date_time:
    description:
    - Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm
      or see ISO 8601 standard for syntax.
    required: false
    type: str

validate_scl:
    default: true
    description:
    - Set this option to false (or specify --no-validate-scl) to skip validion of the
      package components while creating a package. By default the SCL is validated.
    required: false
    type: bool

write_report:
    description:
    - Write the endevor reports to a file. By default, when return code is 0, no report
      will be written, unless this option is specified. When return code is bigger than
      0, reports will be written to a file, unless this option is specifed to be false.
    required: false
    type: bool

cert_key_file:
    description:
    - The file path to a certificate key file to use for authentication.
    required: false
    type: path

from_date_time:
    description:
    - Specify the beginning of time frame within which the package can be executed. Use
      yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    required: false
    type: str

notes_from_file:
    description:
    - Local file of notes for package.
    required: false
    type: str

emergency_package:
    description:
    - Specify if the package should be an emergency package. When not specified, the package
      is a standard package.
    required: false
    type: bool

suppress_messages:
    description:
    - Suppress all [INFO]/[WARN] messages from terminal output.
    required: false
    type: bool

reject_unauthorized:
    description:
    - Specify this option to have the server certificate verified against the list of
      supplied CAs.
    required: false
    type: bool

Outputs

data:
  description: Data from the module execution (a data structure). The items of this
    dict are set as individual return values on the top level as well.
  elements: dict
  returned: when returned data is a dictionary
  type: list
error:
  contains:
    additional_details:
      description: Detailed message about the failure.
      type: str
    msg:
      description: Short description of the result or failure.
      type: str
    request:
      description: HTTP method used to invoke API service request.
      returned: API request failed
      type: str
    resource:
      description: URI of the resource of the API service request.
      returned: API request failed
      type: str
  description: More details about why the action has failed. If the failure is when
    calling an API service, the response contains the connection parameters.
  returned: error
  type: complex
failed:
  description: A boolean that indicates if the task was failed or not.
  returned: always
  type: bool
list:
  description: Data from the module execution (a list of data structures).
  elements: dict
  returned: when returned data is a list
  type: list
msg:
  description: Short description of the result or failure.
  returned: sometimes
  type: str
rc:
  description: Exit code of the module, successful exit code is 0, failure is typically
    1 or higher.
  returned: always
  type: int
stderr:
  description: Details of the error.
  returned: error
  type: str
stdout:
  description: Summary of the result.
  returned: success
  type: str