addVDBUpdateSchedule
The addVDBUpdateSchedule operation handles configuration related to VDBUpdateSchedule model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
scheduleType | False | string | A mandatory enum value that specifies the type of job schedule. Only allowed values are: SINGLE - the job will be posted at the given date and time; DAILY - the job will be posted daily at the given time; WEEKLY - the job will be posted weekly at the given day of the week and given time; MONTHLY - the job will be posted monthly at the given day of the month and given time. Note that the job will be posted -according to the system rules- if the day of the month exceeds the number of days in the current month. Note that the job will be posted in the queue at the given time (or immediately), but the actual execution can be delayed if other jobs were scheduled for execution at the same time or are being currently processed. After a system restart, scheduled job will be reposted. if the system is restarted before a scheduled job is executed, the job will not be recovered if the given date/time is in the past. |
|||
user | False | string | System provided ID of the user who scheduled the job. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
forceOperation | False | boolean | For Internal use. | |||
jobHistoryUuid | False | string | The ID of the job status object created by this schedule object. Use this ID in the corresponding job API to check the job status. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
runTimes | False | string | A mandatory UTF8 string containing a cron specification (following the Java(tm)/Spring(tm) conventions). The string must contain six space-separated fields representing the seconds, minutes, hours, dayOfTheMonth, month, dayOfTheWeek, year (time is in UTC). Depending on the scheduleType some values are not allowed. For the SINGLE schedule type the following constraints apply:seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth:1-31, month: 1-12, dayOfTheWeek: ?, year: 2017-2099. If the date/time is in the past (with respect to the time when the request is processed), the job is not scheduled. Examples: '0 15 10 15 * ? ' - schedule at 10:15 AM on the 15th day of every month. |
|||
name | False | string | The name of this VDB update. Field level constraints: length must be between 0 and 128 (inclusive), must match pattern ^[a-zA-Z0-9][a-zA-Z0-9_+-]*$. (Note: Additional constraints might exist) |
|||
description | False | string | A string describing this object. Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist) |
|||
deployAfterUpdate | False | boolean | A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the VDB update will be deployed after it is completed. | |||
jobName | False | string | See derived class. | |||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
- name: Execute 'addVDBUpdateSchedule' operation
ftd_configuration:
operation: "addVDBUpdateSchedule"
data:
scheduleType: "{{ schedule_type }}"
user: "{{ user }}"
forceOperation: "{{ force_operation }}"
jobHistoryUuid: "{{ job_history_uuid }}"
runTimes: "{{ run_times }}"
name: "{{ name }}"
description: "{{ description }}"
deployAfterUpdate: "{{ deploy_after_update }}"
jobName: "{{ job_name }}"
type: "{{ type }}"