commands_prscf – Frees a shared resource that belongs to a job

Synopsis

The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job.

Parameters

job (type: str)

Example: 1234

Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.

jobnumber

Indicates a specific CA 7 job number.

Limits: 1 to 4 numeric characters.

rsrc (type: str)

Example: RESOURCE.TYPE2.EXEC

Specifies the fully qualified resource name to free.

You can optionally specify * to indicate to free all resources that are connected to the job.

Limits: 1 to 44 alphanumeric characters.

force (type: str)

Example: YES

(Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate

the availability of the named resources for this run of the job only.

This run of the job does not use the named resources.

This keyword can be used on an exception basis to let a job in a

W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.

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: Frees a shared resource name, ZOWECRM1 that attached to the job 1234
  broadcom.ca7.commands_prscf:
    job: 1234
    rsrc: ZOWECRM1

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.