addFMCRegistrationSettings

The addFMCRegistrationSettings operation handles configuration related to FMCRegistrationSettings model.

Description

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

When an FMCRegistrationSettings object is present, FDM configuration access will be limited to read only, except the following APIs:
  - /devices/default/fmcregistrationsettings
  - /devices/default/fmcregistrationsettings/{objId}
  - /operational/deploy
  - /action/connecttest
  - /action/registerfmc

Data Parameters

Parameter	Required	Type	Description
name	False	string	A string that represents the name of the object
fmcConnectivityInterface	False	object	The device interface through which the FMC will manage the device. Allowed types are: [PhysicalInterface]
fmcHost	False	string	The FQDN or IP address of the FMC. Field level constraints: must be a valid host (FQDN or IP)
registrationKey	True	string	A one-time registration key of your choice that you will also specify on the FMC when you register the FTD. Field level constraints: length must be between 2 and 36 (inclusive), must match pattern ^[A-Za-z0-9-]+$ Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist)
natId	False	string	A unique, one-time string of your choice that you will also specify on the FMC when you register the FTD when one side does not specify a reachable IP address or hostname. This ID cannot be used for any other devices registering to the FMC. Field level constraints: length must be between 2 and 36 (inclusive), must match pattern ^[A-Za-z0-9]*$
useManagementInterface	False	boolean	A boolean value, TRUE or FALSE (the default). The value TRUE would allow the use of management Interface in NON_CONVERGED mode through which the FMC will manage the device. FALSE would allow the use of data Interfaces through which the FMC will manage the device.
preserveCloud	False	boolean	A boolean value, TRUE or FALSE (the default). The value TRUE indicates that device cloud enrollment will not be unregistered when the device moves to offbox mode. FALSE indicates that device cloud enrollment will be unregistered when the device moves to offbox mode.
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addFMCRegistrationSettings' operation
  ftd_configuration:
    operation: "addFMCRegistrationSettings"
    data:
        name: "{{ name }}"
        fmcConnectivityInterface: "{{ fmc_connectivity_interface }}"
        fmcHost: "{{ fmc_host }}"
        registrationKey: "{{ registration_key }}"
        natId: "{{ nat_id }}"
        useManagementInterface: "{{ use_management_interface }}"
        preserveCloud: "{{ preserve_cloud }}"
        type: "{{ type }}"