Networking, Lens API, mac_port
This page contains information about an object type in the API for Lens, a campus network information system.
Description
Instances of mac_port indicate the time interval and details of the appearance of a MAC address on an access port (type interface) and VLAN (type vlan) in the network. The mac_port type provides the opportunity to identify and locate host devices on the network. Instances are available whenever their observations describe interface instances accessible to the caller.
Unlike most objects, mac_port instances are only meaningful within the context of the API call result which returns them. Accordingly, their instance identifiers relate them to data within the result but are not useful values for subsequent query.
Parameter prefix: mpt
Relationships
interface
Related type: interface
Description: The interface on which the MAC address was seen
Dressing parameter: mpt_interface
Cardinality: exactly one (scalar)
Relationship Attribute: mac_port.interface_id
Availability: This topic/item has not yet been finalized.
vlan
Related type: vlan
Description: The vlan on which the MAC address was seen
Dressing parameter: mpt_vlan
Cardinality: exactly one (scalar)
Relationship Attribute: mac_port.vlan_id
Availability: This topic/item has not yet been finalized.
device
Related type: device
Description: The device on which the associated interface resides
Dressing parameter: mpt_device
Cardinality: exactly one (scalar)
Relationship Attribute: mac_port.device_id
Availability: This topic/item has not yet been finalized.
ip_addresses
Related type: ip_mac
Description: A set of observations recalling the IP addresses bound to the MAC address and the intervals of these bindings.
Dressing parameter: mpt_ip_addresses
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. The related IDs are only in the ip_addresses relationship attribute list.
Availability: Instances within this relationship
are available to the API caller when the IP address resides on an subnet
accessible to the caller.
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| mac_port_id | Instance identifier | Instance identifier, meaningful only within the API call result which returns them | not available |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| mac | MAC | MAC address observed on the interface | String |
| vlan_number | Integer | Actual VLAN number observed with MAC address on the interface | Number |
| first_seen | Timestamp | First time the observation was made | Date |
| last_seen | Timestamp | Time of last confirmation of observation | Date |
| vlan_id | Integer | ID of vlan instance on which MAC address was observed | Number |
| vlan_name* | Text | Name of vlan instance on which MAC address was observed | String |
| device_name* | Text | Name of device instance on which the interface resides | String |
| device_id* | Integer | ID of device instance on which the interface resides | Number |
| device_ip* | IP | IP of device instance on which the interface resides | IP |
| interface_id | Integer | ID of interface instance on which MAC address was observed | Number |
| ifname* | Text | Name of interface instance on which MAC address was observed | String |
| uplink* | Boolean | Whether the interface instance on which MAC address was observed is considered to be an uplink port | Boolean (1 or 0) |
| tagging* | Boolean | Whether the interface instance on which MAC address was observed is tagging for any VLAN | Boolean (1 or 0) |
| interface_current* | Boolean | True when the interface instance on which MAC address was observed is in operation at present time | Boolean (1 or 0) |
| interface_start_date* | Timestamp | Time when the interface instance on which MAC address was observed became known to Lens | Date |
| interface_end_date* | Timestamp | Time when the interface instance on which MAC address was observed was no longer seen, or 1/1/2037 for current configurations | Date |
An asterisk ( * ) denotes a "migrated" attribute, provided for convenience