Topics Map > Networking
Networking, Lens API, interface_vlan
Description
Each instance of interface_vlan relates one vlan instance with one interface that carries its traffic and provides the inherent configuration details. Unlike device and interface types whose instances have physical analogs, type interface_vlan records fine-grained, nonphysical configuration facts effective in the network. In addition to providing a rich description of network configuration, interface_vlan provides a flexible query interface for VLAN topologies.
Parameter prefix: ifv
Relationships
interface
Related type: interface
Description: An interface instance to which the vlan instance is bound
Dressing parameter: ifv_interface
Cardinality: exactly one (scalar)
Relationship Attribute: interface_vlan.interface_id
Availability: This topic/item has not yet been finalized.
vlan
Related type: vlan
Description: The vlan instance bound to the interface instance. May be empty if the vlan number does not map to a named campus vlan object.
Dressing parameter: ifv_vlan
Cardinality: zero or one (scalar)
Relationship Attribute: interface_vlan.vlan_id
Availability: This topic/item has not yet been finalized.
device
Related type: device
Description: The device to which the interface instance belongs, provided for flexibility.
Dressing parameter: ifv_device
Cardinality: exactly one (scalar)
Relationship Attribute: interface_vlan.device_id
Availability: This topic/item has not yet been finalized.
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter datatype |
|---|---|---|---|
| interface_vlan_id | Instance identifier | Unique interface_vlan record identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter datatype |
|---|---|---|---|
| interface_id | Integer | interface_id attribute of related interface instance | Number |
| device_id* | Integer | id attribute of device owning the related interface instance | Number |
| vlan_id | Integer | id attribute of related vlan instance | Number |
| ifname* | Text | ifname attribute of related interface 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 |
| vlan_number | Integer | Numeric VLAN number (802.1q tag) assigned to the vlan on the interface | Number |
| tagged | Boolean | True when the traffic on the vlan is tagged on the interface | Boolean (1 or 0) |
| vlan_name* | Text | name attribute of related vlan instance | String |
| 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