job_definition_delete_requirement_predecessor – Delete requirement definition for a job for CA 7 instance specified in path

Synopsis

Delete predecessor requirement for a job.

Parameters

ca7_id (required, type: str)

CA7ONL Instance.

job (required, type: str)

The name of the job that requires the predecessor.

schid (required, type: str)

The schedule id of requiring job.

predtype (required, type: str)

The predecessor type

[ JOB, DSN, USER ]

nextrun (required, type: str)

The status of predecessor for next run of job

[ YES, ONLY, SKIP ]

predobject (required, type: str)

The predecessor. Values vary with predtype.

When predtype:JOB, predobject is 1-8 character name of required job.

When predtype:DSN,predobject is 1-44 name of required dataset.

When predtype:USER then predobject is 1-44 character user requirement text.

leadtime (type: str)

The satisfaction lead time in hours.

This may be honored when predtype is job or DSN.

permanent (type: str)

Indicates that this predecessor is permanent, that is always considered satisfied.

This parameter only applies when predtype is DSN.

[ Y, N ]

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: Delete a job requirement predecessor of a CA 7 job using the options for INSTANCE1
  broadcom.ca7.job_definition_delete_requirement_predecessor:
    job: ZOWECRM1
    schid: 0004
    predtype: USER
    nextrun: ONLY
    predobject: USER101

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.