addFMCRegistrationImmediate

The addFMCRegistrationImmediate operation handles configuration related to FMCRegistrationImmediate model.

Description

This API call is not allowed on the standby unit in an HA pair.

A valid FMCRegistrationSettings object is required prior to this API call. This task adds an FMC manager and opens the sftunnel based on the settings provided in the FMCRegistrationSettings object. Subsequently, it continuously listens to an FMC-triggered connection. As long as there is no FM connection, the task will remain in progress. To cancel the task, DELETE /device/default/fmcregistrationsettings/{objId} may be used. Upon a successful FMC connection, the task is marked as completed. FDM proceeds to shut down and the device is no longer locally managed. The connected FMC takes over the device and enters into the FMC-managed mode. Device's LINA configuration will be preserved upon the onboarding.

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)
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 'addFMCRegistrationImmediate' operation
  ftd_configuration:
    operation: "addFMCRegistrationImmediate"
    data:
        scheduleType: "{{ schedule_type }}"
        user: "{{ user }}"
        forceOperation: "{{ force_operation }}"
        jobHistoryUuid: "{{ job_history_uuid }}"
        ipAddress: "{{ ip_address }}"
        jobName: "{{ job_name }}"
        type: "{{ type }}"