.\" DO NOT MODIFY THIS FILE!  It was generated by setup.py 1.2.
.TH VLAN 3 "21 March 2023" "NFStest 3.2" "vlan 1.0"
.SH NAME
packet.link.vlan - VLAN module
.SH DESCRIPTION

Decode Virtual LAN IEEE 802.1Q/802.1ad layer
.SH CLASSES
.SS class VLAN(baseobj.BaseObj)
.nf
VLAN object

Usage:
    from packet.link.vlan import VLAN

    x = VLAN(pktt)

Object definition:

VLAN(
    pcp   = int,  # Priority Point Code
    dei   = int,  # Drop Eligible Indicator
    vid   = int,  # VLAN Identifier
    etype = int,  # Payload Type
    psize = int,  # Payload Data Size
)

.P
.B Methods defined here:
---------------------
.P
.B __init__(self, pktt)
Constructor

Initialize object's private data.

.RS
.TP
.B
pktt:
Packet trace object (packet.pktt.Pktt) so this layer has
access to the parent layers.
.RE
.P
.B __str__(self)
String representation of object

The representation depends on the verbose level set by debug_repr().
If set to 0 the generic object representation is returned.
If set to 1 the representation of the object is condensed:
    '802.1Q VLAN pcp: 4, dei: 0, vid: 2704 '

If set to 2 the representation of the object also includes the type
of payload:
    '802.1Q Virtual LAN, pcp: 4, dei: 0, vid: 2704, etype: 0x0800(IPv4)'
.fi
.SH FUNCTIONS
.nf
.B vlan_layers(pktt)
Get all nested (stacked VLANs or QinQ) VLAN layers
A Packet layer attribute is created for each VLAN layer:
vlan1, vlan2, ..., and vlan. The last packet attribute
is always vlan.
.SH SEE ALSO
.BR baseobj(3),
.BR packet.link.ethernet_const(3)

.SH BUGS
No known bugs.
.SH AUTHOR
Jorge Mora (mora@netapp.com)