netbox/docs/models/virtualization/vminterface.md

Interfaces

Virtual machine interfaces behave similarly to device interfaces: They can be assigned to VRFs, may have IP addresses, VLANs, and services attached to them, and so on. However, given their virtual nature, they lack properties pertaining to physical attributes. For example, VM interfaces do not have a physical type and cannot have cables attached to them.

Fields

Virtual Machine

The virtual machine to which this interface is assigned.

Name

The interface's name. Must be unique to the assigned VM.

Parent Interface

Identifies the parent interface of a subinterface (e.g. used to employ encapsulation).

!!! note

An interface with one or more child interfaces assigned cannot be deleted until all its child interfaces have been deleted or reassigned.

Bridged Interface

An interface on the same VM with which this interface is bridged.

Enabled

If not selected, this interface will be treated as disabled/inoperative.

Primary MAC Address

The MAC address assigned to this interface which is designated as its primary.

!!! note "Changed in NetBox v4.2"

The MAC address of an interface (formerly a concrete database field) is available as a property, `mac_address`, which reflects the value of the primary linked [MAC address](../dcim/macaddress.md) object.

MTU

The interface's configured maximum transmissible unit (MTU).

802.1Q Mode

For switched Ethernet interfaces, this identifies the 802.1Q encapsulation strategy in effect. Options include:

• Access: All traffic is assigned to a single VLAN, with no tagging.
• Tagged: One untagged "native" VLAN is allowed, as well as any number of tagged VLANs.
• Tagged (all): Implies that all VLANs are carried by the interface. One untagged VLAN may be designated.
• Q-in-Q: Q-in-Q (IEEE 802.1ad) encapsulation is performed using the assigned SVLAN.

This field must be left blank for routed interfaces which do employ 802.1Q encapsulation.

Untagged VLAN

The "native" (untagged) VLAN for the interface. Valid only when one of the above 802.1Q mode is selected.

Tagged VLANs

The tagged VLANs which are configured to be carried by this interface. Valid only for the "tagged" 802.1Q mode above.

Q-in-Q SVLAN

!!! info "This field was introduced in NetBox v4.2."

The assigned service VLAN (for Q-in-Q/802.1ad interfaces).

VRF

The virtual routing and forwarding instance to which this interface is assigned.

VLAN Translation Policy

!!! info "This field was introduced in NetBox v4.2."

The VLAN translation policy that applies to this interface (optional).