Networking, Lens API, device
Description
A device instance represents the identity and deployment lifespan of one actual hardware installation operating on the network under a specific configuration. The hardware identified by a device may provide significant layer-2 and/or layer-3 services such as ethernet bridging, wireless access, and network routing. A hardware unit has only one device instance describing its configuration state for any singular moment. However, the same hardware unit may have multiple device instances representing distinct configuration states that occurred over time. Although one might infer an evolutionary relationship between separate but similar device instances (e.g., that share a device name), there is no necessary connection.
Parameter prefix: dev
Relationships
interfaces
Related type: interface
Description: The set of interface instances which belong to a device instance
Dressing parameter: dev_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface.device_id
Availability restricted to: users with read privileges for a network configured on the interface if the vlan is untagged or the only tagged vlan present
tagged_interfaces
Related type: interface
Description: The set of interface instances which
belong to a device instance and are configured for tagged traffic for a
VLAN. This is the subset of the "interfaces" relationship that does not
appear in the "untagged_interfaces" set.
Dressing parameter: dev_tagged_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface.device_id
Availability restricted to: users with read privileges for a network configured on the interface if the vlan is the only tagged vlan present
untagged_interfaces
Related type: interface
Description: The set of interface instances which
belong to a device instance and are configured only for untagged
traffic. This is the subset of the "interfaces" relationship which does
not appear in the "tagged_interfaces" set.
Dressing parameter: dev_untagged_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface.device_id
Availability restricted to: users with read privileges for a network configured on the interface
vlans
Related type: device_vlan
Description: The set of device_vlan instances representing the appearances of VLANs on a device.
Dressing parameter: dev_vlans
Cardinality: zero to many (list)
Relationship Attribute: device_vlan.device_id
Availability restricted to: users with read privileges for a network configured on the device
NOTE: Some (normally all) VLANs defined on a device are
specifically bound to the device's interfaces in more specific
configurations. See the "interface" and "interface_vlan" object
specifications for details.
interface_vlans
Related type: interface_vlan
Description: The set of interface_vlan instances
which belong to interfaces of a device instance. Interface_vlan objects
specify the vlan configuration of a particular interface on the device
for a given period of time.
Dressing parameter: dev_interface_vlans
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.device_id
Availability restricted to: users with read privileges for a network configured on the interface if the vlan is untagged or the only tagged vlan present
NOTE: Not all vlans that appear in the "vlans" set will be
specifically configured on a port and appear in the "interface_vlans"
set. Likewise, not all vlans that appear on an interface in the
"interface_vlans" set will show as being configured on the device in the
"vlans" set, though this is normally the case.
observed_arps
Related type: ip_mac
Description: The set of ip_mac observation records
for which a device instance was acting as the router. This set will be
empty for devices that are not providing routing for the network.
Dressing parameter: dev_observed_arps
Cardinality: zero to many (list)
Relationship Attribute: ip_mac.device_id
Availability restricted to: users with read privileges on a network containing the IP address
observed_macs
Related type: mac_port
Description: The set of mac_port observation records for interface objects on a device instance.
Dressing parameter: dev_observed_macs
Cardinality: zero to many (list)
Relationship Attribute: mac_port.device_id
Availability restricted to: users with read privileges for a network configured on the interface if the vlan is untagged or the only tagged vlan present
passwords
Related type: password
Description: The set of password instances which belong to a device instance.
Dressing parameter: dev_passwords
Cardinality: zero to many (list)
Relationship Attribute: password.device_id
Availability restricted to: Only certain
individuals in Technology Services Networking have access to passwords. Those
privileges are assigned per device instance, by group membership and
password type.
Planned for a future release
deviceclasses
Related type: deviceclass
Description: The set of deviceclasses to which a device instance belongs (either directly or due to nesting)
Dressing parameter: dev_deviceclasses
Cardinality: zero to many (list)
Relationship Attribute: This topic/item has not yet been finalized.
Availability restricted to: This topic/item has not yet been finalized.
deviceclass_member
Related type: deviceclass
Description: The set of deviceclasses in which a device instance is member by direct inclusion.
Dressing parameter: dev_deviceclass_member
Cardinality: zero to many (list)
Relationship Attribute: This topic/item has not yet been finalized.
Availability restricted to: This topic/item has not yet been finalized.
Attributes
Identity attribute
| Attribute | Data type | Description | Query Parameter data type |
|---|---|---|---|
| device_id | Instance identifier | Unique device identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| device_name | Text | The device's name | String |
| current | Boolean | True when a device configuration is in operation at present | Boolean (1 or 0) |
| start_date | Timestamp | Time when device configuration became known to Lens | Date |
| end_date | Timestamp | Time when device configuration is known to have ceased, or 1/1/2037 for current devices | Date |
| ip | dotted-decimal IP address | IP address of device administrative interface | IP |
| model | Text | Hardware model general identification | String |
| type | Device type | Network function of device | String |
Device hardware detail attributes
These attributes describe specific hardware details used to identify and communicate with a device.
Availability restricted to: Technology Services Networking professionals
Dressing parameter: dev_hardware_detail
| Attribute | Data type | Description | Query Parameter Data Type |
|---|---|---|---|
| sysobjectid | Text | SNMP sysobjectid.0 value | String |
| sysdescr | Text | SNMP sysdescr.0 value | String |
| snmp_version | SNMP version | SNMP protocol version used to contact device | String |
| opsys | Text | Platform operating system general identification. | String |
Data integration attributes
These attributes are used within data integration processes that populate and maintain the Lens device list.
Availability restricted to: Technology Services Networking professionals
Dressing parameter: dev_data_integration
| Attribute | Data type | Description | Query Parameter Data Type |
|---|---|---|---|
| iris_class | Text | Iris implementation class used to communicate with a device | String |
| source | Text | External system providing most authoritative information about this device | String |
| source_sync_date | Timestamp | Time when last synchronized with source system | Date |
Auditing attributes
These attributes describe the modification history for the device
Availability restricted to: Technology Services Networking professionals
Dressing parameter: dev_auditing
| Attribute | Data type | Description | Query Parameter Data Type |
|---|---|---|---|
| created_by | Text | Name of user that created the Device record | String |
| created_date | Timestamp | Time when record was created | Date |
| modified_by | Text | Name of user who last modified Device record | String |
| timestamp | Timestamp | Time of last modification | Date |