commands_prsqa – Issue PRSQA command for CA 7 instance specified in path

Synopsis

The PRSQA command activates a corequisite resource.

When a job is connected to a corequisite resource and the resource usage type is active, use the PRSQA command to activate the corequisite resource.

If VRM corequisite propagation is enabled and the resource name matches the propagation prefix,

the command is forwarded to the CA 7 instances that are specified in the initialization file options unless INTERNAL=YES is specified.

Command propagation is honored even if the resource is already active.

Parameters

ca7_id (required, type: str)

CA7ONL Instance.

key (type: str)

The command transaction key.

rsrc (type: str)

Specifies a fully qualified corequisite resource name.

Limits:

1 to 44 alphanumeric characters.

internal (type: str)

(Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances

even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.

Default: NO.

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: Activated the resource CICSREG8 for Instance1
  broadcom.ca7.commands_prsqa:
    rsrc: CICSREG8

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.