addScheduleExportConfig

The addScheduleExportConfig operation handles configuration related to ScheduleExportConfig model.

Description

The method that starts the config file export.

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	A string that is the name of the user who started the Export Config file process. 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)
masked	False	boolean	(Optional.) A Boolean value, TRUE or FALSE, that specifies whether the secure information in the objects should be not masked and provided in plain text. The default is FALSE, which means that all secure information will be masked in the exported configuration.
jobName	False	string	The Export Config job name
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addScheduleExportConfig' operation
  ftd_configuration:
    operation: "addScheduleExportConfig"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        masked: "{{ masked }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"