This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

VLANEncap Element Documentation


VLANEncap -- Click element; add VLAN information to Ethernet packets


VLANEncap([VLAN_TCI, VLAN_PCP, <keywords>])

Ports: 1 input, 1 output
Processing: agnostic
Package: ethernet (core)


Expects Ethernet-encapsulated packets as input. Adds an 802.1Q shim header. The resulting packet looks like an Ethernet packet with type 0x8100. The VLAN arguments define the VLAN ID and priority code point. VLAN_TCI is a 16-bit VLAN TCI, including both the VLAN ID and the VLAN PCP. VLAN_TCI may also be the string "ANNO"; in ANNO mode, the encapsulated VLAN TCI is read from the input packet's VLAN_TCI annotation. You may also set the VLAN_ID and VLAN_PCP separately via keywords. If you want to add a full Ethernet 802.1Q header, use EtherVLANEncap. Keyword arguments are:

VLAN_ID The VLAN ID, a number between 0 and 0xFFF. Exactly one of VLAN_ID and VLAN_TCI must be set. Note that VLAN IDs 0 and 0xFFF are reserved in 802.1Q.
VLAN_PCP The VLAN Priority Code Point, a number between 0 and 7. Defaults to 0.
NATIVE_VLAN The native VLAN, a number between -1 and 0xFFF. If the output VLAN ID equals NATIVE_VLAN, then the output packet is encapsulated in a conventional Ethernet header, rather than an 802.1Q header (i.e., the shim header is not added). Set to -1 for no native VLAN. Defaults to 0.


EtherVLANEncap, VLANDecap

Generated by 'click-elem2man' from '../elements/ethernet/vlanencap.hh:7' on 16/Jul/2011.


elements/vlanencap.txt · Last modified: 2011/07/16 22:38 (external edit)
Recent changes RSS feed Driven by DokuWiki