addCloudEnrollmentImmediate

The addCloudEnrollmentImmediate operation handles configuration related to CloudEnrollmentImmediate model.

Description

Enrolls the device in the cloud. It is not allowed to enroll if the device is already enrolled.

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)
region	False	string	The cloud region name, which is used for Cloud Services connection. Must not be null, except when enrolling via Cloud Auto Enrollment. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
token	False	string	A Cloud Enrollment token, which is specified if the account type is SECURITY_ACCOUNT. Must be null if enrolling via Smart License or Cloud Auto Enrollment Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
accountType	True	string	The type of the account, which is used for the enrollment (SMART_VIRTUAL_ACCOUNT, SECURITY_ACCOUNT, CLOUD_AUTO_ENROLLMENT). Must not be null. Field level constraints: cannot be null. (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 'addCloudEnrollmentImmediate' operation
  ftd_configuration:
    operation: "addCloudEnrollmentImmediate"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        region: "{{ region }}"
        token: "{{ token }}"
        accountType: "{{ account_type }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"