editBackupScheduled

The editBackupScheduled operation handles configuration related to BackupScheduled model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
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. For the DAILY schedule type the following constraints apply: seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth: , month: , dayOfTheWeek: , year: . For the WEEKLY schedule type the following constraints apply: seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth: , month: , dayOfTheWeek: 1-7, year: . For the MONTHLY schedule type the following constraints apply: seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth: 1-31, month: , dayOfTheWeek: ?, year: . Examples: '0 0 12 * ? ' - schedule at 12:00 PM (noon) every day. '0 15 10 15 * ? ' - schedule at 10:15 AM on the 15th day of every month. '0 59 23 31 1 ? 2018' schedule at 11:59 PM on Jan/31 2018. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).) $. (Note: Additional constraints might exist)
name	False	string	An optional UTF8 string representing the backup name, from 0 to 32 characters. The string cannot include the dot (.) character or HTML tags. 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	An optional Unicode string, from 0 to 200 characters. The string cannot include HTML tags. Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
backupLocation	False	string	The location of the backup.
encryptionKey	False	string	An optional key for encrypting the backup file. If it is not specified, the backup file will not be encrypted. It is always recommended to specify an encryption key
jobName	False	string	See derived class.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editBackupScheduled' operation
  ftd_configuration:
    operation: "editBackupScheduled"
    data:
        version: "{{ version }}"
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        runTimes: "{{ run_times }}"
        name: "{{ name }}"
        description: "{{ description }}"
        backupLocation: "{{ backup_location }}"
        encryptionKey: "{{ encryption_key }}"
        jobName: "{{ job_name }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"