commands_hold_1 – Issue HOLD command for DEFAULT_INSTANCE

Synopsis

The HOLD command interrupts the normal scheduling progress by holding the forward movement of a job.

The command can also hold the contents of an entire queue.

This function is available on the QM.1 panel with a FILL value of H.

Depending on the timing and whether you have any other predecessor situations, the QM.3 panel can sometimes accomplish this process.

Parameters

key (type: str)

The command transaction key.

ca7# (type: str)

Defines the individual job number to hold. Omit if Q is specified.

jobnumber

Defines the job number of the job to hold.

Limits:

1 to 4 numeric characters

Required: Yes, unless the Q parameter is used.

q (type: str)

Specifies to hold the contents of an entire queue.

Possible values:

REQ

Specifies to hold all jobs currently in the request queue. RDY

Specifies to hold all jobs currently in the ready queue.Required: Yes, unless job number is used.

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: Hold the CA7 number 29
  broadcom.ca7.commands_hold_1:
    ca7#: 29

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.