update_job_definition_job – Use the options to update the definition of a job

Synopsis

Update requirement definition for a job.

Parameters

job (required, type: str)

The name of the job to update

.

job_type (required, type: str)

The type of job. Valid values are: CPU|XPJOB|AGENT

.

execute (type: str)

Indicates whether to execute this job.

Valid values are: Y/N

.

use_jcl_override_library (type: str)

Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N).

This field is automatically set back to N the next time the job comes into the request queue

.

do_not_schedule_before_date (type: str)

Specifies not to schedule this job before this date (in YYDDD format, or 00000)

.

do_not_schedule_before_time (type: str)

Specifies not to schedule this job before this time (in HHMM format)

.

do_not_schedule_after_date (type: str)

Specifies not to schedule this job after this date (in YYDDD format, or 99999)

.

do_not_schedule_after_time (type: str)

Specifies not to schedule this job after this time (in HHMM format)

.

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: Update a CPU type job, TESTJOB1 to be executable
  broadcom.ca7.update_job_definition_job:
    job: TESTJOB1
    job_type: CPU
    execute: Y

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.