addBackupImmediate

The addBackupImmediate operation handles configuration related to BackupImmediate model. 

Data Parameters

Parameter Required Type Description
scheduleType False string A mandatory enum value that specifies the type of job schedule. Only allowed value is:

IMMEDIATE - the job will be posted when the request is received.

Note that the job will be posted in the queue when it is received, 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 the job will not be recovered.
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)
ipAddress False string IP address of actor who initiated a job execution
Field level constraints: 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.
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addBackupImmediate' operation
  ftd_configuration:
    operation: "addBackupImmediate"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        name: "{{ name }}"
        description: "{{ description }}"
        backupLocation: "{{ backup_location }}"
        encryptionKey: "{{ encryption_key }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"