Networking, Lens API, interface
Description
An interface represents a network interface belonging to one network device. An interface may be a physical port, a BSSID carried on a wireless access point, or other layer-2 attachments. An interface may have several simultaneous names including a link-layer address that is unique on any VLAN. An interface may carry traffic for one untagged VLAN and several tagged VLANs.
Parameter prefix: ifc
Relationships
device
Related type: device
Description: The singular parent device to which
the interface belongs; a reference to the device described by the
"device_name" and "device_id" essential attributes
Dressing parameter: ifc_device
Cardinality: exactly one (scalar)
Relationship Attribute: interface.device_id
Availability restricted to: This topic/item has not yet been finalized.
untagged_vlans
Related type: interface_vlan
Description: The set of interface_vlan objects
representing a vlan configuration on the interface for which the
interface carries traffic without 802.1q frame tags.
Dressing parameter: ifc_untagged_vlans
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.interface_id
Availability restricted to: This topic/item has not yet been finalized.
tagged_vlans
Related type: interface_vlan
Description: The set of interface_vlan objects
representing a vlan configuration on the interface for which the
interface carries traffic with 802.1q frame tags.
Dressing parameter: ifc_tagged_vlans
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.interface_id
Availability restricted to: This topic/item has not yet been finalized.
vlans
Related type: interface_vlan
Description: The set of all interface_vlan objects representing a vlan configuration on the interface.
Dressing parameter: ifc_vlans
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.interface_id
Availability restricted to: This topic/item has not yet been finalized.
observed_macs
Related type: mac_port
Description: The set of mac_port objects, which are
intervals of MAC address appearances, observed on the interface during
the query time frame
Dressing parameter: ifc_observed_macs
Cardinality: zero to many (list)
Relationship Attribute: mac_port.interface_id
Availability restricted to: ?
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| interface_id | Instance identifier | Unique interface identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| ifname | Text | Name of network interface; contemporaneously unique on device | String |
| ifalias | Text | User-assigned text value | String |
| ifindex | Integer | Numeric assignment of interface in device administrative node | Number |
| uplink | Boolean | True whenever the interface is considered to be an uplink between devices | Boolean (1 or 0) |
| tagging | Boolean | True if any contemporary interface_vlan object is tagging on this interface | Boolean (1 or 0) |
| mac | MAC | Physical address of interface (may be null) | MAC |
| device_id | Integer | ID attribute of the parent device | Number |
| device_name* | Text | Value of the device_name attribute of the parent device; provided to facilitate simple API uses | String |
| device_ip* | IP | Value of the device_ip attribute of the parent device; provided to facilitate simple API uses | IP |
| current | Boolean | True when an interface is configured at present | Boolean (1 or 0) |
| start_date | Timestamp | Time when interface became known to Lens | Date |
| end_date | Timestamp | Time when interface was last observed if no longer observed, or 1/1/2037 for current interfaces | Date |
An asterisk ( * ) denotes a "migrated" attribute, provided for convenience