addRestoreImmediate

The addRestoreImmediate operation handles configuration related to RestoreImmediate 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)
archiveName	True	string	The name of the backup to be restored. Field level constraints: cannot be null, length must be between 0 and 155 (inclusive), must match pattern [1-9][0-9]{13}.NGFW_backup.[a-zA-Z0-9_][a-zA-Z0-9_+-]*. (Note: Additional constraints might exist)
preserveArchive	False	boolean	A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the backup will be preserved after the restore completes.
encryptionKey	False	string	The key used to encrypt the backup archive file. Not required if backup file is not encrypted
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 'addRestoreImmediate' operation
  ftd_configuration:
    operation: "addRestoreImmediate"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        archiveName: "{{ archive_name }}"
        preserveArchive: "{{ preserve_archive }}"
        encryptionKey: "{{ encryption_key }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"