Try SpotterCreates or modifies processing schedules for jobs that are to be scheduled on a date/time basis
| "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.7Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.
- name: Creates or modifies processing schedules for jobs, AJOB from CA 7
broadcom.ca7.commands_resolv:
job: AJOB
job:
description:
- 'Example: AJOB*'
- ''
- Limits selection for resolution to the jobs specified. If omitted, all job schedules
are candidates for resolution. Value can be a specific job name or a generic name
that identifies multiple jobs beginning with the specified characters.
- An asterisk (*) must be used to delimit the generic job name. The asterisk can appear
in any of the eight positions but must immediately follow the last significant character
of the job name requested.
- 'For example: '
- AB* causes all jobs beginning with AB to be selected for resolution.
- '* causes all job schedules to be selected for resolution.'
- .
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
scal:
description:
- 'Example: 22'
- ''
- Value is the xx portion of the base calendar name, SCALyyxx.
- The SCAL value must also match the base calendar identifier (SCAL) specified in
any SCHID of the schedule definition for the individual jobs.
- This value is used during the selection process of resolution to determine which
schedule members to resolve.
- 'Required: No (unless JOB is omitted)'
- '*: Indicates all SCALs.'
- 'xx: Indicates a specific SCAL.'
- .
required: false
type: str
test:
description:
- 'Example: NO'
- ''
- Indicates whether schedule members are updated because of the resolution process.
YES and NO are the only allowable values.
- 'YES: Normal resolution occurs and all messages are printed, but no updating of
the database occurs.This option can be used at a year-end or whenever a base calendar
is changed to see the results of the resolution activity, without actually changing
the schedule mask or affecting the current schedule process. YES is the default.'
- 'NO: Normal resolution occurs and all messages are printed, and updating of the
database occurs.'
- .
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
year:
description:
- 'Example: 20'
- ''
- Identifies the year of the base calendars against which the schedule is resolved.
The value is the number that is the yy portion of the base calendar name, SCALyyxx.
- When a schedule is successfully updated, the YEAR value becomes part of the schedule
data (see OLDYR). If the YEAR parameter is not specified, the current year is assumed
to be the year from the system internal date and time.
- Also, if YEAR is not coded on the RESOLV, a determination is made to see whether
the RESOLV is made within the period January 1 through June 30 as determined from
system date and time.
- If so, the schedule is resolved against January through December of the current
year. If a RESOLV is done within the period July 1 through December 31, the schedule
is resolved against July 1 through December 31 of the current year and January 1
through June 30 of the next year.
- This behavior requires the existence of base calendars for calendar years involved.
If a required base calendar is not available, an error message is issued. The schedule
member is unresolved, unless a perpetual calendar is defined for this SCALyyXX.
In that case, the calendar is generated from the PCALYYXX member in the perpetual
calendar data set. YEAR is optional. If YEAR is specified, the resolution is made
against January through December of the year specified.
- 'Default: Current year'
- 'Limits: 2 numeric characters'
- ''
- .
required: false
type: str
print:
description:
- 'Example: YES'
- ''
- Specifies whether to display a month-by-month schedule day calendar after resolution
of the defined member is complete.
- If used, value must be YES or NO (default).
- .
required: false
type: str
old_year:
description:
- 'Example: 22'
- ''
- Specifies the year that is defined in the schedule member data (the value that is
supplied by YEAR in the previous resolution that updated the schedule member).
- Only those candidate schedule members whose year data matches the OLDYR value are
selected for resolution.
- 'If used, use one of the following values:'
- 'empty: It is default, if omitted, only those schedule members that have not previously
been resolved or whose schedules have expired are selected.'
- 'yy: Indicates a specific year.'
- '*: Indicates all years and all schedules.'
- .
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
duplicate_date:
description:
- 'Example: NO'
- ''
- Indicates whether to produce specific duplicate day messages (SRC1-137) each time
that two or more schedule IDs for the same job schedule a given day.
- The default is NO unless the extended resolve message option is set in the user
profile by the /PROF command.
- ''
- .
required: false
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