1vdptool(8)                           Linux                          vdptool(8)
2
3
4

NAME

6       vdptool - manage the VSI associations and status of lldpad
7

SYNOPSIS

9       vdptool <command> [options] [argument]
10

DESCRIPTION

12       vdptool  is used to query and configure the VSI associations in lldpad.
13       Only the ratified stardard version of the VDP protocol (also refered to
14       as  vdp22) is supported.  It connects to the client interface of lldpad
15       to perform these operations.  vdptool will operate in interactive  mode
16       if it is executed without a command.  In interactive mode, vdptool will
17       also function as an event listener to print  out  events  as  they  are
18       received  asynchronously  from  lldpad(still  to be done).  It will use
19       libreadline for interactive input when available (still to be done).
20

OPTIONS

22       -i [ifname]
23              specifies the network interface to which  the  command  applies.
24              Most vdptool commands require specifying a network interface.
25
26       -V [tlvid]
27              specifies the VDP tlv identifier to be set or queried.
28              The  tlvid  is  an  integer  value used to identify specific VDP
29              TLVs.  The tlvid value is the type value for types not equal  to
30              127  (the organizationally specific type).  For organizationally
31              specific TLVs, the tlvid is the value represented by the 3  byte
32              OUI  and  1 byte subtype - where the subtype is the lowest order
33              byte of the tlvid.
34              The tlvid can be entered as a numerical value (e.g. 10 or  0xa),
35              or  for  supported  TLVs,  as a keyword (such as assoc, deassoc,
36              preassoc, preassoc-rr, etc).  Review the vdptool help output  to
37              see the list of supported TLV keywords.
38
39              Use option -c to specify the parameters and its values to be set
40              or queried.
41
42       -n     "neighbor" option for commands which can use it (e.g.  get-tlv).
43              Use  this flag to retrieve the last VDP22 data returned from the
44              bridge.  (not yet supported).
45
46       -c <argument list>
47              Specifies additional parameters for TLV queries and associations
48              commands.   The  argument  list varies, depending on the command
49              option (-T) or (-t).  To establish a  VSI  association  use  the
50              command  option (-T) and specify additional information as argu‐
51              ments in the form of key=value. See the VSI Parameter subsection
52              and  Example section below.  To query a VSI specific association
53              use the command option (-t) and specify the  value  of  the  VSI
54              Instance  Identifier  (keywork  uuid  followed  be  the VSI UUID
55              value) of the VSI association as configuration parameter.
56
57       -r     show raw client interface messages
58
59       -R     show only raw Client interface messages
60
61       -W     Wait for the bridge response message
62
63   VSI Parameter
64       Each VDP22 TLVs contains a command mode, manager identifier, type iden‐
65       tifier,  type  identifier  version,  VSI instance identifier, migration
66       hints and filter information.  The fields are explained next:
67
68       mode (Command Mode):
69              The command mode determines the type of the VSI  association  to
70              be established.  It is an ascii string can be one of:
71
72              assoc: Create an VSI association.
73
74              preassoc:
75                     Create  an  VSI  preassociation.  The association is only
76                     announced to the switch.
77
78              preassoc-rr:
79                     Create an VSI preassociation.  The  association  is  only
80                     announced to the switch and the switch should reserve the
81                     resources.
82
83              deassoc:
84                     Delete an VSI association.
85       Other strings are not recognized and return an error.
86
87       mgrid2 (Manager identifier):
88              The manager identifier is a string  of  up  to  16  alphanumeric
89              characters.   It  can also be an UUID according to RFC 4122 with
90              optional dashes in between.
91
92       typeid (Type Identifier):
93              The type identifier is a number in the range of 0 to 2^24 - 1.
94
95       typeidver (Type Identifier Version):
96              The type identifer version is a number in the range of 0 to 255.
97
98       uuid (VSI Instance Identifier):
99              The VSI instance identifier is an UUID  according  to  RFC  4122
100              with optional dashes in between.
101
102       hints (Migration Hints):
103              The  migration  hints is a string aiding in migration of virtual
104              machines:
105
106              none:  No hints available.
107
108              from:  The virtual machine is migrating away.
109
110              to:    The virtual machine is migrating to.
111
112       fid (Filter Information Data):
113              The filter information data can be supplied  in  four  different
114              formats  identified  by  numbers in parathesis.  Multiple filter
115              information fields can be supplied, but all have to  be  of  the
116              same format.
117
118              vlan (1)
119                     A vlan number only, also known as filter information for‐
120                     mat 1.  The vlan identifier is a number in the range of 1
121                     to  2^16  - 1.  The high order 4 bits are used as quality
122                     of service bits.  The vlan identifier can be zero, a vlan
123                     identifier  is then selected by the switch. Refer to IEEE
124                     802.1 Qbg ratified standard for details.
125
126              vlan-mac (2)
127                     A vlan number and MAC address delimited by a slash ('-'),
128                     also  known  as  filter  information  format  2.  The MAC
129                     address is specified  in  the  format  xx:xx:xx:xx:xx:xx.
130                     The colons are mandatory.  For vlan details see (1).
131
132              vlan-mac-group (4)
133                     A  vlan  number,  MAC  address and group identifier, each
134                     delimited by a slash ('-'), also known as filter informa‐
135                     tion  format 4.  The group identifier is a 32 bit number.
136                     For vlan and MAC address details see (1) and (2).
137
138              vlan--group (3)
139                     A vlan number and  group  identifier,  delimited  by  two
140                     slashes  ('--'),  also known as filter information format
141                     3.  For vlan and group details see (1) and (4).
142
143       oui (Organizationally Unique Identifier):
144              This defines the optional Organizationally  defined  information
145              field. This contains the specific sets of values for this entry.
146              There can be multiple organizational specific fields,  in  which
147              case  there  will be multiple keywords oui= followed by the val‐
148              ues.  The value is of the following format:
149              oui=OUI,[Organization specific values ]
150              The OUI specifies the name of the Organization that is responsi‐
151              ble  for  defining  this content. A comma is mandatory after the
152              OUI field. The fields following this
153               is specified by the organization  and  hence  will  be  decoded
154              based  on  the value of this OUI field. Currently, the following
155              values for OUI are supported.
156
157              cisco  Specifies Cisco defined OUI.
158
159
160       COMMANDS
161
162       license
163              show license information
164
165       -h, help
166              show usage information
167
168       -v, version
169              show version information
170
171       -t, get-vsi
172              get VSI information for the specified interface
173
174       -T, set-vsi
175              set VSI information for the specified interface
176
177       -p, ping
178              display the process identifier of the running lldpad process
179
180       -q, quit
181              exit from interactive mode
182

NOTES

184       This tool is in its early design and development phase.  It  it  buggy,
185       incomplete  and most of the ideas have not even been thought of....  It
186       reflects the current state of development when I had been given another
187       work  assignment.   I  append  it  so some else can continue to work on
188       this.
189

EXAMPLES

191       Display process identifier of lldpad
192              vdptool -p
193
194       Create a VSI association on interface eth2
195              vdptool -i eth2 -T -V assoc -c mode=assoc -c mgrid2=blabla \
196                   -c typeid=5 -c uuid=1122 -c typeidver=4 -c hints=none \
197                   -c filter=2-52:00:00:11:22:33-200
198
199       Create a VSI association on interface eth2 and wait for the
200              response from the bridge
201              vdptool -i eth2 -T -W -V assoc -c mode=assoc -c mgrid2=blabla \
202                   -c typeid=5 -c uuid=1122 -c typeidver=4 -c hints=none \
203                   -c filter=0-52:00:00:11:22:33-200
204
205       Create a VSI association on interface eth2 wth OUI parameters
206              and wait for the response from the bridge
207              vdptool -i eth2 -T -W -V assoc -c mode=assoc -c mgrid2=blabla \
208                   -c typeid=5 -c uuid=1122 -c typeidver=4 -c hints=none \
209                   -c filter=0-52:00:00:11:22:33-200 -c oui=CompanyA,data
210
211       Create a VSI association on interface eth2 wth multiple OUI parameters
212              and wait for the response from the bridge
213              vdptool -i eth2 -T -W -V assoc -c mode=assoc -c mgrid2=blabla \
214                   -c typeid=5 -c uuid=1122 -c typeidver=4 -c hints=none \
215                   -c filter=0-52:00:00:11:22:33-200 -c oui=CompanyA,data \
216                   -c oui=CompanyB,data
217
218
219       Query all VSI association on interface eth2
220              vdptool -i eth2 -t -V assoc
221
222
223       Query  VSI association on interface eth2 that matches specific
224              VSI parameters. Any of the VSI parameters below can be omitted.
225              vdptool -i eth2 -t -V assoc -t -V assoc -c mode=assoc \
226                      -c mgrid2=blabla -c typeid=5 -c uuid=1122 \
227                      -c typeidver=4 -c hints=none
228

SEE ALSO

230       lldptool-dcbx(8),  lldptool-ets(8),  lldptool-pfc(8),  lldptool-app(8),
231       lldptool-med(8),  lldptool-vdp(8),  lldptool-evb(8), lldptool-evb22(8),
232       dcbtool(8), lldpad(8)
233
235       vdptool - VSI configuration utility
236
237       Copyright(c)
238              (c) 2014 IBM Corporation.   Portions of vdptool are based on:
239
240       open-lldp-0.96
241
242       lldptool - LLDP agent configuration utility
243
244       Copyright(c)
245              2007-2012 Intel Corporation.   Portions of  lldptool  are  based
246              on:
247
248       hostapd-0.5.7
249
250       Copyright
251              (c) 2004-2008, Jouni Malinen <j@w1.fi>
252
253

LICENSE

255       This program is free software; you can redistribute it and/or modify it
256       under the terms and conditions of the GNU General Public License,  ver‐
257       sion 2, as published by the Free Software Foundation.
258
259       This  program is distributed in the hope it will be useful, but WITHOUT
260       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
261       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
262       for more details.
263
264       You should have received a copy of the GNU General Public License along
265       with this program; if not, write to the Free Software Foundation, Inc.,
266       51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
267
268       The full GNU General Public License is included in this distribution in
269       the file called "COPYING".
270

SUPPORT

272       Contact Information: open-lldp Mailing List <lldp-devel@open-lldp.org>
273
274
275
276open-lldp                         April 2014                        vdptool(8)
Impressum