Subinterface

Subinterfaces divide a routed Ethernet or port-channel interface into multiple logical Layer 3 interfaces on NX-OS, each identified by a subinterface ID and mapped to a dot1q VLAN encapsulation. They are commonly used for VRF-lite hand-offs to external routers and firewalls, and support IPv4/IPv6 addressing, VRF membership, MTU, bandwidth and delay, access group filtering, uRPF, and DHCP relay. Subinterfaces are configured under interfaces.ethernets[].subinterfaces and interfaces.port_channels[].subinterfaces, and require the parent interface to be a routed interface (switchport.enabled: false).

Protocol Settings

Interface-level protocol settings are documented on the respective protocol pages: OSPF, OSPFv3, IS-IS, EIGRP, PIM, BFD, HSRP, VRRP, VRRPv3, ND, ePBR.

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No
templates	List	templates	No
interface_groups	List	interface_groups	No

devices (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

templates (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

interface_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
interfaces	Class	interfaces	No

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ethernets	List	ethernets	No
port_channels	List	port_channels	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No

port_channels (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No

configuration (nxos.interface_groups)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No

subinterfaces (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
id	Integer	min: `1`, max: `4093`	Yes
interface_groups	List	String	No
shutdown	Boolean	`true`, `false`	No
bandwidth	Integer	min: `0`, max: `3200000000`	No
delay	Integer	min: `1`, max: `16777215`	No
description	String		No
encapsulation	Integer	min: `1`, max: `4094`	No
logging_event_port_link_status	Boolean	`true`, `false`	No
medium	Choice	`broadcast`, `p2p`	No
mtu	Integer	min: `576`, max: `9216`	No
mac_address	MAC		No
mac_address_ipv6_extract	Boolean	`true`, `false`	No
snmp_trap_link_status	Boolean	`true`, `false`	No
vrf	String		No
ip	Class	ip	No
ipv6	Class	ipv6	No
igmp	Class	igmp	No

ip (nxos.devices.configuration.interfaces.ethernets.subinterfaces)

Name	Type	Constraint	Mandatory
address	IP		No
tag	Integer	min: `0`, max: `4294967295`	No
secondary_addresses	List	secondary_addresses	No
forward	Boolean	`true`, `false`	No
drop_glean	Boolean	`true`, `false`	No
unnumbered	String		No
directed_broadcast	Boolean	`true`, `false`	No
directed_broadcast_acl	String		No
redirects	Boolean	`true`, `false`	No
unreachables	Boolean	`true`, `false`	No
port_unreachable	Boolean	`true`, `false`	No
verify_unicast_source_reachable_via	Choice	`disabled`, `rx`, `any`, `any-allow-default`, `rx-allow-vni-hosts`	No
access_group_in	String		No
access_group_out	String		No
policy_route_map	String		No
dhcp_relay_information_trusted	Boolean	`true`, `false`	No
dhcp_relay_smart_relay	Boolean	`true`, `false`	No
dhcp_relay_subnet_broadcast	Boolean	`true`, `false`	No
dhcp_relay_information_option	Boolean	`true`, `false`	No
dhcp_relay_source_subnet	IP		No
dhcp_relay_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
dhcp_relay_source_interface_id	Any	String or Integer[min: `0`]	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
dhcp_snooping_trust	Boolean	`true`, `false`	No
arp_inspection_trust	Boolean	`true`, `false`	No
verify_source_dhcp_snooping_vlan	Boolean	`true`, `false`	No

ipv6 (nxos.devices.configuration.interfaces.ethernets.subinterfaces)

Name	Type	Constraint	Mandatory
address_autoconfig	Boolean	`true`, `false`	No
nd_default_route	Boolean	`true`, `false`	No
forward	Boolean	`true`, `false`	No
link_local_use_bia	Boolean	`true`, `false`	No
address_use_link_local_only	Boolean	`true`, `false`	No
verify_unicast_source_reachable_via	Choice	`disabled`, `rx`, `any`, `any-allow-default`, `rx-allow-vni-hosts`	No
address_link_local	IP		No
addresses	List	addresses	No
dhcp_smart_relay	Boolean	`true`, `false`	No
dhcp_relay_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
dhcp_relay_source_interface_id	Any	String or Integer[min: `0`]	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
redirects	Boolean	`true`, `false`	No
unreachables	Boolean	`true`, `false`	No
policy_route_map	String		No

igmp (nxos.devices.configuration.interfaces.ethernets.subinterfaces)

Name	Type	Constraint	Mandatory
version	Choice	`2`, `3`	No
startup_query_interval	Integer	min: `0`, max: `18000`	No
startup_query_count	Integer	min: `0`, max: `10`	No
robustness_variable	Integer	min: `1`, max: `7`	No
querier_timeout	Integer	min: `1`, max: `65535`	No
query_max_response_time	Integer	min: `1`, max: `8387`	No
query_interval	Integer	min: `1`, max: `18000`	No
last_member_query_response_time	Integer	min: `1`, max: `25`	No
last_member_query_count	Integer	min: `1`, max: `5`	No
group_timeout	Integer	min: `3`, max: `65535`	No
allow_v3_asm	Boolean	`true`, `false`	No
state_limit	Integer	min: `0`, max: `4294967295`	No
state_limit_reserved_route_map	String		No
state_limit_reserved	Integer	min: `0`, max: `4294967295`	No
report_policy	String		No
report_policy_prefix_list	String		No
access_group	String		No
access_group_prefix_list	String		No
join_groups	List	join_groups	No
join_group_route_map	String		No
static_groups	List	static_groups	No
static_oifs	List	static_oifs	No
static_oif_route_map	String		No
report_link_local_groups	Boolean	`true`, `false`	No
immediate_leave	Boolean	`true`, `false`	No
suppress_v3_gsq	Boolean	`true`, `false`	No

secondary_addresses (nxos.devices.configuration.interfaces.ethernets.subinterfaces.ip)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
tag	Integer	min: `0`, max: `4294967295`	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.ethernets.subinterfaces.ip)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
vrf	String		No

addresses (nxos.devices.configuration.interfaces.ethernets.subinterfaces.ipv6)

Name	Type	Constraint	Mandatory
address	IP		Yes
type	Choice	`primary`, `secondary`	No
tag	Integer	min: `0`, max: `4294967295`	No
eui64	Boolean	`true`, `false`	No
route_preference	Integer	min: `0`, max: `255`	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.ethernets.subinterfaces.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
vrf	String		No

join_groups (nxos.devices.configuration.interfaces.ethernets.subinterfaces.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

static_groups (nxos.devices.configuration.interfaces.ethernets.subinterfaces.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

static_oifs (nxos.devices.configuration.interfaces.ethernets.subinterfaces.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

Examples

Example 1: Routed Ethernet interface with subinterfaces using dot1q encapsulation and IP addressing

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/49
              description: "EXTERNAL: Firewall Eth1"
              switchport:
                enabled: false
              subinterfaces:
                - id: 100
                  description: "VRF-A Transit"
                  encapsulation: 100
                  vrf: VRF-A
                  ip:
                    address: 10.100.0.1/30
                  ipv6:
                    addresses:
                      - address: 2001:db8:100::1/126
                        type: primary
                - id: 200
                  description: "VRF-B Transit"
                  encapsulation: 200
                  vrf: VRF-B
                  ip:
                    address: 10.200.0.1/30