commands_subtm – Modifies the required submit time-of-day for a job in the request queue

Synopsis

SUBTM modifies the required submit time-of-day for a job in the request queue.

Parameters

ca7num (required, type: str)

Ca7num=0016

Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.

Limits: 1 to 4 alphanumeric characters.

time (type: str)

Example: 1830

(Optional) Specifies the new submit time-of-day in hours and minutes.

TIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement.

If TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm

Defines the time-of-day where hh is hours (0 through 24) and

mm is minutes (00 through 59). Maximum is 2400.

If the value given is less than the current time (when the command is processed), the submit day is incremented by one.

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: Modifies the required submit time for a ca7 number, 0016
  broadcom.ca7.commands_subtm:
    ca7num: 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.