addScheduleConfigImport

The addScheduleConfigImport operation handles configuration related to ScheduleConfigImport 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	IMMEDIATE
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)
diskFileName	False	string	The name of the input file uploaded in the system. This could also be a previously exported output ZIP file Field level constraints: must match pattern ^(sse:)?[a-zA-Z0-9_][a-zA-Z0-9_.+-]*. (Note: Additional constraints might exist)
encryptionKey	False	string	If the input ZIP file is encrypted, this is the password to descrypt each compressed file in the input ZIP. Note this value is ignored unless the ZIP file is encrypted
preserveConfigFile	False	boolean	Whether to delete the input file after import is completed successfully. The input file will be preserved if this field is true or if the import job has failed. Default value is false
autoDeploy	False	boolean	Whether to start an FDM deployment job after the import is completed successfully. Default value is false
allowPendingChange	False	boolean	Whether to allow existing pending changes in database, before this import job starts. Default value is false
inputEntities	False	[object]	List of ConfigEntity or ManagementEntity wrapper objects to be used as input for delta import. This field is ignored unless diskFileName is null or empty. Please use this field for small object set only as larger set may cause scalability issue in the system
excludeEntities	False	[string]	(Optional.) A list of object matching strings that identify objects that should not be imported. You need to specify this attribute only if the import file includes items that you do not want to import. Each item in this list has a pattern like 'type=<object-type>', 'id=<uuid-value>' or 'name=<object-name>'. Input objects that match one of these patterns will be excluded from import. For example, to exclude all network objects, two other objects identified by name 'myobj' and a UUID from being imported, specify: "excludeEntities": ["type=networkobject", "name=myobj", "id=acc2e3cd-8c70-11e9-930a-1f12ee87b286"]. Each 'type' could be either a REST-API leaf entity's type value, or an alias of a set of leaf types. Some typical type aliases are: network (NetworkObject and NetworkObjectGroup), port (All TCP/UDP/Icmp port, protocol and group types), url (URLObject and Group types), ikepolicy (IKE V1/V2 policy), ikeproposal (Ike V1/V2 proposal), identitysource (All identity-source types), certificate (All certificate types), object (All Object/Group types like network, port, etc), interface (All Network-Interface types like PhysicalInterface, BridgeGroupInterface, etc), s2svpn (All site-to-site VPN related types), ravpn (All RA-VPN related types), vpn (Both s2svpn and ravpn)
jobName	False	string	Name of the job
type	True	string	scheduleconfigimport

Example

- name: Execute 'addScheduleConfigImport' operation
  ftd_configuration:
    operation: "addScheduleConfigImport"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        diskFileName: "{{ disk_file_name }}"
        encryptionKey: "{{ encryption_key }}"
        preserveConfigFile: "{{ preserve_config_file }}"
        autoDeploy: "{{ auto_deploy }}"
        allowPendingChange: "{{ allow_pending_change }}"
        inputEntities: "{{ input_entities }}"
        excludeEntities: "{{ exclude_entities }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"