broadcom / broadcom.ca7 / 2.0.7 / module / commands_runh Run a CA 7 job and place the job in hold status | "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.broadcom.ca7.commands_runh (2.0.7) — module
Install with ansible-galaxy collection install broadcom.ca7:==2.0.7
collections: - name: broadcom.ca7 version: 2.0.7
Run and hold a single job to CA 7.
- name: Run and holds a job, PAYROLL to CA 7 broadcom.ca7.commands_runh: job: PAYROLL
job: description: - Job=PAYROLL - '' - Defines the long name of the job to run. - The ran jobs are placed in the request queue and assigned a unique CA 7 job number. required: false type: str rms: description: - Rms={NO|YES} - '' - Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step. - '' - Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted. - '' - The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field. - 'Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.' - 'Limits: Invalid for internal cross-platform jobs.' required: false type: str dotm: description: - Dotm=hhmm - '' - Defines the due-out time-of-day for the job in hours (hh) and minutes (mm). - If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day. - '' - If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM. - '' - 'Limits: hh= 2 numeric characters from 0 to 24' - mm= 2 numeric characters from 00 to 59 - '' - 'Required: No (unless DATE is used, if so, DOTM or TIME must be specified).' required: false type: str exec: description: - Exec={NO|YES} - '' - Specifies whether to execute the job (YES/NO). - If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field. - '' - 'Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.' required: false type: str host: description: - Host name of the CA7 API service that is running on the mainframe system. required: true type: str jobl: description: - Job=payrollSW123 - '' - Identifies the job to submit. - The value must be a long job name. - If the job has not been defined in the database, use JOB instead. - See also JCLID. JOB and JOBL are mutually exclusive. - 'Limits:' - 1 to 64 alphanumeric characters - . required: false type: str late: description: - Late={NO|YES} - '' - Specifies whether a notification occurs when the job becomes late. - Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field. required: false type: str port: description: - Port for the CA7 API service that is running on the mainframe system. required: true type: int time: description: - Time={hhmm|+hhmm} - '' - Establishes a submit time-of-day requirement for the job. - '' - 'Format: hhmm' - Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59). - Leading zeros are not required - '' - . required: false type: str type: description: - Type={CLOCK|END|RES|START} - '' - Indicates that the job is being scheduled for rerun. - The value must be specified as shown. - '' - 'TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END.' required: false type: str user: description: - User name for authenticating connections to the CA7 API service that is running on the mainframe system. required: true type: str class: description: - Class=n - '' - Defines the workload balancing class for resource checking. - '' - 'Limits: 1 alphanumeric character.' required: false type: str jclid: description: - Jclid=10 - '' - Defines the JCL data set that contains the execution JCL to be submitted. - '' - If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file). - '' - 'If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.' required: false type: str schid: description: - Schid={1|nnn} - '' - 'Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.' - '' - 'Default: 1' - 'Limits: 1 to 3 numeric characters from 1 to 999 (See Note)' - '' - No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required). required: false type: str arfset: description: - Arfset={arfsetname|**NONE**} - '' - Defines the ARF set name that is used for this run of the job. - If you specify **NONE**, no ARF processing is performed for this run of the job. - '' - 'Limits: 1 to 8 alphanumeric characters or **NONE**.' required: false type: str jcllib: description: - Jcllib=&SPECIAL - '' - Defines the JCL data set that contains the execution JCL to be submitted. - '' - If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file). - '' - 'If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&).' required: false type: str leadtm: description: - Leadtm={0100|hhmm} - '' - Specifies the lead (processing) time that is required for the job to run. - 'If omitted, 1 hour is usedFormat: hhmm' - 'Limits: hh= 2 numeric characters from 0 to 24' - mm= 2 numeric characters from 00 to 59You can omit leading zeros. required: false type: str mainid: description: - Mainid={ALL|SYn|/SYn|-SYn} - '' - Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job. - 'The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:' - '' - ALL - Specifies all CPUs are acceptable for executing the job. - '' - SYn - n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7. - '' - /SYn - n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7. - '' - -SYn - n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7. - '' - 'Limits: Invalid for internal cross-platform jobs.' 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 protocol: choices: - http - https description: - Specifies protocol to use for CA7 connection (http or https). required: true 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 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