commands_restart – Restart a job awaiting in the request queue
Synopsis
Restart a single job to CA 7.
Parameters
- ca7num (required, type: str)
Ca7num=0016
Defines the name of the job to Restart.
Indicates the individual job to Restart, and the value must be a CA 7 job number.
- bypgdg (type: str)
Bypgdg={NO|YES|VER|CAT}
Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.
Value can be NO, YES, VER, or CAT.
Default: CA Workload Automation Restart Option for z/OS Schedulers default value.
- condcd (type: str)
Condcd=nnnn
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code
that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA Workload Automation CA 7® Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits: 1 to 4 numeric characters from 0 to 4095.
- forcecomp (type: str)
Forcecomp={NO|YES}
Indicates whether to flag the job as a normal completion.
If FORCECOMP=YES, the previous abnormal status of the job is ignored.
Normal job completion processing is performed instead of a restart.
Value can be NO or YES. NO is the default.
- lcc (type: str)
Lc=nnnn
Indicates an optional condition code value that replaces the last
condition code value for the step that the LSTP references and, optionally, LPSTP keywords.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Default: 0
Limits: 1 to 4 numeric characters from 0 to 4095.
- lstp (type: str)
Lstp=JS050
Indicates an optional step name that has its last condition code value reset in the
CA Workload Automation Restart Option for z/OS Schedulers CMT.
Code LSTP and LCC when LPSTP is specified.
LSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.
This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters.
- lpstp (type: str)
Lpstp=COPY010
Indicates an optional step name referencing a procedure that has its last condition code value reset
in the CA Workload Automation Restart Option for z/OS Schedulers CMT.
If LPSTP is used, also code LSTP and LCC.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters.
- procstrt (type: str)
Procstrt=procname
Indicates an optional step name referencing a procedure where processing is to start.
If PROCESS=R and PROCSTRT are used, also code STPSTRT.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters.
- procend (type: str)
Procend=procname
Indicates an optional step name referencing a procedure where processing is to end.
If PROCESS=R and PROCEND are used, code STPEND.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters.
- process (type: str)
Process=code
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.
Default: P
Limits: 1 alphabetic character.
- reason (type: str)
Reason=text
Specifies a reason for the restart.
If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,
a code of up to four characters can be input and it is expanded.
Any reason input or expanded is copied to the run log.
This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or
REASON=YES was specified in the RESTART statement in the initialization file.
Limits: 1 to 40 alphanumeric characters.
- stpend (type: str)
Stpend=stepname
Indicates an optional step name or number at which processing is to end.
If not specified, the last step of the job is assumed to be the ending step.
Code STPEND when PROCEND is specified.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters.
- stpstrt (type: str)
Stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}
Indicates an optional step name or number at which processing is to start.
If STPSTRT is not coded, the first step of the job is assigned to be the starting step.
Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
It can be one of
stepname
Specifies the step name or number at which processing is to start.
*CMT*
Indicates that the job is to restart with the step values currently on the CMT record.
*RERUN*
Indicates to rerun t the total job. If there are no restartable steps, specify RERUN.
*RESUBP*
Indicates that the CMT record of the job is set to production, and then the job is submitted.
- sup11stp (type: str)
Sup11stp={NO|YES}
Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.
Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.
See the INSERT-RMS field on the DB.1 panel.
Value can be NO or YES. NO is the default.
- usage (type: str)
Usage=code
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers
usage code of the character to use in the restart/rerun.
For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and
CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits: 1 alphanumeric character.
- ca11rstp (type: str)
Ca11rstp={Y|YES}
Displays the CA11 restart step. Value can be Y or YES.
- 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: Restart ca7 number, 0016 from CA 7
broadcom.ca7.commands_restart:
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.