OSPF
FMCMinimum FMC version required: 7.6
Location in GUI:
Devices » Device Management » Device » Routing » OSPF
A VRF can run at most two OSPF processes. The process IDs 1 and 2 are reserved for the global VRF, the next two (3 and 4) are allocated to the first user-defined VRF, and so on.
Diagram
Section titled “Diagram”Classes
Section titled “Classes”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| domains | List | domains | No |
domains (fmc)
Section titled “domains (fmc)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| devices | Class | devices | No |
devices (fmc.domains)
Section titled “devices (fmc.domains)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| devices | List | devices | No |
devices (fmc.domains.devices)
Section titled “devices (fmc.domains.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| vrfs | List | vrfs | No |
vrfs (fmc.domains.devices.devices)
Section titled “vrfs (fmc.domains.devices.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| vrfs | List | vrfs | No | |
| ospf_interfaces | List | ospf_interfaces | No |
ospf (fmc.domains.devices.devices.vrfs)
Section titled “ospf (fmc.domains.devices.devices.vrfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[a-zA-Z0-9_.+ -]{1,64}$ | Yes | |
| description | String | max: 255 | No | |
| bgp | Class | bgp | No | |
| eigrp | Class | eigrp | No | |
| ospfs | List | ospfs | No | |
| ospf_interfaces | List | ospf_interfaces | No | |
| physical_ | List | physical_ | No | |
| etherchannel_ | List | etherchannel_ | No | |
| sub_interfaces | List | sub_interfaces | No | |
| loopback_ | List | loopback_ | No | |
| virtual_ | List | virtual_ | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv6_ | List | ipv6_ | No | |
| bfds | List | bfds | No |
ospf_interfaces (fmc.domains.devices.devices.vrfs)
Section titled “ospf_interfaces (fmc.domains.devices.devices.vrfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Yes | ||
| default_cost | Integer | min: 1, max: 65535 | No | 10 |
| priority | Integer | min: 0, max: 255 | No | 1 |
| mtu_ | Boolean | true, false | No | |
| hello_interval | Integer | min: 1, max: 8192 | No | 10 |
| hello_ | Integer | min: 3, max: 20 | No | |
| transmit_delay | Integer | min: 1, max: 65535 | No | 1 |
| retransmit_ | Integer | min: 1, max: 65535 | No | 5 |
| dead_interval | Integer | min: 1, max: 65535 | No | 40 |
| point_to_point | Boolean | true, false | No | |
| bfd | Boolean | true, false | No | |
| authentication_ | String | max: 8 | No | |
| authentication_ | List | authentication_ | No | |
| authentication_ | String | max: 8 | No | |
| authentication_ | List | authentication_ | No | |
| authentication_ | String | No |
bgp (fmc.domains.devices.devices.vrfs.ospf)
Section titled “bgp (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ipv4_ | List | ipv4_ | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_filterings | List | ipv4_filterings | No | |
| ipv4_ | Integer | min: 1, max: 8 | No | |
| ipv4_ | Integer | min: 1, max: 8 | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | String | No | ||
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_neighbors | List | ipv4_neighbors | No | |
| ipv4_networks | List | ipv4_networks | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv4_ | Boolean | true, false | No |
eigrp (fmc.domains.devices.devices.vrfs.ospf)
Section titled “eigrp (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| as_number | Integer | min: 1, max: 65535 | Yes | |
| networks | List | String | Yes | |
| auto_summary | Boolean | true, false | No | |
| passive_ | Boolean | true, false | No | |
| passive_ | List | String | No | |
| router_id | IP | No | ||
| default_ | String | No | ||
| default_ | String | No | ||
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | Integer | min: 1, max: 255 | No | |
| log_ | Boolean | true, false | No | |
| log_ | Boolean | true, false | No | |
| log_ | Integer | min: 1, max: 65535 | No | |
| stub_ | Boolean | true, false | No | |
| stub_ | Boolean | true, false | No | |
| stub_ | Boolean | true, false | No | |
| stub_ | Boolean | true, false | No | |
| stub_ | Boolean | true, false | No | |
| default_ | Integer | min: 1, max: 4294967295 | No | |
| default_ | Integer | min: 0, max: 4294967295 | No | |
| default_ | Integer | min: 0, max: 255 | No | |
| default_ | Integer | min: 1, max: 255 | No | |
| default_ | Integer | min: 1, max: 65535 | No | |
| cluster_ | String | No | ||
| neighbors | List | neighbors | No | |
| filter_rules | List | filter_rules | No | |
| redistributions | List | redistributions | No | |
| summary_ | List | summary_ | No | |
| interfaces | List | interfaces | No |
ospfs (fmc.domains.devices.devices.vrfs.ospf)
Section titled “ospfs (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| process_id | Integer | min: 1, max: 65535 | Yes | |
| router_id | IP | No | ||
| rfc_ | Boolean | true, false | No | |
| log_ | Choice | DEFAULT, DETAILED | No | |
| ignore_ | Boolean | true, false | No | |
| administrative_ | Integer | min: 1, max: 254 | No | |
| administrative_ | Integer | min: 1, max: 254 | No | |
| administrative_ | Integer | min: 1, max: 254 | No | |
| timer_lsa_group | Integer | min: 10, max: 1800 | No | |
| default_ | Boolean | true, false | No | |
| default_ | Integer | min: 0, max: 16777214 | No | |
| default_ | Choice | TYPE_1, TYPE_2 | No | |
| default_ | String | No | ||
| non_ | Boolean | true, false | No | |
| non_ | Choice | CISCO, IETF, NONE | No | |
| non_ | Boolean | true, false | No | |
| non_ | Boolean | true, false | No | |
| non_ | Boolean | true, false | No | |
| non_ | Integer | min: 1, max: 1800 | No | |
| areas | List | areas | No | |
| redistributions | List | redistributions | No | |
| filter_rules | List | filter_rules | No | |
| summary_ | List | summary_ | No | |
| neighbors | List | neighbors | No |
physical_interfaces (fmc.domains.devices.devices.vrfs.ospf)
Section titled “physical_interfaces (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Yes | ||
| mode | Choice | INLINE, PASSIVE, TAP, ERSPAN, NONE, SWITCHPORT | No | |
| active_ | String | max: 17 | No | |
| allow_ | Boolean | true, false | No | |
| arp_ | List | arp_ | No | |
| auto_ | Boolean | true, false | No | |
| description | String | max: 255 | No | |
| duplex | Choice | AUTO, FULL, HALF | No | |
| anti_spoofing | Boolean | true, false | No | |
| sgt_propagate | Boolean | true, false | No | |
| enabled | Boolean | true, false | No | |
| fec_mode | Choice | AUTO, CL108RS, CL74FC, CL91RS, DISABLE | No | |
| flow_ | Boolean | true, false | No | |
| ip_ | Boolean | true, false | No | |
| ip_ | IP | No | ||
| ip_ | Choice | AUTO, PEER_IPV4, PEER_IPV6, AUTO4, AUTO6 | No | |
| ipv4_ | String | No | ||
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Choice | PAP, CHAP, MSCHAP | No | |
| ipv4_ | String | No | ||
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_pppoe_user | String | No | ||
| ipv4_ | String | No | ||
| ipv4_ | IP | No | ||
| ipv4_ | Integer | min: 1, max: 31 | No | |
| ipv6_addresses | List | ipv6_addresses | No | |
| ipv6_ | Integer | min: 0, max: 600 | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dhcp | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | String | No | ||
| ipv6 | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dad | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ra | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| ipv6_prefixes | List | ipv6_prefixes | No | |
| ipv6_ | Integer | min: 3, max: 1800 | No | |
| ipv6_ | Integer | min: 0, max: 9000 | No | |
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| lldp_receive | Boolean | true, false | No | |
| lldp_transmit | Boolean | true, false | No | |
| logical_name | String | Regex: ^[a-zA-Z0-9_ | No | |
| management_ | Boolean | true, false | No | |
| management_ | List | String | No | |
| management_only | Boolean | true, false | No | |
| mtu | Integer | min: 64, max: 9000 | No | |
| nve_only | Boolean | true, false | No | |
| override_ | Integer | min: 1, max: 8200 | No | |
| override_ | Integer | min: 1, max: 30000 | No | |
| override_ | Integer | min: 1, max: 30 | No | |
| priority | Integer | min: 0, max: 65535 | No | |
| security_zone | String | No | ||
| speed | Choice | AUTO, TEN, HUNDRED, THOUSAND, TEN_THOUSAND, TWENTY_, FORTY_THOUSAND, HUNDRED_, TWO_, DETECT_SFP | No | |
| standby_ | String | No | ||
| monitor_ | Boolean | true, false | No | |
| ipv4_ | IP | No | ||
| ha_ | String | No | ||
| ha_ | String | No |
etherchannel_interfaces (fmc.domains.devices.devices.vrfs.ospf)
Section titled “etherchannel_interfaces (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | max: 255 | Yes | |
| mode | Choice | INLINE, PASSIVE, TAP, ERSPAN, NONE, SWITCHPORT | No | |
| active_ | String | max: 17 | No | |
| allow_ | Boolean | true, false | No | |
| arp_ | List | arp_ | No | |
| auto_ | Boolean | true, false | No | |
| description | String | max: 255 | No | |
| duplex | Choice | AUTO, FULL, HALF | No | |
| anti_spoofing | Boolean | true, false | No | |
| sgt_propagate | Boolean | true, false | No | |
| enabled | Boolean | true, false | No | |
| fec_mode | Choice | AUTO, CL108RS, CL74FC, CL91RS, DISABLE | No | |
| flow_ | Boolean | true, false | No | |
| ip_ | Boolean | true, false | No | |
| ip_ | IP | No | ||
| ip_ | Choice | AUTO, PEER_IPV4, PEER_IPV6, AUTO4, AUTO6 | No | |
| ipv4_ | String | No | ||
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Choice | PAP, CHAP, MSCHAP | No | |
| ipv4_ | String | No | ||
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_pppoe_user | String | No | ||
| ipv4_ | String | No | ||
| ipv4_ | IP | No | ||
| ipv4_ | Integer | min: 1, max: 31 | No | |
| ipv6_addresses | List | ipv6_addresses | No | |
| ipv6_ | Integer | min: 0, max: 600 | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dhcp | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | String | No | ||
| ipv6 | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dad | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ra | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| ipv6_prefixes | List | ipv6_prefixes | No | |
| ipv6_ | Integer | min: 3, max: 1800 | No | |
| ipv6_ | Integer | min: 0, max: 9000 | No | |
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| lldp_receive | Boolean | true, false | No | |
| lldp_transmit | Boolean | true, false | No | |
| logical_name | String | Regex: ^[a-zA-Z0-9_ | No | |
| management_ | Boolean | true, false | No | |
| management_ | List | String | No | |
| management_only | Boolean | true, false | No | |
| mtu | Integer | min: 64, max: 9000 | No | |
| nve_only | Boolean | true, false | No | |
| override_ | Integer | min: 1, max: 8200 | No | |
| override_ | Integer | min: 1, max: 30000 | No | |
| override_ | Integer | min: 1, max: 30 | No | |
| priority | Integer | min: 0, max: 65535 | No | |
| security_zone | String | No | ||
| selected_ | List | String | No | |
| speed | Choice | AUTO, TEN, HUNDRED, THOUSAND, TEN_THOUSAND, TWENTY_, FORTY_THOUSAND, HUNDRED_, TWO_, DETECT_SFP | No | |
| standby_ | String | No | ||
| monitor_ | Boolean | true, false | No | |
| ipv4_ | IP | No | ||
| ha_ | String | No | ||
| ha_ | String | No |
sub_interfaces (fmc.domains.devices.devices.vrfs.ospf)
Section titled “sub_interfaces (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | max: 255 | Yes | |
| mode | Choice | INLINE, PASSIVE, TAP, ERSPAN, NONE, SWITCHPORT | No | |
| active_ | String | max: 17 | No | |
| allow_ | Boolean | true, false | No | |
| arp_ | List | arp_ | No | |
| description | String | max: 255 | No | |
| anti_spoofing | Boolean | true, false | No | |
| sgt_propagate | Boolean | true, false | No | |
| enabled | Boolean | true, false | No | |
| ip_ | Boolean | true, false | No | |
| ip_ | IP | No | ||
| ip_ | Choice | AUTO, PEER_IPV4, PEER_IPV6, AUTO4, AUTO6 | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Choice | PAP, CHAP, MSCHAP | No | |
| ipv4_ | String | No | ||
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_ | Boolean | true, false | No | |
| ipv4_pppoe_user | String | No | ||
| ipv4_ | String | No | ||
| ipv4_ | IP | No | ||
| ipv4_ | Integer | min: 1, max: 31 | No | |
| ipv6_addresses | List | ipv6_addresses | No | |
| ipv6_ | Integer | min: 0, max: 600 | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dhcp | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | String | No | ||
| ipv6 | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_dad | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ra | Boolean | true, false | No | |
| ipv6_ | Boolean | true, false | No | |
| ipv6_ | String | No | ||
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| ipv6_prefixes | List | ipv6_prefixes | No | |
| ipv6_ | Integer | min: 3, max: 1800 | No | |
| ipv6_ | Integer | min: 0, max: 9000 | No | |
| ipv6_ | Integer | min: 1000, max: 3600000 | No | |
| logical_name | String | Regex: ^[a-zA-Z0-9_ | No | |
| management_only | Boolean | true, false | No | |
| mtu | Integer | min: 64, max: 9000 | No | |
| override_ | Integer | min: 1, max: 8200 | No | |
| override_ | Integer | min: 1, max: 30000 | No | |
| override_ | Integer | min: 1, max: 30 | No | |
| priority | Integer | min: 0, max: 65535 | No | |
| security_zone | String | No | ||
| standby_ | String | No | ||
| vlan | Integer | min: 1, max: 4094 | Yes | |
| monitor_ | Boolean | true, false | No | |
| ipv4_ | IP | No | ||
| ha_ | String | No | ||
| ha_ | String | No |
loopback_interfaces (fmc.domains.devices.devices.vrfs.ospf)
Section titled “loopback_interfaces (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Integer | min: 1, max: 1024 | Yes | |
| description | String | max: 255 | No | |
| enabled | Boolean | true, false | No | |
| ipv4_ | IP | No | ||
| ipv4_ | Integer | min: 1, max: 31 | No | |
| ipv6_addresses | List | ipv6_addresses | No | |
| logical_name | String | Regex: ^[a-zA-Z0-9_ | No |
virtual_tunnel_interfaces (fmc.domains.devices.devices.vrfs.ospf)
Section titled “virtual_tunnel_interfaces (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| logical_name | String | Regex: ^[a-zA-Z0-9_ | Yes | |
| id | Integer | min: 1, max: 10413 | Yes | |
| tunnel_mode | Choice | ipv4, ipv6 | Yes | |
| tunnel_ | String | Yes | ||
| tunnel_type | Choice | STATIC, DYNAMIC | Yes | |
| borrow_ | String | No | ||
| description | String | max: 255 | No | |
| enabled | Boolean | true, false | No | |
| http_ | Boolean | true, false | No | |
| ip_ | String | No | ||
| ipv4_ | IP | No | ||
| ipv4_ | Integer | min: 1, max: 31 | No | |
| ipv6_address | String | No | ||
| ipv6_prefix | String | No | ||
| priority | Integer | min: 0, max: 65535 | No | |
| security_zone | String | No | ||
| tunnel_ | String | No |
ipv4_static_routes (fmc.domains.devices.devices.vrfs.ospf)
Section titled “ipv4_static_routes (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[a-zA-Z0-9_ | Yes | |
| gateway | Class | gateway | No | |
| interface_ | String | Yes | ||
| metric | Integer | min: 1, max: 254 | No | |
| selected_ | List | String | Yes | |
| is_tunneled | Boolean | true, false | No |
ipv6_static_routes (fmc.domains.devices.devices.vrfs.ospf)
Section titled “ipv6_static_routes (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[a-zA-Z0-9_ | Yes | |
| gateway | Class | gateway | Yes | |
| interface_ | String | Yes | ||
| metric | Integer | min: 1, max: 254 | No | |
| selected_ | List | String | Yes | |
| is_tunneled | Boolean | true, false | No |
bfds (fmc.domains.devices.devices.vrfs.ospf)
Section titled “bfds (fmc.domains.devices.devices.vrfs.ospf)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Regex: ^[a-zA-Z0-9_.+ -]{1,64}$ | No | |
| hop_type | Choice | SINGLE_HOP, MULTI_HOP | Yes | |
| slow_timer | Integer | min: 1000, max: 30000 | No | |
| bfd_template | String | Yes | ||
| source_ | String | No | ||
| destination_ | String | No |
authentication_md5s (fmc.domains.devices.devices.vrfs.ospf_interfaces)
Section titled “authentication_md5s (fmc.domains.devices.devices.vrfs.ospf_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Integer | Yes | ||
| key | String | Yes |
authentication_area_md5s (fmc.domains.devices.devices.vrfs.ospf_interfaces)
Section titled “authentication_area_md5s (fmc.domains.devices.devices.vrfs.ospf_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Integer | Yes | ||
| key | String | Yes |
ipv4_aggregate_addresses (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_aggregate_addresses (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| advertise_map | String | No | ||
| attribute_map | String | No | ||
| filter | Boolean | true, false | No | |
| generate_as | Boolean | true, false | No | |
| network | String | No | ||
| suppress_map | String | No |
ipv4_filterings (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_filterings (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_list | String | Yes | ||
| direction | Choice | incomingroutefilter, outgoingroutefilter | Yes | |
| process_id | String | No | ||
| protocol | Choice | CONNECTED, BGP, OSPF, RIP, STATIC | No |
ipv4_neighbors (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_neighbors (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enable_address | Boolean | true, false | No | |
| address | IP | No | ||
| authentication_ | String | No | ||
| bfd_fallover | Choice | SINGLE_HOP, MULTI_HOP, AUTO_DETECT_HOP, NONE | No | |
| customized_ | Boolean | true, false | No | |
| customized_ | String | No | ||
| customized_ | Boolean | true, false | No | |
| customized_ | Boolean | true, false | No | |
| description | String | No | ||
| disable_ | Boolean | true, false | No | |
| filter_ | List | filter_ | No | |
| filter_as_paths | List | filter_as_paths | No | |
| filter_ | Integer | min: 1, max: 2147483647 | No | |
| filter_ | List | filter_ | No | |
| filter_ | Integer | min: 1, max: 65535 | No | |
| filter_ | List | filter_ | No | |
| filter_ | Integer | min: 1, max: 100 | No | |
| filter_ | Boolean | true, false | No | |
| routes_ | String | No | ||
| hold_time | Integer | min: 3, max: 65535 | No | |
| keepalive_ | Integer | min: 0, max: 65535 | No | |
| max_hop_count | Integer | min: 1, max: 255 | No | |
| minimum_ | Integer | min: 3, max: 65535 | No | |
| next_hop_self | Boolean | true, false | No | |
| remote_as | String | No | ||
| routes_ | List | routes_ | No | |
| routes_ | Integer | min: 0, max: 600 | No | |
| routes_ | Boolean | true, false | No | |
| send_ | Boolean | true, false | No | |
| shutdown_ | Boolean | true, false | No | |
| tcp_ | Boolean | true, false | No | |
| tcp_ | Boolean | true, false | No | |
| version | Choice | 0, 4 | No | |
| weight | Integer | min: 0, max: 65535 | No | |
| update_ | String | No |
ipv4_networks (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_networks (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| network | String | No | ||
| route_map | String | No |
ipv4_redistributions (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_redistributions (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| match_external1 | Boolean | true, false | No | |
| match_external2 | Boolean | true, false | No | |
| match_internal | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| metric | Integer | min: 0, max: 4294967295 | No | |
| process_id | String | No | ||
| route_map | String | No | ||
| source_protocol | Choice | RedistributeConnected, RedistributeStatic, RedistributeOSPF, RedistributeEIGRP | Yes |
ipv4_route_injections (fmc.domains.devices.devices.vrfs.ospf.bgp)
Section titled “ipv4_route_injections (fmc.domains.devices.devices.vrfs.ospf.bgp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| exist_route_map | String | No | ||
| inject_ | String | No | ||
| inherit_ | Boolean | true, false | No |
neighbors (fmc.domains.devices.devices.vrfs.ospf.eigrp)
Section titled “neighbors (fmc.domains.devices.devices.vrfs.ospf.eigrp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Yes | ||
| neighbor_host | String | Yes |
filter_rules (fmc.domains.devices.devices.vrfs.ospf.eigrp)
Section titled “filter_rules (fmc.domains.devices.devices.vrfs.ospf.eigrp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| filter_ | Choice | INBOUND, OUTBOUND | Yes | |
| standard_ | String | Yes | ||
| interface_ | String | No | ||
| routing_process | Choice | CONNECTED, BGP, OSPF, RIP, STATIC | No | |
| routing_ | String | No |
redistributions (fmc.domains.devices.devices.vrfs.ospf.eigrp)
Section titled “redistributions (fmc.domains.devices.devices.vrfs.ospf.eigrp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| source_protocol | Choice | CONNECTED, BGP, OSPF, RIP, STATIC | Yes | |
| process_id | String | No | ||
| route_map | String | No | ||
| match_internal | Boolean | true, false | No | |
| match_external1 | Boolean | true, false | No | |
| match_external2 | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| metric_ | Integer | min: 1, max: 4294967295 | No | |
| metric_delay | Integer | min: 0, max: 4294967295 | No | |
| metric_ | Integer | min: 0, max: 255 | No | |
| metric_loading | Integer | min: 1, max: 255 | No | |
| metric_mtu | Integer | min: 1, max: 65535 | No |
summary_addresses (fmc.domains.devices.devices.vrfs.ospf.eigrp)
Section titled “summary_addresses (fmc.domains.devices.devices.vrfs.ospf.eigrp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Yes | ||
| network | String | Yes | ||
| administrative_ | Integer | min: 1, max: 255 | No |
interfaces (fmc.domains.devices.devices.vrfs.ospf.eigrp)
Section titled “interfaces (fmc.domains.devices.devices.vrfs.ospf.eigrp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Yes | ||
| hello_interval | Integer | min: 1, max: 65535 | No | |
| hold_time | Integer | min: 1, max: 65535 | No | |
| split_horizon | Boolean | true, false | No | |
| delay_time | Integer | min: 1, max: 16777215 | No | |
| md5_ | Boolean | true, false | No | |
| authentication_ | Choice | UNENCRYPTED, ENCRYPTED, AUTHKEY | No | |
| authentication_ | Integer | min: 0, max: 255 | No | |
| authentication_ | String | No |
areas (fmc.domains.devices.devices.vrfs.ospf.ospfs)
Section titled “areas (fmc.domains.devices.devices.vrfs.ospf.ospfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Any | IP or Integer | Yes | |
| type | Choice | normal, stub, nssa | Yes | |
| networks | List | String | Yes | |
| no_summary | Boolean | true, false | No | |
| no_ | Boolean | true, false | No | |
| default_ | Integer | min: 0, max: 16777214 | No | |
| default_ | Choice | TYPE_1, TYPE_2 | No | |
| authentication | Choice | PASSWORD, MESSAGE_DIGEST | No | |
| default_cost | Integer | min: 0, max: 65535 | No | |
| ranges | List | ranges | No | |
| virtual_links | List | virtual_links | No | |
| inter_ | List | inter_ | No |
redistributions (fmc.domains.devices.devices.vrfs.ospf.ospfs)
Section titled “redistributions (fmc.domains.devices.devices.vrfs.ospf.ospfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| source_protocol | Choice | RedistributeConnected, RedistributeStatic, RedistributeOSPF, RedistributeBGP, RedistributeRIP, RedistributeEIGRP | Yes | |
| as_number | Integer | No | ||
| process_id | Integer | min: 1, max: 65535 | No | |
| match_external1 | Boolean | true, false | No | |
| match_external2 | Boolean | true, false | No | |
| match_internal | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| match_ | Boolean | true, false | No | |
| subnets | Boolean | true, false | No | |
| metric | Integer | min: 0, max: 16777214 | No | |
| metric_type | Choice | TYPE_1, TYPE_2 | No | |
| tag | Integer | min: 0, max: 4294967295 | No | |
| route_map | String | No |
filter_rules (fmc.domains.devices.devices.vrfs.ospf.ospfs)
Section titled “filter_rules (fmc.domains.devices.devices.vrfs.ospf.ospfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_list | String | Yes | ||
| traffic_ | Choice | incomingroutefilter, outgoingroutefilter | Yes | |
| routing_process | Choice | CONNECTED, STATIC, RIP, OSPF, EIGRP, BGP, NONE | No | |
| routing_ | Integer | min: 1, max: 65535 | No | |
| interface_ | String | No |
summary_addresses (fmc.domains.devices.devices.vrfs.ospf.ospfs)
Section titled “summary_addresses (fmc.domains.devices.devices.vrfs.ospf.ospfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| networks | List | String | Yes | |
| tag | Integer | min: 0, max: 4294967295 | No | |
| advertise | Boolean | true, false | No |
neighbors (fmc.domains.devices.devices.vrfs.ospf.ospfs)
Section titled “neighbors (fmc.domains.devices.devices.vrfs.ospf.ospfs)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_ | String | Yes | ||
| neighbor_host | String | Yes |
arp_table_entries (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)
Section titled “arp_table_entries (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | Yes | |
| ip_address | IP | Yes | ||
| mac_address | String | max: 17 | Yes |
ipv6_addresses (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)
Section titled “ipv6_addresses (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | String | Yes | ||
| enforce_eui | Boolean | true, false | No | |
| prefix | String | Yes |
ipv6_prefixes (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)
Section titled “ipv6_prefixes (fmc.domains.devices.devices.vrfs.ospf.physical_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | String | Yes | ||
| default | Boolean | true, false | Yes |
ipv6_addresses (fmc.domains.devices.devices.vrfs.ospf.loopback_interfaces)
Section titled “ipv6_addresses (fmc.domains.devices.devices.vrfs.ospf.loopback_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | String | Yes | ||
| prefix | String | Yes |
gateway (fmc.domains.devices.devices.vrfs.ospf.ipv4_static_routes)
Section titled “gateway (fmc.domains.devices.devices.vrfs.ospf.ipv4_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| object | String | No | ||
| literal | IP | No |
gateway (fmc.domains.devices.devices.vrfs.ospf.ipv6_static_routes)
Section titled “gateway (fmc.domains.devices.devices.vrfs.ospf.ipv6_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| object | String | No | ||
| literal | String | No |
filter_access_lists (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)
Section titled “filter_access_lists (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_list | String | Yes | ||
| update_ | Choice | IN, OUT | Yes |
filter_as_paths (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)
Section titled “filter_as_paths (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| as_path | Integer | Yes | ||
| update_ | Choice | IN, OUT | Yes |
filter_prefix_lists (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)
Section titled “filter_prefix_lists (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| prefix_list | String | Yes | ||
| update_ | Choice | IN, OUT | Yes |
filter_route_maps (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)
Section titled “filter_route_maps (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| route_map | String | Yes | ||
| update_ | Choice | IN, OUT | Yes |
routes_advertise_maps (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)
Section titled “routes_advertise_maps (fmc.domains.devices.devices.vrfs.ospf.bgp.ipv4_neighbors)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| advertise_map | String | Yes | ||
| exist_ | String | Yes | ||
| use_exist_map | Boolean | true, false | Yes |
ranges (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)
Section titled “ranges (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| network | String | Yes | ||
| advertise | Boolean | true, false | No |
virtual_links (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)
Section titled “virtual_links (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| peer_ | String | Yes | ||
| hello_interval | Integer | min: 1, max: 8192 | No | |
| transmit_delay | Integer | min: 1, max: 8192 | No | |
| retransmit_ | Integer | min: 1, max: 8192 | No | |
| dead_interval | Integer | min: 1, max: 8192 | No | |
| authentication_ | String | max: 8 | No | |
| authentication_ | List | authentication_ | No | |
| authentication_ | String | max: 8 | No | |
| authentication_ | List | authentication_ | No | |
| authentication_ | String | No |
inter_area_filters (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)
Section titled “inter_area_filters (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| prefix_list | String | Yes | ||
| filter_ | Choice | IN, OUT | Yes |
authentication_md5s (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas.virtual_links)
Section titled “authentication_md5s (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas.virtual_links)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Integer | Yes | ||
| key | String | Yes |
authentication_area_md5s (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas.virtual_links)
Section titled “authentication_area_md5s (fmc.domains.devices.devices.vrfs.ospf.ospfs.areas.virtual_links)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| id | Integer | Yes | ||
| key | String | Yes |
Examples
Section titled “Examples”Prerequisites:
fmc: domains: - name: Global policies: access_control_policies: - name: MyAccessPolicyName2 default_action: BLOCK devices: devices: - name: MyDeviceName1 host: 10.1.120.203 access_control_policy: MyAccessPolicyName2 registration_key: cisco123 deploy: true licenses: - ESSENTIALS - IPS performance_tier: FTDv5 vrfs: - name: Global physical_interfaces: - name: GigabitEthernet0/0 logical_name: INSIDE ipv4_static_address: 10.20.30.1 ipv4_static_netmask: 24 security_zone: MySecurityZoneName1 objects: security_zones: - name: MySecurityZoneName1 networks: - name: MyNetworkName1 prefix: 10.10.10.0/24 - name: MyNetworkName2 description: My Network 2 Description prefix: 10.10.20.0/24 hosts: - name: MyHostName1 ip: 10.10.10.1 ipv4_prefix_lists: - name: MyIPv4PrefixListName1 entries: - action: PERMIT prefix: 10.20.30.0/24 min_prefix_length: 25 max_prefix_length: 30 - action: PERMIT prefix: 10.20.40.0/24 min_prefix_length: 25 max_prefix_length: 30 standard_access_lists: - name: MyStandardACLName1 entries: - action: DENY literals: - 10.1.13.130 - action: PERMIT objects: - MyHostName1 route_maps: - name: MyRouteMapName1 entries: - action: PERMITOSPF:
fmc: domains: - name: Global devices: devices: - name: MyDeviceName1 vrfs: - name: Global
ospf_interfaces: - interface_logical_name: INSIDE default_cost: 10 priority: 1 mtu_missmatch_ignore: false hello_interval: 10 transmit_delay: 1 retransmit_interval: 5 dead_interval: 40 point_to_point: false bfd: false authentication_md5s: - id: 1 key: cisco123
ospfs: - process_id: 1 router_id: 10.20.30.1 areas: - id: 0 type: normal authentication: MESSAGE_DIGEST default_cost: 1 networks: - MyNetworkName1 ranges: - network: MyNetworkName2 advertise: true inter_area_filters: - prefix_list: MyIPv4PrefixListName1 filter_direction: IN - id: 1 type: nssa no_summary: true no_redistribution: false default_route_metric: 1 default_route_metric_type: TYPE_2 networks: - MyNetworkName2 redistributions: - source_protocol: RedistributeStatic subnets: true metric: 10 metric_type: TYPE_2 tag: 100 route_map: MyRouteMapName1 filter_rules: - access_list: MyStandardACLName1 traffic_direction: outgoingroutefilter routing_process: CONNECTED summary_addresses: - networks: - MyNetworkName2 tag: 100 advertise: true