Try SpotterModify schedules for jobs that are run on a date and 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.7Modify schedule parameters.
- name: Modify a schedule for job TESTJOB1 with the parameters
broadcom.ca7.update_job_definition_schedule:
job: TESTJOB1
schid: 01
default_scal: 03
job:
description:
- The name of the job
- ''
- .
required: true
type: str
days:
description:
- Defines specific days of the week on which to run the job.
- as comma separated list of day name abbreviations.
- 'Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat'
- ''
- .
required: false
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
roll:
description:
- Specifies the action to take when a schedule day falls on a base calendar non available
processing day.
- This value is not used if the DAILY option is used
- If DAILY is used, the ROLL has no effect.
- 'If used, the value must be one of the following values:'
- 'B: Roll the schedule back to the previous available processing day in the Base
Calendar.'
- 'F: Roll forward the schedule to the next available processing day.'
- 'N: Do not roll. Schedule day must stand.'
- 'D: Do not roll and do not schedule.'
- Default:D
- ''
- .
required: false
type: str
scal:
description:
- Specifies the override of the default SCAL for this SCHID. Specify scal if you want
to override the default scal.
- 'Limits: 2 alphanumeric characters'
- ''
- .
required: false
type: str
span:
description:
- Used with SYMETRIC and START, defines symmetric schedules.
- This field is required if the SYMETRIC option is taken.
- When used, specifies the number of days between scheduled processing cycles.
- If the calendar against which the SCHID will be resolved was generated with processing
days
- only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available
processing days
- between and including the next processing date as opposed to the actual number of
days.
- With this type of calendar, the ROLL and INDEX options serve no practical purpose.
- For other calendar types, the SPAN value is specified as the number of calendar
days
- between processing cycles and the ROLL and INDEX options can be used as necessary.
- 'Limits: 1 to 3 numeric characters from 1 to 255'
- ''
- .
required: false
type: str
type:
description:
- Determines how the submit time requirement is calculated for repeating jobs.
- A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
- submit time requirement to determine the new submit time requirement.
- A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
- last (most recent) start and end times,respectively, to determine the new submit
time requirement.
- TYPE is required if INTERVAL is specified.
- TYPE is discarded if INTERVAL is not specifiedLimits: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
count:
description:
- Specifies the maximum number of times to repeat the job.
- COUNT is discarded if INTERVAL is not specified.
- If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches
zero or the STOP time is reached, whichever comes first.
- If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is
required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1
to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
- ''
- .
required: false
type: str
daily:
description:
- Specifies that the user wants to define a daily schedule.
- Daily means every available processing day as defined by the Base Calendar.
- If DAILY is used, the ROLL has no effect.
- 'Limits: One of Y or N'
- ''
- .
required: false
type: str
index:
description:
- Specifies an adjustment to schedule days.
- After you exercise the ROLL option, the schedule is adjusted,
- forward for plus or backward for minus, by the number of working days entered.
- 'Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned)
or minus (-) and nnn can be 0 to 365 daysUsage:'
- 'Use this field with the RDAY field to schedule a job to run three workdays before
the 15th of the month:'
- specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
- ''
- .
required: false
type: str
schid:
description:
- Specifies the numeric schedule ID on which the user wants to perform the specified
action.
- 'Limits: 1 to 3 numeric characters from 1 through 999'
- ''
- .
required: true
type: str
start:
description:
- This field is required when the SYMETRIC option is taken.
- Value must be specified as the Julian day of the year on which the symmetric schedule
is to begin.
- This value should be evaluated yearly before schedule resolution and may need to
be changed each year.
- If the schedule will be resolved on a July-June basis, the start date must be within
- the first of the two years in which the schedule overlaps.
- For January-December schedules, it is simply relative to January 1 of the year specified
on a RESOLV command.
- If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
- the START day is adjusted each year to maintain the job's symmetric schedule from
the job's original specified START day.
- If the calendar against which the SCHID will be resolved was generated with overall
available processing days only (OPTIONS=SCHDYONLY)
- the start date must specify the first day on which the job would actually run.
- This requires manually setting (verifying) the START value each year before the
RESOLV.
- If a nonprocessing day is specified, the start day is the next processing day found
in the calendar.
- For example, if January 1 is a nonprocessing day and the calendar was generated
with OPTIONS=SCHDYONLY,
- and 1 is specified as the START day, January 2 is the actual START day (provided
it is an available processing day).
- SPAN is based from January 2 in this example rather than January 1.
- For other types of calendars, the start date is determined at RESOLV time based
on the ROLL and INDEX options taken.
- 'Limits: 3 numeric characters specified as Julian day of the year from 1 to 365'
- ''
- .
required: false
type: str
annual:
description:
- Defines an annual schedule.
- 'Limits: If annual is used, day is required. One of Y, N'
- ''
- .
required: false
type: str
months:
description:
- Defines specific months on which to run the job.
- as comma separated list of month name abbreviations.
- 'Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec'
- ''
- .
required: false
type: str
weekly:
description:
- Specifies that the user wants to define a weekly schedule.
- If WEEKLY is used, the run days of the week must be specified using DAYS field
- Limits:Y or N
- ''
- .
required: false
type: str
monthly:
description:
- Specifies that the user wants to define a monthly schedule.
- If this field is used, the user can optionally specify on which particular months
the job is to run.
- 'If specific months are not specified in the months property, all months are assumed.Limits:
Y or N'
- ''
- .
required: false
type: str
interval:
description:
- Specifies that the job should be repeated (executed more than once) and
- specifies the amount of time between each iteration.
- If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are
required.
- If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value
must total less than 24 hours.
- Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can
be from 00 to 59
- ''
- .
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
lead_time:
description:
- Specifies the due-out time of day for this schedule ID.
- 'Limits: 4 numeric characters that are specified as hhmm'
- where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than
0000.
- ''
- .
required: false
type: str
symmetric:
description:
- Used with the START and SPAN fields, defines a symmetric schedule.
- With this option, schedules are defined as beginning on the date specified with
- the START field and recurring every nnn days as specified with the SPAN field.
- 'Limits: One of Y, N'
- ''
- .
required: false
type: str
day_of_week:
description:
- Specifies which days of the week to run the job.
- If used, each day must be the first three letters of the wanted run days.
- If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
- 'Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive'
- ''
- .
required: false
type: str
day_of_year:
description:
- Specifies on which days of the annual schedule the user wants to run the job.
- Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash
(/) values.
- Slash indicates the job will not run this day.
- 'For example, if a job is to run on days 121, 132, 240, and 241, but is not to run
on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242'
- 'Limits: 1 to 55 numeric characters and required if annual is used.'
- The numbers will be separated by comma
- ''
- .
required: false
type: str
submit_time:
description:
- Specifies the submit time of day for this schedule ID.
- If specified, the job is not submitted before this time.
- If the submit time is before deadline start time,
- the submit time requirement is automatically satisfied when the job enters the queue.
- A submit time of zeros is the same as not specifying it, and no submit time is set
up.
- Note:If the submit time is after the due-out time, the submit day value is set to
the previous day.
- 'Limits: 4 numeric characters that are specified as hhmm'
- where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than
0000.
- ''
- .
required: false
type: str
default_scal:
description:
- Specifies the default SCAL for this job. If this is not specified, an LJOB will
be issued to fetch the SCAL
- 'Limits: 2 alphanumeric characters'
- ''
- .
required: false
type: str
due_out_time:
description:
- Specifies the due-out time of day for this schedule ID.
- 'Limits: 4 numeric characters that are specified as hhmm'
- where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than
0000.
- ''
- .
required: false
type: str
relative_day:
description:
- Specifies relative days of the month on which the job is to run. Used with MONTHLY.
- A day relative to the beginning or end of the month is specified.
- If a positive (unsigned) value is used, the job runs that day relative to the first
of the month.
- Also, if you have days of the month when this job is not to run,a slash (/) can
be used with the unsigned or negative values.
- Valid positive values range from 1 to 31.
- Valid negative values range from -0 to -30.
- Limits:1 to 60 numeric characters, separated by comma.
- Note:relative-day(s) represents calendar days, unless the base calendar was generated
with OPTIONS=SCHDYONLY,
- in which case relative-day(s) represents processing days.
- ''
- .
required: false
type: str
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
weeks_of_month:
description:
- Specifies the weeks of the month to run the job.
- The values that are specified can be positive (unsigned), negative (-) or slash
(/).
- Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning
of the month.
- Negative values -0, -1, and -2 are used to indicate occurrence of week relative
to the end of the month.
- Slashes indicate the job will not run the following value.
- 'Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are
used.'
- The values are separated by comma
- ''
- .
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