Device

Location in GUI: Devices » Device Management » Device

Diagram

Classes

devices (fmc.domains)

Name	Type	Constraint	Mandatory	Default Value
devices	List	[devices]	No

devices (fmc.domains.devices)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.+ -]{1,64}$	Yes
host	IP		No
registration_key	String		No
access_policy	String		No
nat_policy	String		No
licenses	List	Choice[BASE, THREAT, MALWARE, ESSENTIALS, IPS, SECURE_CLIENT_PREMIER, CARRIER, MALWARE_DEFENSE, SECURE_CLIENT_PREMIER_ADVANTAGE, URL, SECURE_CLIENT_VPNOnly]	No
nat_id	String		No
performance_tier	Choice	FTDv5, FTDv10, FTDv20	No
prohibit_packet_transfer	Boolean	true, false	No
physical_interfaces	List	[physical_interfaces]	No
ipv4_static_routes	List	[ipv4_static_routes]	No
deploy	Boolean	true, false	No
deploy_ignore_warning	Boolean	true, false	No	false
deploy_force	Boolean	true, false	No	false
vnis	List	[vnis]	No

physical_interfaces (fmc.domains.devices.devices)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.+-]{1,64}$	Yes
interface	Choice	GigabitEthernet0/0, GigabitEthernet0/1, GigabitEthernet0/2, GigabitEthernet0/3, GigabitEthernet0/4, GigabitEthernet0/5, GigabitEthernet0/6, GigabitEthernet0/7, TenGigabitEthernet0/0, TenGigabitEthernet0/1	Yes
enabled	Boolean	true, false	No	true
description	String	max: 255	No
mode	Choice	NONE, PASSIVE, ERSPAN	No	NONE
security_zone	String		No
mtu	Integer	min: 64, max: 9000	No
ipv4_static_address	IP		No
ipv4_static_netmask	Integer	min: 1, max: 31	No
ipv4_dhcp	Boolean	true, false	No
ipv4_dhcp_route_metric	Integer	min: 1, max: 255	No
ipv6	Boolean	true, false	No
ipv6_address	String		No
ipv6_prefix	Integer		No
ipv6_enforce_eui64	Boolean	true, false	No
subinterfaces	List	[subinterfaces]	No
vteps	List	[vteps]	No

ipv4_static_routes (fmc.domains.devices.devices)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.+-]{1,64}$	No
gateway	Class	[gateway]	Yes
interface	String		Yes
metric	Integer	min: 1, max: 254	Yes
selected_networks	List	String	Yes
tunneled	Boolean	true, false	No

vnis (fmc.domains.devices.devices)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.+-]{1,64}$	Yes
enabed	Boolean	true, false	No
vni_id	Integer	min: 1, max: 10000	Yes
description	String	max: 255	No	VNI Interface
security_zone	String		No
priority	Integer	min: 0, max: 65535	No
vni_segment_id	Integer	min: 1, max: 16777215	No
multicast_group_address	IP		No
vne_to_vtep_mapping	Boolean	true, false	No
ipv4_static_address	IP		No
ipv4_static_netmask	Integer	min: 1, max: 31	No
ipv4_dhcp	Boolean	true, false	No
ipv4_dhcp_route_metric	Integer	min: 1, max: 255	No
ipv4_dhcp_default_route	Boolean	true, false	No

subinterfaces (fmc.domains.devices.devices.physical_interfaces)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.+-]{1,64}$	Yes
id	Integer	min: 1, max: 4294967295	Yes
vlan	Integer	min: 1, max: 4094	Yes
enabled	Boolean	true, false	No
ipv4_dhcp	Boolean	true, false	No
ipv4_dhcp_route_metric	Integer	min: 1, max: 255	No
ipv4_static_address	String		No
ipv4_static_netmask	Integer	min: 1, max: 31	No
ipv6	Boolean	true, false	No
ipv6_address	String		No
ipv6_enforce_eui	String		No
ipv6_prefix	String		No
management_only	String		No
mode	String		No
mtu	Integer	min: 64, max: 9000	No
priority	Integer	min: 0, max: 65535	No
security_zone	String		No

vteps (fmc.domains.devices.devices.physical_interfaces)

Name	Type	Constraint	Mandatory	Default Value
nve_enabled	Boolean	true, false	Yes
encapsulation_port	Integer	min: 1024, max: 65535	Yes
encapsulation_type	Choice	GENEVE, VXLAN	Yes

gateway (fmc.domains.devices.devices.ipv4_static_routes)

Name	Type	Constraint	Mandatory	Default Value
object	String		No
literal	IP		No

Examples

fmc:
  domains:
    - name: Global
      devices:
        devices:
          - name: MyDeviceName1
            host: 10.62.158.201
            registration_key: cisco123
            access_policy: MyAccessPolicyName1
            nat_policy: MyFTDNatPolicyName1
            deploy: true
            licenses:
            - ESSENTIALS
            - IPS
            performance_tier: FTDv5
            physical_interfaces:
              - name: outside
                interface: GigabitEthernet0/0
                security_zone: outside
                mode: NONE
                ipv4_static_address: 10.62.158.202
                ipv4_static_netmask: 24
                enabled: true
              - name: inside
                interface: GigabitEthernet0/1 
                security_zone: inside
                mode: NONE
                ipv4_static_address: 10.62.100.10
                ipv4_static_netmask: 24
                enabled: true
            ipv4_static_routes:
              - name: MyDefaultRoute1
                gateway: GW1
                interface: outside
                metric: 1
                selected_networks: 
                  - any-ipv4