Skip to main content

SubInterface

Subinterface data for logical interfaces associated with a given interface.

Fields

nametypenullabledescription
nameStringfalseThe system-assigned name for the sub-interface. This MAY be a combination of the base interface name and the subinterface index, or some other convention used by the system.
layerLayerfalseDenotes whether this is a Layer 2 (physical) or Layer 3 (logical) interface.
aliasesList<String>falseThe set of all names that refer to this subinterface. For example, on Cisco, an interface named "eth1.100" might also be referred to as "Ethernet1.100". This field would then include both "eth1.100" and "Ethernet1.100".
descriptionStringtrueA textual description of the interface.
adminStatusAdminStatusfalseThe desired state of the interface. Here, it reflects the administrative state as set by enabling or disabling the interface.
operStatusOperStatusfalseThe current operational state of the interface.
aclsIfaceAclsfalseAccess control list details specific to this interface.
vlanSubInterfaceVlantrue--
ipv4IfaceIpv4InfofalseConfiguration and state for IPv4 interfaces.
ipv6IfaceIpv6InfofalseConfiguration and state for IPv6 interfaces.
switchedVlansSwitchedSubInterfaceVlanstrueSwitched VLAN configuration of the subinterface. Non-null if this interface is a switch-subinterface.
networkInstanceNameStringtrueThe network instance (i.e. VRF) that this interface is part of. Non-null if this interface is not a switch-subinterface.

Used by

network → devices → interfaces → subinterfaces

See also

Data model path