From 024aa4b0b4b30237cdaab0f22d3cb2e0136e0abb Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 18 Nov 2024 13:35:33 -0500 Subject: [PATCH] Update docs --- docs/models/dcim/interface.md | 10 +++++++--- docs/models/dcim/macaddress.md | 4 ++-- docs/models/virtualization/vminterface.md | 10 +++++++--- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index dd8afc797..f2af1a2ad 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -10,9 +10,6 @@ Interfaces in NetBox represent network interfaces used to exchange data with con ## Fields -!!! 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](./macaddress.md) object. - ### Device The device to which this interface belongs. @@ -48,6 +45,13 @@ The operation duplex (full, half, or auto). The [virtual routing and forwarding](../ipam/vrf.md) instance to which this interface is assigned. +### Primary MAC Address + +The [MAC address](./macaddress.md) 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](./macaddress.md) object. + ### WWN The 64-bit world-wide name (for Fibre Channel interfaces). diff --git a/docs/models/dcim/macaddress.md b/docs/models/dcim/macaddress.md index 311571904..fe3d1f0e3 100644 --- a/docs/models/dcim/macaddress.md +++ b/docs/models/dcim/macaddress.md @@ -1,8 +1,8 @@ # MAC Addresses -A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface. MAC addresses can be assigned to [device](../dcim/device.md) and [virtual machine](../virtualization/virtualmachine.md) interfaces. A MAC address can be specified as the "primary" MAC address for a given interface or VM interface. +A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface. MAC addresses can be assigned to [device](../dcim/device.md) and [virtual machine](../virtualization/virtualmachine.md) interfaces. A MAC address can be specified as the primary MAC address for a given device or VM interface. -Most interfaces have only a single MAC address, hard-coded at the factory. However, on some devices (particularly virtual interfaces) it is possible to assign additional MAC addresses or change existing ones. For this reason NetBox allows multiple MACAddress objects to be assigned to a single interface. However, for convenience and backward compatibiility reasons, the value of the `mac_address` field of the primary (or single) MAC address on an interface is reflected as a simple property in the interface detail page. +Most interfaces have only a single MAC address, hard-coded at the factory. However, on some devices (particularly virtual interfaces) it is possible to assign additional MAC addresses or change existing ones. For this reason NetBox allows multiple MACAddress objects to be assigned to a single interface. ## Fields diff --git a/docs/models/virtualization/vminterface.md b/docs/models/virtualization/vminterface.md index 910a97e28..6617b5e59 100644 --- a/docs/models/virtualization/vminterface.md +++ b/docs/models/virtualization/vminterface.md @@ -4,9 +4,6 @@ ## Fields -!!! 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](./macaddress.md) object. - ### Virtual Machine The [virtual machine](./virtualmachine.md) to which this interface is assigned. @@ -30,6 +27,13 @@ An interface on the same VM with which this interface is bridged. If not selected, this interface will be treated as disabled/inoperative. +### Primary MAC Address + +The [MAC address](./macaddress.md) 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](./macaddress.md) object. + ### MTU The interface's configured maximum transmissible unit (MTU).