FMCRegistrationSettings

Description

A singleton object that represents an FMC manager configuration. This object is required before calling POST /action/registerfmc. 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
(Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)

Model Properties

Property	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
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.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.