commands_rmttrk – Defines a dependency on a remote CA 7 job

Synopsis

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

Parameters

remote_sched (required, type: str)

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.

job_name (required, type: str)

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.

status (type: str)

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

.

date_time_status_changed (type: str)

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.

host (required, type: str)

Host name of the CA7 API service that is running on the mainframe system.

port (required, type: int)

Port for the CA7 API service that is running on the mainframe system.

user (required, type: str)

User name for authenticating connections to the CA7 API service that is running on the mainframe system.

password (required, type: str)

Password for authenticating connections to the CA7 API service that is running on the mainframe system.

base_path (type: str)

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.

protocol (required, type: str)

Specifies protocol to use for CA7 connection (http or https).

Choices:

  • http

  • https

reject_unauthorized (type: bool, default: True)

Reject self-signed certificates.

cert_file (type: path)

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.

cert_key_file (type: path)

The file path to a certificate key file to use for authentication.

Examples

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

Return Values

data (type: list, when returned data is a dictionary)

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.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.