broadcom.ca7.commands_rmttrk (2.0.7) — module

Install collection

Install with ansible-galaxy collection install broadcom.ca7:==2.0.7

Add to requirements.yml

  collections:
    - name: broadcom.ca7
      version: 2.0.7

Description

The RMTTRK defines a dependency on a job in a remote CA 7 workload.

Usage examples

Scanned by Steampunk Spotter

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

- name: Rmttrk job name JOB123 to CA 7
  broadcom.ca7.commands_rmttrk:
    job_name: JOB123

Inputs

    
host:
    description:
    - Host name of the CA7 API service that is running on the mainframe system.
    required: true
    type: str

port:
    description:
    - Port for the CA7 API service that is running on the mainframe system.
    required: true
    type: int

user:
    description:
    - User name for authenticating connections to the CA7 API service that is running
      on the mainframe system.
    required: true
    type: str

status:
    description:
    - Status=FAILURE
    - ''
    - The status of job named on job-name.
    - 'The analogue of this service in AutoSys is change-status-job which supports these
      values:'
    - FAILURE, INACTIVE, RUNNING, STARTING, SUCCESS, TERMINATED
    - .
    required: false
    type: str

job_name:
    description:
    - Job-name=PAYJOB
    - ''
    - The name of job running in the publishing scheduler that invokes this command.
    - 'Limits: Autosys job names can be up to 64 characters.Valid characters are a-z,
      A-Z, 0-9, period (.),underscore (_), hyphen (-), colon (:), and pound (#).Do not
      include embedded spaces or tabs.'
    required: true
    type: str

password:
    description:
    - Password for authenticating connections to the CA7 API service that is running on
      the mainframe system.
    required: true
    type: str

protocol:
    choices:
    - http
    - https
    description:
    - Specifies protocol to use for CA7 connection (http or https).
    required: true
    type: str

base_path:
    description:
    - The base path for your Zowe API Mediation Layer instance. Specify this option to
      prepend the base path to all resources when making REST requests. Do not specify
      this option if you are not using an Zowe API Mediation Layer.
    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

remote_sched:
    description:
    - Remote-sched=AS1
    - ''
    - The name of publishing scheduler that issues this RMTTRK command.
    - Must be defined to receiving CA7ONL using XN.7.
    - This name is provided to the remote scheduler at subscription time.
    - 'Limists: 1-4 alphanumeric  characters.'
    required: true
    type: str

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

reject_unauthorized:
    default: true
    description:
    - Reject self-signed certificates.
    required: false
    type: bool

date_time_status_changed:
    description:
    - Date-time-status-changed=2021-08-12T10:12:13.680000-04:00
    - ''
    - Date/time remote scheduler detected status change reported by the STATUS keyword.
    - 'Limits: ISO8601 character format.'
    required: false
    type: str

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