zowe › ca7 › commands › hold🖨️

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.

Usage

zowe ca7 commands hold [options]

Required Options

• --ca7Id (string)

  • CA7ONL Instance

Options

• --key (string)

  • The command transaction key

• --ca7# (string)

  • 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 (string)

  • 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.

CA7 Connection Options

• --host | -H (string)

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

• --port | -P (number)

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

• --user | -u (string)

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

• --password | --pass | --pw (string)

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

• --base-path | --bp (string)

  • The base path for your 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 API mediation layer.

• --protocol | -o (string)

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

    Allowed values: http, https

Profile Options

• --ca7-profile | --ca7-p (string)

  • The name of a (ca7) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file 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 (local file path)

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

Examples

• Hold the CA7 number 29 on Instance1:

  • zowe ca7 commands hold --ca7Id Instance1 --ca7# 29 Copy