Try SpotterRestart a job awaiting in the request queue
| "added in version" 1.0.0 of broadcom.ca7"
Authors: Daniel Remta <daniel.remta@broadcom.com> (@broadcom)
| supported by Broadcom
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install broadcom.ca7:==2.0.7
collections:
- name: broadcom.ca7
version: 2.0.7Restart a single job to CA 7.
- name: Restart ca7 number, 0016 from CA 7
broadcom.ca7.commands_restart:
ca7num: 0016
lcc:
description:
- 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.'
required: false
type: str
host:
description:
- Host name of the CA7 API service that is running on the mainframe system.
required: true
type: str
lstp:
description:
- 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.'
required: false
type: str
port:
description:
- Port for the CA7 API service that is running on the mainframe system.
required: true
type: int
user:
description:
- User name for authenticating connections to the CA7 API service that is running
on the mainframe system.
required: true
type: str
lpstp:
description:
- 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.'
required: false
type: str
usage:
description:
- 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.'
required: false
type: str
bypgdg:
description:
- 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.'
required: false
type: str
ca7num:
description:
- 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.
required: true
type: str
condcd:
description:
- 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\xAE 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.'
required: false
type: str
reason:
description:
- 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.'
required: false
type: str
stpend:
description:
- 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.'
required: false
type: str
procend:
description:
- 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.'
required: false
type: str
process:
description:
- 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.'
required: false
type: str
stpstrt:
description:
- 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.
required: false
type: str
ca11rstp:
description:
- Ca11rstp={Y|YES}
- ''
- Displays the CA11 restart step. Value can be Y or YES.
required: false
type: str
password:
description:
- Password for authenticating connections to the CA7 API service that is running on
the mainframe system.
required: true
type: str
procstrt:
description:
- 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.'
required: false
type: str
protocol:
choices:
- http
- https
description:
- Specifies protocol to use for CA7 connection (http or https).
required: true
type: str
sup11stp:
description:
- 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.
required: false
type: str
base_path:
description:
- 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.
required: false
type: str
cert_file:
description:
- 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.'
required: false
type: path
forcecomp:
description:
- 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.
required: false
type: str
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
reject_unauthorized:
default: true
description:
- Reject self-signed certificates.
required: false
type: bool
data:
description: 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.
elements: dict
returned: when returned data is a dictionary
type: list
error:
contains:
additional_details:
description: Detailed message about the failure.
type: str
msg:
description: Short description of the result or failure.
type: str
request:
description: HTTP method used to invoke API service request.
returned: API request failed
type: str
resource:
description: URI of the resource of the API service request.
returned: API request failed
type: str
description: More details about why the action has failed. If the failure is when
calling an API service, the response contains the connection parameters.
returned: error
type: complex
failed:
description: A boolean that indicates if the task was failed or not.
returned: always
type: bool
list:
description: Data from the module execution (a list of data structures).
elements: dict
returned: when returned data is a list
type: list
msg:
description: Short description of the result or failure.
returned: sometimes
type: str
rc:
description: Exit code of the module, successful exit code is 0, failure is typically
1 or higher.
returned: always
type: int
stderr:
description: Details of the error.
returned: error
type: str
stdout:
description: Summary of the result.
returned: success
type: str