EtherVLANEncap

EtherVLANEncap Element Documentation

NAME

EtherVLANEncap — Click element; encapsulates packets in 802.1Q VLAN Ethernet header

SYNOPSIS

EtherVLANEncap(ETHERTYPE, SRC, DST, VLAN_TCI [, VLAN_PCP, keywords])

Batching: Batching natively supported
Ports: 1 input, 1 output
Processing: agnostic

DESCRIPTION

Encapsulates each packet in the 802.1Q header specified by its arguments. The resulting packet looks like an Ethernet packet with type 0x8100. The encapsulated Ethernet type is ETHERTYPE, which should be in host order. 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 VLAN shim header to a packet that's already Ethernet-encapsulated, use VLANEncap.

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. Set to -1 for no native VLAN. Defaults to 0.

EXAMPLES

Encapsulate packets in an 802.1Q Ethernet VLAN header with type ETHERTYPE_IP (0x0800), source address 1:1:1:1:1:1, destination address 2:2:2:2:2:2, and VLAN ID 1:

  EtherVLANEncap(0x0800, 1:1:1:1:1:1, 2:2:2:2:2:2, 1)

ELEMENT HANDLERS

• src (read/write) — Return or set the SRC parameter.
• dst (read/write) — Return or set the DST parameter.
• ethertype (read/write) — Return or set the ETHERTYPE parameter.
• vlan_tci (read/write) — Return or set the VLAN_TCI parameter.
• vlan_id (read/write) — Return or set the VLAN_ID parameter.
• vlan_pcp (read/write) — Return or set the VLAN_PCP parameter.
• native_vlan (read/write) — Return or set the NATIVE_VLAN parameter.

SEE ALSO

VLANEncap, StripEtherVLANHeader, SetVLANAnno, EtherEncap, ARPQuerier, EnsureEther, StoreEtherAddress

Generated by click-elem2man from ../elements/ethernet/ethervlanencap.hh:7 on 2018/10/03.