addCloudManagement

The addCloudManagement operation handles configuration related to CloudManagement 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)
authToken	False	string	A string to specify the token to be used to token enroll for Cisco Defense Orchestrator Field level constraints: length must be between 0 and 32 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
action	False	string	An enum to specify if the user wants to token enroll for Cisco Defense Orchestrator or auto enroll for Cisco Success Network Cisco Success Network enablement provides usage information and statistics to Cisco which are essential for Cisco to provide technical support. This information also allows Cisco to improve the product and to make you aware of unused available features so that you can maximize the value of the product in your network. Check out the Sample Data that will be sent to Cisco.
cloudRegion	False	string	Specifies the region to enroll in cloud services Field level constraints: length must be between 0 and 32 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
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 'addCloudManagement' operation
  ftd_configuration:
    operation: "addCloudManagement"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        authToken: "{{ auth_token }}"
        action: "{{ action }}"
        cloudRegion: "{{ cloud_region }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"