commands_addrq – Issue ADDRQ command for CA 7 instance specified in path

Synopsis

The ADDRQ command manually adds temporary, one-time, preexecution user or predecessor job requirements.

These requirements must be added to the job while it is in the CA Workload Automation CA 7 Edition

request queue. These added requirements apply only to the current run of the job.

You must manually satisfy user requirements with the QM.2 panel (POST) or XRQ command before the job executes.

Predecessor job requirements are satisfied automatically when the predecessor job completes successfully.

Parameters

ca7_id (required, type: str)

CA7ONL Instance.

key (type: str)

The command transaction key.

ca7# (type: str)

Defines the job to which you want to add the job requirement.

The job must be in the request queue.

jobnumber

Defines the CA 7 job number to which you want to add the requirement for this run of the job.

Limits:

1 to 4 numeric characters

depjob (type: str)

Defines a temporary one-time job dependency requirement.

The DEPJOB value specifies the job name that must complete execution or must be manually posted complete before the job identified by JOB is

eligible for submission.

DEPJOB is required unless USR is used, in which case, omit DEPJOB.

This requirement is satisfied automatically when the predecessor job completes.

Only in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur.

Required: Yes, unless USR is used.

Limits:

1 to 8 alphanumeric characters.

usr (type: str)

Defines the description of a temporary, one-time user requirement..

This requirement must be manually satisfied before the job identified by JOB is eligible for submission.

If any commas are included as part of the text, enclose the entire requirements text in parentheses.

This requirement is satisfied automatically when the predecessor job completes.

Only in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur.

Required: USR is required unless DEPJOB is used, in which case, omit USR.

Limits:

1 to 36 alphanumeric characters.

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: Adds the job requirement ca7 number, '0016' from CA 7 on Instance1
  broadcom.ca7.commands_addrq:
    ca7#: '0016'

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.