Try SpotterModify Exclusive resource for a job definition
| "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.7ExclusiveResource.
- name: Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011
broadcom.ca7.job_definition_update_exclusive_resource:
job: JOBA
schid: 42
resource_name: RESOURCE.NAME
step_name: JS011
free: F
job:
description:
- Specifies the job name on which the indicated function is performed.
- 'Limits: 1 to 8 alphanumeric characters.'
required: true
type: str
free:
description:
- Determines how VRM manages resource availability at job submission and job/step
completion.
- 'Valid values are:'
- A = Specifies the resource is only freed if any step in the job abends (abend or
condition code checking)F = Specifies the resource is freed when job ends, either
successfully or unsuccessfully. If the step-name parameter is specified, free the
resource when the specified step completes, either successfully or unsuccessfullyN
= Specifies do not free the resource at successful job completion. The resource
can be freed with the PRSCF command. A cancel of the job also frees the resourceY
= Specifies to free the resource at successful job completion. If the step-name
parameter is specified, free the resource when the specified step completes successfully
(does not abend).
required: true
type: str
host:
description:
- Host name of the CA7 API service that is running on the mainframe system.
required: true
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
schid:
description:
- (Optional) Specifies the schedule ID (of this job) for which a user requirement
is applied. A zero default cannot be specified for one connection and a nonzero
schedule ID used for a subsequent connection to the same job with the same user
requirement description. An attempt to make such a connection results in an error
message.
- 'Default: 0, which indicates that the requirement holds for all schedule IDs'
- 'Limits: 1 to 3 numeric characters from 0 through 999.'
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
step_name:
description:
- (Optional) Specifies the resource is freed at the conclusion of the named job step.
- 'Limits: 1 to 8 alphanumeric characters'
- Notes:The step-name parameter applies to the first occurrence of the stepname that
is encountered in the job stream. This includes any reference to the stepname embedded
in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames
executing a PROCIf a job is restarted in a step after this step-name, the resource
does not go through free processing until the job completesA step flush condition
does not post the step-name process.
required: false
type: str
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
resource_name:
description:
- Specifies the resource name being connected to the job.
- 'Limits: 1 to 44 characters, the first character must be non-blank, and no embedded
blanks.'
required: true
type: str
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