broadcom.endevor.execute_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 execute package module executes a Package that have a status of Approved or Execfailed.

Usage examples

Scanned by Steampunk Spotter

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

- name: Execute package with endevor profile set up, specifying the time frame within which to execute the Package
  broadcom.endevor.execute_package:
    package: packageName
    from_date_time: 2018-01-01T00:00
    to_date_time: 2018-12-31T12:00
    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

status:
    choices:
    - ALLSTATE
    - INEDIT
    - INAPPROVAL
    - APPROVED
    - INEXECUTION
    - EXECUTED
    - COMMITTED
    - DENIED
    - EXECFAILED
    description:
    - 'Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for
      execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED,
      COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action. '
    - It is possible to specify multiple status separated by "," during list and delete
      package.
    required: false
    type: str

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

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

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

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

asynchronous:
    description:
    - Submit this module as an asynchronous Endevor Web Services task.
    required: false
    type: bool

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

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

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