Networking, Lens API, vlan
This page contains information about an object type in the API for Lens, a campus network information system.
Description
Each vlan instance represents a logical local area ethernet network (VLAN) configured across one or more switches. Every contemporaneous instance has a unique name. vlan instances and related data are authorized to listed network contacts. Note that a vlan may be constructed across switches using different ethernet frame tags or trunking technologies for participating traffic. API queries for information related by VLAN should utilize the vlan type to ensure proper results.
Parameter prefix: vln
Relationships
untagged_interfaces
Related type: interface_vlan
Description: The set of interface_vlan instances
describing untagged ports (as interfaces) configured on a vlan. The set
spans all devices that provide untagged ports. (Untagged ports may be
connected directly to customers' host devices and may be manipulated by
authorized IT Professionals in the Iris application.)
Dressing parameter: vln_untagged_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.vlan_id
Availability: Restricted to registered network contacts
tagged_interfaces
Related type: interface_vlan
Description: The set of interface_vlan instances
describing tagged ports (as interfaces) configured on a vlan. The set
spans all devices that provide tagged ports.
Dressing parameter: vln_tagged_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.vlan_id
Availability: This topic/item has not yet been finalized.
interfaces
Related type: interface_vlan
Description: The set of all interface_vlan
instances which describe ports (as interfaces) carrying traffic on a
vlan. The set spans all devices that configure ports on the vlan. (This
set unites the "untagged_interfaces" and "tagged_interfaces"
relationships.)
Dressing parameter: vln_interfaces
Cardinality: zero to many (list)
Relationship Attribute: interface_vlan.vlan_id
Availability: This topic/item has not yet been finalized.
devices
Related type: device_vlan
Description: The set of device_vlan instances describing the configurations of a vlan on devices.
Dressing parameter: vln_devices
Cardinality: zero to many (list)
Relationship Attribute: device_vlan.vlan_id
Availability: Restricted to registered network contacts
subnets
Related type: subnet
Description: The set of subnet instances defining
the IPs that are routed for a vlan. Typically, this is a single subnet
at any point in time.
Dressing parameter: vln_subnets
Cardinality: zero to many (list)
Relationship Attribute: None because it is a Many-to-Many. The related IDs are only in the subnets relationship attribute list.
Availability: Restricted to registered network contacts
observed_macs
Related type: mac_port
Description: The set of mac_port relationship spans
that were observed on a vlan. Note that mac_port observations are not
retained for ports that are determined to be uplink ports for the vlan.
Dressing parameter: vln_observed_macs
Cardinality: zero to many (list)
Relationship Attribute: mac_port.vlan_id
Availability: Restricted to registered network contacts
Attributes
Identity attribute
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| vlan_id | Instance identifier | Unique vlan instance ID | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| vlan_name | Text | Name of vlan, contemporaneously unique | String |
| current | Boolean | True whenever the vlan is currently defined in UIUCnet | Boolean (1 or 0) |
| start_date | Timestamp | Time when vlan was defined in UIUCnet | Date |
| end_date | Timestamp | Time when vlan was no longer seen in UIUCnet | Date |