Topics Map > Networking
Networking, Lens API, device_vlan
Description
Instances of device_vlan describe the configuration linking a VLAN (type vlan) to a network device (type device) with a VLAN number. These configurations do not explain network topology as do the more specific interface_vlan items. However, device_vlan records provide a simpler and more direct association between VLANs and underlying devices than do interface_vlan configurations.
Parameter prefix: dvl
Relationships
vlan
Related type: vlan
Description: The vlan instance that is configured on the device instance
Dressing parameter: dvl_vlan
Cardinality: exactly one (scalar)
Relationship Attribute: device_vlan.vlan_id
Availability: This topic/item has not yet been finalized.
device
Related type: device
Description: The device on which the vlan instance is configured.
Dressing parameter: dvl_device
Cardinality: exactly one (scalar)
Relationship Attribute: device_vlan.device_id
Availability: This topic/item has not yet been finalized.
Attributes
Identity attribute
| Attribute | Data type | Description | Query Parameter data type |
|---|---|---|---|
| device_vlan_id | Instance identifier | Unique interface_vlan record identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter datatype |
|---|---|---|---|
| device_id | Integer | device_id attribute of related device instance | Number |
| vlan_id | Integer | id attribute of related vlan instance | Number |
| vlan_number | Integer | Numeric VLAN number (802.1q tag) assigned to the vlan on the interface | Number |
| vlan_name* | Text | name attribute of related vlan instance | String |
| device_name* | Text | name attribute of device owning the related interface instance | String |
| device_ip* | IP | ip attribute of device owning the related interface instance | IP |
| current | Boolean | True when this configuration is in operation at present time | Boolean (1 or 0) |
| start_date | Timestamp | Time when this configuration became known to Lens | Date |
| end_date | Timestamp | Time when configuration is known to have ceased, or 1/1/2037 for current configurations | Date |
An asterisk ( * ) denotes a "migrated" attribute, provided for convenience