Networking, Lens API, ip_mac
Description
Instances of ip_mac indicate the time interval and details of the binding between a MAC address and an IP address on the network, as learned by the ARP cache of a routing device. Instances are available whenever they describe an IP address in a subnet available to the API caller.
Unlike most objects, ip_mac 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: ipm
Relationships
router
Related type: device
Description: The device instance representing the router which reported the IP-to-MAC address binding in its ARP cache
Dressing parameter: ipm_router
Cardinality: exactly one (scalar)
Relationship Attribute: ip_mac.device_id
Availability: This topic/item has not yet been finalized.
subnets
Related type: subnet
Description: The set of subnet object instances that provided the routing for this observation span.
Dressing parameter: ipm_network
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. Related IDs only in "subnets" relationship attribute list
Availability: This topic/item has not yet been finalized.
ports
Related type: mac_port
Description: The set of mac_port instances sharing a VLAN which is bound the same MAC address
Dressing parameter: ipm_ports
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. Related IDs only in "ports" relationship attribute list
Availability: This topic/item has not yet been finalized.
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| ip_mac_id | Instance identifier | Instance Identifier, unique only within API call result in which it appears. May be a negative value | not available |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| ip | IP | An IP address bound to the MAC address | IP |
| mac | MAC | The MAC address bound to the IP address | MAC |
| first_seen | Timestamp | Time when binding was first observed | Date |
| last_seen | Timestamp | Time when binding was last observed | Date |
| device_id | Integer | ID of the related device instance (reporting router) | String |
| router_name* | Text | Name of the related device instance (reporting router) | String |
| router_ip* | IP | IP of the related device instance (reporting router) | String |
An asterisk ( * ) denotes a "migrated" attribute, provided for convenience