1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
4 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
5 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
6 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
7 .\" This notice shall appear on any product containing this material.
8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
9 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
10 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 .TH DLADM 1M "Feb 10, 2014"
12 .SH NAME
13 dladm \- administer data links
14 .SH SYNOPSIS
15 .LP
16 .nf
17 \fBdladm\fR
18 .fi
19
20 .LP
21 .nf
22 \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR]
23 \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR
24 .fi
25
26 .LP
27 .nf
28 \fBdladm delete-phys\fR \fIphys-link\fR
29 \fBdladm show-phys\fR [\fB-P\fR] [\fB-m\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-H\fR] [\fIphys-link\fR]
30 .fi
31
32 .LP
33 .nf
34 \fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
35 [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...] \fIaggr-link\fR
36 \fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
37 [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fIaggr-link\fR
38 \fBdladm delete-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIaggr-link\fR
39 \fBdladm add-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]
40 \fIaggr-link\fR
41 \fBdladm remove-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]
42 \fIaggr-link\fR
43 \fBdladm show-aggr\fR [\fB-PLx\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
44 [\fIaggr-link\fR]
45 .fi
46
47 .LP
48 .nf
49 \fBdladm create-bridge\fR [\fB-P\fR \fIprotect\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIpriority\fR]
50 [\fB-m\fR \fImax-age\fR] [\fB-h\fR \fIhello-time\fR] [\fB-d\fR \fIforward-delay\fR] [\fB-f\fR \fIforce-protocol\fR]
51 [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR
52 .fi
53
54 .LP
55 .nf
56 \fBdladm modify-bridge\fR [\fB-P\fR \fIprotect\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIpriority\fR]
57 [\fB-m\fR \fImax-age\fR] [\fB-h\fR \fIhello-time\fR] [\fB-d\fR \fIforward-delay\fR] [\fB-f\fR \fIforce-protocol\fR]
58 \fIbridge-name\fR
59 .fi
60
61 .LP
62 .nf
63 \fBdladm delete-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fIbridge-name\fR
64 .fi
65
66 .LP
67 .nf
68 \fBdladm add-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR [\fB-l\fR \fIlink\fR...]\fIbridge-name\fR
69 .fi
70
71 .LP
72 .nf
73 \fBdladm remove-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR
74 .fi
75
76 .LP
77 .nf
78 \fBdladm show-bridge\fR [\fB-flt\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR,...]
79 [\fIbridge-name\fR]
80 .fi
81
82 .LP
83 .nf
84 \fBdladm create-vlan\fR [\fB-ft\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link\fR \fB-v\fR \fIvid\fR [\fIvlan-link\fR]
85 \fBdladm delete-vlan\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIvlan-link\fR
86 \fBdladm show-vlan\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIvlan-link\fR]
87 .fi
88
89 .LP
90 .nf
91 \fBdladm scan-wifi\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIwifi-link\fR]
92 \fBdladm connect-wifi\fR [\fB-e\fR \fIessid\fR] [\fB-i\fR \fIbssid\fR] [\fB-k\fR \fIkey\fR,...]
93 [\fB-s\fR none | wep | wpa ] [\fB-a\fR open | shared] [\fB-b\fR bss | ibss] [\fB-c\fR]
94 [\fB-m\fR a | b | g] [\fB-T\fR \fItime\fR] [\fIwifi-link\fR]
95 \fBdladm disconnect-wifi\fR [\fB-a\fR] [\fIwifi-link\fR]
96 \fBdladm show-wifi\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIwifi-link\fR]
97 .fi
98
99 .LP
100 .nf
101 \fBdladm show-ether\fR [\fB-x\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIether-link\fR]
102 .fi
103
104 .LP
105 .nf
106 \fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR
107 \fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIprop\fR[,...]] \fIlink\fR
108 \fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]
109 .fi
110
111 .LP
112 .nf
113 \fBdladm create-secobj\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-f\fR \fIfile\fR] \fB-c\fR \fIclass\fR \fIsecobj\fR
114 \fBdladm delete-secobj\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIsecobj\fR[,...]
115 \fBdladm show-secobj\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIsecobj\fR,...]
116 .fi
117
118 .LP
119 .nf
120 \fBdladm create-vnic\fR [\fB-t\fR] \fB-l\fR \fIlink\fR [\fB-R\fR \fIroot-dir\fR] [\fB-m\fR \fIvalue\fR | auto |
121 {factory \fB-n\fR \fIslot-identifier\fR]} | {random [\fB-r\fR \fIprefix\fR]}]
122 [\fB-v\fR \fIvlan-id\fR] [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIvnic-link\fR
123 \fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIvnic-link\fR
124 \fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]]
125 [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR]
126 .fi
127
128 .LP
129 .nf
130 \fBdladm create-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
131 \fBdladm delete-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
132 \fBdladm show-etherstub\fR [\fIetherstub\fR]
133 .fi
134
135 .LP
136 .nf
137 \fBdladm create-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-T\fR \fItype\fR [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR]
138 \fIiptun-link\fR
139 \fBdladm modify-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR] \fIiptun-link\fR
140 \fBdladm delete-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIiptun-link\fR
141 \fBdladm show-iptun\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIiptun-link\fR]
142 .fi
143
144 .LP
145 .nf
146 \fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR]
147 [\fB-e\fR \fItime\fR] [\fIlink\fR]
148 .fi
149
150 .LP
151 .nf
152 \fBdladm help\fR [\fIsubcommand\fR]
153 .fi
154
155 .SH DESCRIPTION
156 .sp
157 .LP
158 The \fBdladm\fR command is used to administer data-links. A data-link is
159 represented in the system as a \fBSTREAMS DLPI\fR (v2) interface which can be
160 plumbed under protocol stacks such as \fBTCP/IP\fR. Each data-link relies on
161 either a single network device or an aggregation of devices to send packets to
162 or receive packets from a network.
163 .sp
164 .LP
165 Each \fBdladm\fR subcommand operates on one of the following objects:
166 .sp
167 .ne 2
168 .na
169 \fB\fBlink\fR\fR
170 .ad
171 .sp .6
172 .RS 4n
173 A datalink, identified by a name. In general, the name can use any alphanumeric
174 characters (or the underscore, \fB_\fR), but must start with an alphabetic
175 character and end with a number. A datalink name can be at most 31 characters,
176 and the ending number must be between 0 and 4294967294 (inclusive). The ending
177 number must not begin with a zero. Datalink names between 3 and 8 characters
178 are recommended.
179 .sp
180 Some subcommands operate only on certain types or classes of datalinks. For
181 those cases, the following object names are used:
182 .sp
183 .ne 2
184 .na
185 \fB\fBphys-link\fR\fR
186 .ad
187 .sp .6
188 .RS 4n
189 A physical datalink.
190 .RE
191
192 .sp
193 .ne 2
194 .na
195 \fB\fBvlan-link\fR\fR
196 .ad
197 .sp .6
198 .RS 4n
199 A VLAN datalink.
200 .RE
201
202 .sp
203 .ne 2
204 .na
205 \fB\fBaggr-link\fR\fR
206 .ad
207 .sp .6
208 .RS 4n
209 An aggregation datalink (or a key; see NOTES).
210 .RE
211
212 .sp
213 .ne 2
214 .na
215 \fB\fBether-link\fR\fR
216 .ad
217 .sp .6
218 .RS 4n
219 A physical Ethernet datalink.
220 .RE
221
222 .sp
223 .ne 2
224 .na
225 \fB\fBwifi-link\fR\fR
226 .ad
227 .sp .6
228 .RS 4n
229 A WiFi datalink.
230 .RE
231
232 .sp
233 .ne 2
234 .na
235 \fB\fBvnic-link\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 A virtual network interface created on a link or an \fBetherstub\fR. It is a
240 pseudo device that can be treated as if it were an network interface card on a
241 machine.
242 .RE
243
244 .sp
245 .ne 2
246 .na
247 \fB\fBiptun-link\fR\fR
248 .ad
249 .sp .6
250 .RS 4n
251 An IP tunnel link.
252 .RE
253
254 .RE
255
256 .sp
257 .ne 2
258 .na
259 \fB\fBdev\fR\fR
260 .ad
261 .sp .6
262 .RS 4n
263 A network device, identified by concatenation of a driver name and an instance
264 number.
265 .RE
266
267 .sp
268 .ne 2
269 .na
270 \fB\fBetherstub\fR\fR
271 .ad
272 .sp .6
273 .RS 4n
274 An Ethernet stub can be used instead of a physical NIC to create VNICs. VNICs
275 created on an \fBetherstub\fR will appear to be connected through a virtual
276 switch, allowing complete virtual networks to be built without physical
277 hardware.
278 .RE
279
280 .sp
281 .ne 2
282 .na
283 \fB\fBbridge\fR\fR
284 .ad
285 .sp .6
286 .RS 4n
287 A bridge instance, identified by an administratively-chosen name. The name may
288 use any alphanumeric characters or the underscore, \fB_\fR, but must start and
289 end with an alphabetic character. A bridge name can be at most 31 characters.
290 The name \fBdefault\fR is reserved, as are all names starting with \fBSUNW\fR.
291 .sp
292 Note that appending a zero (\fB0\fR) to a bridge name produces a valid link
293 name, used for observability.
294 .RE
295
296 .sp
297 .ne 2
298 .na
299 \fB\fBsecobj\fR\fR
300 .ad
301 .sp .6
302 .RS 4n
303 A secure object, identified by an administratively-chosen name. The name can
304 use any alphanumeric characters, as well as underscore (\fB_\fR), period
305 (\fB\&.\fR), and hyphen (\fB-\fR). A secure object name can be at most 32
306 characters.
307 .RE
308
309 .SS "Options"
310 .sp
311 .LP
312 Each \fBdladm\fR subcommand has its own set of options. However, many of the
313 subcommands have the following as a common option:
314 .sp
315 .ne 2
316 .na
317 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
318 .ad
319 .sp .6
320 .RS 4n
321 Specifies an alternate root directory where the operation-such as creation,
322 deletion, or renaming-should apply.
323 .RE
324
325 .SS "SUBCOMMANDS"
326 .sp
327 .LP
328 The following subcommands are supported:
329 .sp
330 .ne 2
331 .na
332 \fB\fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
333 [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]][\fIlink\fR]\fR
334 .ad
335 .sp .6
336 .RS 4n
337 Show link configuration information (the default) or statistics, either for all
338 datalinks or for the specified link \fIlink\fR. By default, the system is
339 configured with one datalink for each known network device.
340 .sp
341 .ne 2
342 .na
343 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
344 .ad
345 .sp .6
346 .RS 4n
347 A case-insensitive, comma-separated list of output fields to display. When not
348 modified by the \fB-s\fR option (described below), the field name must be one
349 of the fields listed below, or the special value \fBall\fR to display all
350 fields. By default (without \fB-o\fR), \fBshow-link\fR displays all fields.
351 .sp
352 .ne 2
353 .na
354 \fB\fBLINK\fR\fR
355 .ad
356 .sp .6
357 .RS 4n
358 The name of the datalink.
359 .RE
360
361 .sp
362 .ne 2
363 .na
364 \fB\fBCLASS\fR\fR
365 .ad
366 .sp .6
367 .RS 4n
368 The class of the datalink. \fBdladm\fR distinguishes between the following
369 classes:
370 .sp
371 .ne 2
372 .na
373 \fB\fBphys\fR\fR
374 .ad
375 .sp .6
376 .RS 4n
377 A physical datalink. The \fBshow-phys\fR subcommand displays more detail for
378 this class of datalink.
379 .RE
380
381 .sp
382 .ne 2
383 .na
384 \fB\fBaggr\fR\fR
385 .ad
386 .sp .6
387 .RS 4n
388 An IEEE 802.3ad link aggregation. The \fBshow-aggr\fR subcommand displays more
389 detail for this class of datalink.
390 .RE
391
392 .sp
393 .ne 2
394 .na
395 \fB\fBvlan\fR\fR
396 .ad
397 .sp .6
398 .RS 4n
399 A VLAN datalink. The \fBshow-vlan\fR subcommand displays more detail for this
400 class of datalink.
401 .RE
402
403 .sp
404 .ne 2
405 .na
406 \fB\fBvnic\fR\fR
407 .ad
408 .sp .6
409 .RS 4n
410 A virtual network interface. The \fBshow-vnic\fR subcommand displays more
411 detail for this class of datalink.
412 .RE
413
414 .RE
415
416 .sp
417 .ne 2
418 .na
419 \fB\fBMTU\fR\fR
420 .ad
421 .sp .6
422 .RS 4n
423 The maximum transmission unit size for the datalink being displayed.
424 .RE
425
426 .sp
427 .ne 2
428 .na
429 \fB\fBSTATE\fR\fR
430 .ad
431 .sp .6
432 .RS 4n
433 The link state of the datalink. The state can be \fBup\fR, \fBdown\fR, or
434 \fBunknown\fR.
435 .RE
436
437 .sp
438 .ne 2
439 .na
440 \fB\fBBRIDGE\fR\fR
441 .ad
442 .sp .6
443 .RS 4n
444 The name of the bridge to which this link is assigned, if any.
445 .RE
446
447 .sp
448 .ne 2
449 .na
450 \fB\fBOVER\fR\fR
451 .ad
452 .sp .6
453 .RS 4n
454 The physical datalink(s) over which the datalink is operating. This applies to
455 \fBaggr\fR, \fBbridge\fR, and \fBvlan\fR classes of datalinks. A VLAN is
456 created over a single physical datalink, a bridge has multiple attached links,
457 and an aggregation is comprised of one or more physical datalinks.
458 .RE
459
460 When the \fB-o\fR option is used in conjunction with the \fB-s\fR option, used
461 to display link statistics, the field name must be one of the fields listed
462 below, or the special value \fBall\fR to display all fields
463 .sp
464 .ne 2
465 .na
466 \fB\fBLINK\fR\fR
467 .ad
468 .sp .6
469 .RS 4n
470 The name of the datalink.
471 .RE
472
473 .sp
474 .ne 2
475 .na
476 \fB\fBIPACKETS\fR\fR
477 .ad
478 .sp .6
479 .RS 4n
480 Number of packets received on this link.
481 .RE
482
483 .sp
484 .ne 2
485 .na
486 \fB\fBRBYTES\fR\fR
487 .ad
488 .sp .6
489 .RS 4n
490 Number of bytes received on this link.
491 .RE
492
493 .sp
494 .ne 2
495 .na
496 \fB\fBIERRORS\fR\fR
497 .ad
498 .sp .6
499 .RS 4n
500 Number of input errors.
501 .RE
502
503 .sp
504 .ne 2
505 .na
506 \fB\fBOPACKETS\fR\fR
507 .ad
508 .sp .6
509 .RS 4n
510 Number of packets sent on this link.
511 .RE
512
513 .sp
514 .ne 2
515 .na
516 \fB\fBOBYTES\fR\fR
517 .ad
518 .sp .6
519 .RS 4n
520 Number of bytes sent on this link.
521 .RE
522
523 .sp
524 .ne 2
525 .na
526 \fB\fBOERRORS\fR\fR
527 .ad
528 .sp .6
529 .RS 4n
530 Number of output errors.
531 .RE
532
533 .RE
534
535 .sp
536 .ne 2
537 .na
538 \fB\fB-p\fR, \fB--parseable\fR\fR
539 .ad
540 .sp .6
541 .RS 4n
542 Display using a stable machine-parseable format. The \fB-o\fR option is
543 required with \fB-p\fR. See "Parseable Output Format", below.
544 .RE
545
546 .sp
547 .ne 2
548 .na
549 \fB\fB-P\fR, \fB--persistent\fR\fR
550 .ad
551 .sp .6
552 .RS 4n
553 Display the persistent link configuration.
554 .RE
555
556 .sp
557 .ne 2
558 .na
559 \fB\fB-s\fR, \fB--statistics\fR\fR
560 .ad
561 .sp .6
562 .RS 4n
563 Display link statistics.
564 .RE
565
566 .sp
567 .ne 2
568 .na
569 \fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
570 .ad
571 .sp .6
572 .RS 4n
573 Used with the \fB-s\fR option to specify an interval, in seconds, at which
574 statistics should be displayed. If this option is not specified, statistics
575 will be displayed only once.
576 .RE
577
578 .RE
579
580 .sp
581 .ne 2
582 .na
583 \fB\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR
584 \fInew-link\fR\fR
585 .ad
586 .sp .6
587 .RS 4n
588 Rename \fIlink\fR to \fInew-link\fR. This is used to give a link a meaningful
589 name, or to associate existing link configuration such as link properties of a
590 removed device with a new device. See the \fBEXAMPLES\fR section for specific
591 examples of how this subcommand is used.
592 .sp
593 .ne 2
594 .na
595 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
596 .ad
597 .sp .6
598 .RS 4n
599 See "Options," above.
600 .RE
601
602 .RE
603
604 .sp
605 .ne 2
606 .na
607 \fB\fBdladm delete-phys\fR \fIphys-link\fR\fR
608 .ad
609 .sp .6
610 .RS 4n
611 This command is used to delete the persistent configuration of a link
612 associated with physical hardware which has been removed from the system. See
613 the \fBEXAMPLES\fR section.
614 .RE
615
616 .sp
617 .ne 2
618 .na
619 \fB\fBdladm show-phys\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
620 [\fB-H\fR] [\fIphys-link\fR]\fR
621 .ad
622 .sp .6
623 .RS 4n
624 Show the physical device and attributes of all physical links, or of the named
625 physical link. Without \fB-P\fR, only physical links that are available on the
626 running system are displayed.
627 .sp
628 .ne 2
629 .na
630 \fB\fB-H\fR\fR
631 .ad
632 .sp .6
633 .RS 4n
634 Show hardware resource usage, as returned by the NIC driver. Output from
635 \fB-H\fR displays the following elements:
636 .sp
637 .ne 2
638 .na
639 \fB\fBLINK\fR\fR
640 .ad
641 .sp .6
642 .RS 4n
643 A physical device corresponding to a NIC driver.
644 .RE
645
646 .sp
647 .ne 2
648 .na
649 \fB\fBGROUP\fR\fR
650 .ad
651 .sp .6
652 .RS 4n
653 A collection of rings.
654 .RE
655
656 .sp
657 .ne 2
658 .na
659 \fB\fBGROUPTYPE\fR\fR
660 .ad
661 .sp .6
662 .RS 4n
663 RX or TX. All rings in a group are of the same group type.
664 .RE
665
666 .sp
667 .ne 2
668 .na
669 \fB\fBRINGS\fR\fR
670 .ad
671 .sp .6
672 .RS 4n
673 A hardware resource used by a data link, subject to assignment by a driver to
674 different groups.
675 .RE
676
677 .sp
678 .ne 2
679 .na
680 \fB\fBCLIENTS\fR\fR
681 .ad
682 .sp .6
683 .RS 4n
684 MAC clients that are using the rings within a group.
685 .RE
686
687 .RE
688
689 .sp
690 .ne 2
691 .na
692 \fB\fB-o\fR \fIfield\fR, \fB--output\fR=\fIfield\fR\fR
693 .ad
694 .sp .6
695 .RS 4n
696 A case-insensitive, comma-separated list of output fields to display. The field
697 name must be one of the fields listed below, or the special value \fBall\fR, to
698 display all fields. For each link, the following fields can be displayed:
699 .sp
700 .ne 2
701 .na
702 \fB\fBLINK\fR\fR
703 .ad
704 .sp .6
705 .RS 4n
706 The name of the datalink.
707 .RE
708
709 .sp
710 .ne 2
711 .na
712 \fB\fBMEDIA\fR\fR
713 .ad
714 .sp .6
715 .RS 4n
716 The media type provided by the physical datalink.
717 .RE
718
719 .sp
720 .ne 2
721 .na
722 \fB\fBSTATE\fR\fR
723 .ad
724 .sp .6
725 .RS 4n
726 The state of the link. This can be \fBup\fR, \fBdown\fR, or \fBunknown\fR.
727 .RE
728
729 .sp
730 .ne 2
731 .na
732 \fB\fBSPEED\fR\fR
733 .ad
734 .sp .6
735 .RS 4n
736 The current speed of the link, in megabits per second.
737 .RE
738
739 .sp
740 .ne 2
741 .na
742 \fB\fBDUPLEX\fR\fR
743 .ad
744 .sp .6
745 .RS 4n
746 For Ethernet links, the full/half duplex status of the link is displayed if the
747 link state is \fBup\fR. The duplex is displayed as \fBunknown\fR in all other
748 cases.
749 .RE
750
751 .sp
752 .ne 2
753 .na
754 \fB\fBDEVICE\fR\fR
755 .ad
756 .sp .6
757 .RS 4n
758 The name of the physical device under this link.
759 .RE
760
761 .RE
762
763 .sp
764 .ne 2
765 .na
766 \fB\fB-p\fR, \fB--parseable\fR\fR
767 .ad
768 .sp .6
769 .RS 4n
770 Display using a stable machine-parseable format. The \fB-o\fR option is
771 required with \fB-p\fR. See "Parseable Output Format", below.
772 .RE
773
774 .sp
775 .ne 2
776 .na
777 \fB\fB-P\fR, \fB--persistent\fR\fR
778 .ad
779 .sp .6
780 .RS 4n
781 This option displays persistent configuration for all links, including those
782 that have been removed from the system. The output provides a \fBFLAGS\fR
783 column in which the \fBr\fR flag indicates that the physical device associated
784 with a physical link has been removed. For such links, \fBdelete-phys\fR can be
785 used to purge the link's configuration from the system.
786 .RE
787
788 .RE
789
790 .sp
791 .ne 2
792 .na
793 \fB\fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR
794 \fIpolicy\fR] [\fB-L\fR \fImode\fR] [\fB-T\fR \fItime\fR] [\fB-u\fR
795 \fIaddress\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]
796 \fIaggr-link\fR\fR
797 .ad
798 .sp .6
799 .RS 4n
800 Combine a set of links into a single IEEE 802.3ad link aggregation named
801 \fIaggr-link\fR. The use of an integer \fIkey\fR to generate a link name for
802 the aggregation is also supported for backward compatibility. Many of the
803 \fB*\fR\fB-aggr\fR subcommands below also support the use of a \fIkey\fR to
804 refer to a given aggregation, but use of the aggregation link name is
805 preferred. See the \fBNOTES\fR section for more information on keys.
806 .sp
807 \fBdladm\fR supports a number of port selection policies for an aggregation of
808 ports. (See the description of the \fB-P\fR option, below.) If you do not
809 specify a policy, \fBcreate-aggr\fR uses the default, the L4 policy, described
810 under the \fB-P\fR option.
811 .sp
812 .ne 2
813 .na
814 \fB\fB-l\fR \fIether-link\fR, \fB--link\fR=\fIether-link\fR\fR
815 .ad
816 .sp .6
817 .RS 4n
818 Each Ethernet link (or port) in the aggregation is specified using an \fB-l\fR
819 option followed by the name of the link to be included in the aggregation.
820 Multiple links are included in the aggregation by specifying multiple \fB-l\fR
821 options. For backward compatibility with previous versions of Solaris, the
822 \fBdladm\fR command also supports the using the \fB-d\fR option (or
823 \fB--dev\fR) with a device name to specify links by their underlying device
824 name. The other \fB*\fR\fB-aggr\fR subcommands that take \fB-l\fRoptions also
825 accept \fB-d\fR.
826 .RE
827
828 .sp
829 .ne 2
830 .na
831 \fB\fB-t\fR, \fB--temporary\fR\fR
832 .ad
833 .sp .6
834 .RS 4n
835 Specifies that the aggregation is temporary. Temporary aggregations last until
836 the next reboot.
837 .RE
838
839 .sp
840 .ne 2
841 .na
842 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
843 .ad
844 .sp .6
845 .RS 4n
846 See "Options," above.
847 .RE
848
849 .sp
850 .ne 2
851 .na
852 \fB\fB-P\fR \fIpolicy\fR, \fB--policy\fR=\fIpolicy\fR\fR
853 .ad
854 .br
855 .na
856 \fB\fR
857 .ad
858 .sp .6
859 .RS 4n
860 Specifies the port selection policy to use for load spreading of outbound
861 traffic. The policy specifies which \fIdev\fR object is used to send packets. A
862 policy is a list of one or more layers specifiers separated by commas. A layer
863 specifier is one of the following:
864 .sp
865 .ne 2
866 .na
867 \fB\fBL2\fR\fR
868 .ad
869 .sp .6
870 .RS 4n
871 Select outbound device according to source and destination \fBMAC\fR addresses
872 of the packet.
873 .RE
874
875 .sp
876 .ne 2
877 .na
878 \fB\fBL3\fR\fR
879 .ad
880 .sp .6
881 .RS 4n
882 Select outbound device according to source and destination \fBIP\fR addresses
883 of the packet.
884 .RE
885
886 .sp
887 .ne 2
888 .na
889 \fB\fBL4\fR\fR
890 .ad
891 .sp .6
892 .RS 4n
893 Select outbound device according to the upper layer protocol information
894 contained in the packet. For \fBTCP\fR and \fBUDP\fR, this includes source and
895 destination ports. For IPsec, this includes the \fBSPI\fR (Security Parameters
896 Index).
897 .RE
898
899 For example, to use upper layer protocol information, the following policy can
900 be used:
901 .sp
902 .in +2
903 .nf
904 -P L4
905 .fi
906 .in -2
907 .sp
908
909 Note that policy L4 is the default.
910 .sp
911 To use the source and destination \fBMAC\fR addresses as well as the source and
912 destination \fBIP\fR addresses, the following policy can be used:
913 .sp
914 .in +2
915 .nf
916 -P L2,L3
917 .fi
918 .in -2
919 .sp
920
921 .RE
922
923 .sp
924 .ne 2
925 .na
926 \fB\fB-L\fR \fImode\fR, \fB--lacp-mode\fR=\fImode\fR\fR
927 .ad
928 .sp .6
929 .RS 4n
930 Specifies whether \fBLACP\fR should be used and, if used, the mode in which it
931 should operate. Supported values are \fBoff\fR, \fBactive\fR or \fBpassive\fR.
932 .RE
933
934 .sp
935 .ne 2
936 .na
937 \fB\fB-T\fR \fItime\fR, \fB--lacp-timer\fR=\fItime\fR\fR
938 .ad
939 .br
940 .na
941 \fB\fR
942 .ad
943 .sp .6
944 .RS 4n
945 Specifies the \fBLACP\fR timer value. The supported values are \fBshort\fR or
946 \fBlong\fRjjj.
947 .RE
948
949 .sp
950 .ne 2
951 .na
952 \fB\fB-u\fR \fIaddress\fR, \fB--unicast\fR=\fIaddress\fR\fR
953 .ad
954 .sp .6
955 .RS 4n
956 Specifies a fixed unicast hardware address to be used for the aggregation. If
957 this option is not specified, then an address is automatically chosen from the
958 set of addresses of the component devices.
959 .RE
960
961 .RE
962
963 .sp
964 .ne 2
965 .na
966 \fB\fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR
967 \fIpolicy\fR] [\fB-L\fR \fImode\fR] [\fB-T\fR \fItime\fR] [\fB-u\fR
968 \fIaddress\fR] \fIaggr-link\fR\fR
969 .ad
970 .sp .6
971 .RS 4n
972 Modify the parameters of the specified aggregation.
973 .sp
974 .ne 2
975 .na
976 \fB\fB-t\fR, \fB--temporary\fR\fR
977 .ad
978 .sp .6
979 .RS 4n
980 Specifies that the modification is temporary. Temporary aggregations last until
981 the next reboot.
982 .RE
983
984 .sp
985 .ne 2
986 .na
987 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
988 .ad
989 .sp .6
990 .RS 4n
991 See "Options," above.
992 .RE
993
994 .sp
995 .ne 2
996 .na
997 \fB\fB-P\fR \fIpolicy\fR, \fB--policy\fR=\fIpolicy\fR\fR
998 .ad
999 .sp .6
1000 .RS 4n
1001 Specifies the port selection policy to use for load spreading of outbound
1002 traffic. See \fBdladm create-aggr\fR for a description of valid policy values.
1003 .RE
1004
1005 .sp
1006 .ne 2
1007 .na
1008 \fB\fB-L\fR \fImode\fR, \fB--lacp-mode\fR=\fImode\fR\fR
1009 .ad
1010 .sp .6
1011 .RS 4n
1012 Specifies whether \fBLACP\fR should be used and, if used, the mode in which it
1013 should operate. Supported values are \fBoff\fR, \fBactive\fR, or \fBpassive\fR.
1014 .RE
1015
1016 .sp
1017 .ne 2
1018 .na
1019 \fB\fB-T\fR \fItime\fR, \fB--lacp-timer\fR=\fItime\fR\fR
1020 .ad
1021 .br
1022 .na
1023 \fB\fR
1024 .ad
1025 .sp .6
1026 .RS 4n
1027 Specifies the \fBLACP\fR timer value. The supported values are \fBshort\fR or
1028 \fBlong\fR.
1029 .RE
1030
1031 .sp
1032 .ne 2
1033 .na
1034 \fB\fB-u\fR \fIaddress\fR, \fB--unicast\fR=\fIaddress\fR\fR
1035 .ad
1036 .sp .6
1037 .RS 4n
1038 Specifies a fixed unicast hardware address to be used for the aggregation. If
1039 this option is not specified, then an address is automatically chosen from the
1040 set of addresses of the component devices.
1041 .RE
1042
1043 .RE
1044
1045 .sp
1046 .ne 2
1047 .na
1048 \fB\fBdladm delete-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
1049 \fIaggr-link\fR\fR
1050 .ad
1051 .sp .6
1052 .RS 4n
1053 Deletes the specified aggregation.
1054 .sp
1055 .ne 2
1056 .na
1057 \fB\fB-t\fR, \fB--temporary\fR\fR
1058 .ad
1059 .sp .6
1060 .RS 4n
1061 Specifies that the deletion is temporary. Temporary deletions last until the
1062 next reboot.
1063 .RE
1064
1065 .sp
1066 .ne 2
1067 .na
1068 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
1069 .ad
1070 .sp .6
1071 .RS 4n
1072 See "Options," above.
1073 .RE
1074
1075 .RE
1076
1077 .sp
1078 .ne 2
1079 .na
1080 \fB\fBdladm add-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
1081 \fIether-link1\fR [\fB--link\fR=\fIether-link2\fR...] \fIaggr-link\fR\fR
1082 .ad
1083 .sp .6
1084 .RS 4n
1085 Adds links to the specified aggregation.
1086 .sp
1087 .ne 2
1088 .na
1089 \fB\fB-l\fR \fIether-link\fR, \fB--link\fR=\fIether-link\fR\fR
1090 .ad
1091 .sp .6
1092 .RS 4n
1093 Specifies an Ethernet link to add to the aggregation. Multiple links can be
1094 added by supplying multiple \fB-l\fR options.
1095 .RE
1096
1097 .sp
1098 .ne 2
1099 .na
1100 \fB\fB-t\fR, \fB--temporary\fR\fR
1101 .ad
1102 .sp .6
1103 .RS 4n
1104 Specifies that the additions are temporary. Temporary additions last until the
1105 next reboot.
1106 .RE
1107
1108 .sp
1109 .ne 2
1110 .na
1111 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
1112 .ad
1113 .sp .6
1114 .RS 4n
1115 See "Options," above.
1116 .RE
1117
1118 .RE
1119
1120 .sp
1121 .ne 2
1122 .na
1123 \fB\fBdladm remove-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
1124 \fIether-link1\fR [\fB--l\fR=\fIether-link2\fR...] \fIaggr-link\fR\fR
1125 .ad
1126 .sp .6
1127 .RS 4n
1128 Removes links from the specified aggregation.
1129 .sp
1130 .ne 2
1131 .na
1132 \fB\fB-l\fR \fIether-link\fR, \fB--link\fR=\fIether-link\fR\fR
1133 .ad
1134 .sp .6
1135 .RS 4n
1136 Specifies an Ethernet link to remove from the aggregation. Multiple links can
1137 be added by supplying multiple \fB-l\fR options.
1138 .RE
1139
1140 .sp
1141 .ne 2
1142 .na
1143 \fB\fB-t\fR, \fB--temporary\fR\fR
1144 .ad
1145 .sp .6
1146 .RS 4n
1147 Specifies that the removals are temporary. Temporary removal last until the
1148 next reboot.
1149 .RE
1150
1151 .sp
1152 .ne 2
1153 .na
1154 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
1155 .ad
1156 .sp .6
1157 .RS 4n
1158 See "Options," above.
1159 .RE
1160
1161 .RE
1162
1163 .sp
1164 .ne 2
1165 .na
1166 \fB\fBdladm show-aggr\fR [\fB-PLx\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
1167 [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaggr-link\fR]\fR
1168 .ad
1169 .sp .6
1170 .RS 4n
1171 Show aggregation configuration (the default), \fBLACP\fR information, or
1172 statistics, either for all aggregations or for the specified aggregation.
1173 .sp
1174 By default (with no options), the following fields can be displayed:
1175 .sp
1176 .ne 2
1177 .na
1178 \fB\fBLINK\fR\fR
1179 .ad
1180 .sp .6
1181 .RS 4n
1182 The name of the aggregation link.
1183 .RE
1184
1185 .sp
1186 .ne 2
1187 .na
1188 \fB\fBPOLICY\fR\fR
1189 .ad
1190 .sp .6
1191 .RS 4n
1192 The LACP policy of the aggregation. See the \fBcreate-aggr\fR \fB-P\fR option
1193 for a description of the possible values.
1194 .RE
1195
1196 .sp
1197 .ne 2
1198 .na
1199 \fB\fBADDRPOLICY\fR\fR
1200 .ad
1201 .sp .6
1202 .RS 4n
1203 Either \fBauto\fR, if the aggregation is configured to automatically configure
1204 its unicast MAC address (the default if the \fB-u\fR option was not used to
1205 create or modify the aggregation), or \fBfixed\fR, if \fB-u\fR was used to set
1206 a fixed MAC address.
1207 .RE
1208
1209 .sp
1210 .ne 2
1211 .na
1212 \fB\fBLACPACTIVITY\fR\fR
1213 .ad
1214 .sp .6
1215 .RS 4n
1216 The LACP mode of the aggregation. Possible values are \fBoff\fR, \fBactive\fR,
1217 or \fBpassive\fR, as set by the \fB-l\fR option to \fBcreate-aggr\fR or
1218 \fBmodify-aggr\fR.
1219 .RE
1220
1221 .sp
1222 .ne 2
1223 .na
1224 \fB\fBLACPTIMER\fR\fR
1225 .ad
1226 .sp .6
1227 .RS 4n
1228 The LACP timer value of the aggregation as set by the \fB-T\fR option of
1229 \fBcreate-aggr\fR or \fBmodify-aggr\fR.
1230 .RE
1231
1232 .sp
1233 .ne 2
1234 .na
1235 \fB\fBFLAGS\fR\fR
1236 .ad
1237 .sp .6
1238 .RS 4n
1239 A set of state flags associated with the aggregation. The only possible flag is
1240 \fBf\fR, which is displayed if the administrator forced the creation the
1241 aggregation using the \fB-f\fR option to \fBcreate-aggr\fR. Other flags might
1242 be defined in the future.
1243 .RE
1244
1245 The \fBshow-aggr\fR command accepts the following options:
1246 .sp
1247 .ne 2
1248 .na
1249 \fB\fB-L\fR, \fB--lacp\fR\fR
1250 .ad
1251 .sp .6
1252 .RS 4n
1253 Displays detailed \fBLACP\fR information for the aggregation link and each
1254 underlying port. Most of the state information displayed by this option is
1255 defined by IEEE 802.3. With this option, the following fields can be displayed:
1256 .sp
1257 .ne 2
1258 .na
1259 \fB\fBLINK\fR\fR
1260 .ad
1261 .sp .6
1262 .RS 4n
1263 The name of the aggregation link.
1264 .RE
1265
1266 .sp
1267 .ne 2
1268 .na
1269 \fB\fBPORT\fR\fR
1270 .ad
1271 .sp .6
1272 .RS 4n
1273 The name of one of the underlying aggregation ports.
1274 .RE
1275
1276 .sp
1277 .ne 2
1278 .na
1279 \fB\fBAGGREGATABLE\fR\fR
1280 .ad
1281 .sp .6
1282 .RS 4n
1283 Whether the port can be added to the aggregation.
1284 .RE
1285
1286 .sp
1287 .ne 2
1288 .na
1289 \fB\fBSYNC\fR\fR
1290 .ad
1291 .sp .6
1292 .RS 4n
1293 If \fByes\fR, the system considers the port to be synchronized and part of the
1294 aggregation.
1295 .RE
1296
1297 .sp
1298 .ne 2
1299 .na
1300 \fB\fBCOLL\fR\fR
1301 .ad
1302 .sp .6
1303 .RS 4n
1304 If \fByes\fR, collection of incoming frames is enabled on the associated port.
1305 .RE
1306
1307 .sp
1308 .ne 2
1309 .na
1310 \fB\fBDIST\fR\fR
1311 .ad
1312 .sp .6
1313 .RS 4n
1314 If \fByes\fR, distribution of outgoing frames is enabled on the associated
1315 port.
1316 .RE
1317
1318 .sp
1319 .ne 2
1320 .na
1321 \fB\fBDEFAULTED\fR\fR
1322 .ad
1323 .sp .6
1324 .RS 4n
1325 If \fByes\fR, the port is using defaulted partner information (that is, has not
1326 received LACP data from the LACP partner).
1327 .RE
1328
1329 .sp
1330 .ne 2
1331 .na
1332 \fB\fBEXPIRED\fR\fR
1333 .ad
1334 .sp .6
1335 .RS 4n
1336 If \fByes\fR, the receive state of the port is in the \fBEXPIRED\fR state.
1337 .RE
1338
1339 .RE
1340
1341 .sp
1342 .ne 2
1343 .na
1344 \fB\fB-x\fR, \fB--extended\fR\fR
1345 .ad
1346 .sp .6
1347 .RS 4n
1348 Display additional aggregation information including detailed information on
1349 each underlying port. With \fB-x\fR, the following fields can be displayed:
1350 .sp
1351 .ne 2
1352 .na
1353 \fB\fBLINK\fR\fR
1354 .ad
1355 .sp .6
1356 .RS 4n
1357 The name of the aggregation link.
1358 .RE
1359
1360 .sp
1361 .ne 2
1362 .na
1363 \fB\fBPORT\fR\fR
1364 .ad
1365 .sp .6
1366 .RS 4n
1367 The name of one of the underlying aggregation ports.
1368 .RE
1369
1370 .sp
1371 .ne 2
1372 .na
1373 \fB\fBSPEED\fR\fR
1374 .ad
1375 .sp .6
1376 .RS 4n
1377 The speed of the link or port in megabits per second.
1378 .RE
1379
1380 .sp
1381 .ne 2
1382 .na
1383 \fB\fBDUPLEX\fR\fR
1384 .ad
1385 .sp .6
1386 .RS 4n
1387 The full/half duplex status of the link or port is displayed if the link state
1388 is \fBup\fR. The duplex status is displayed as \fBunknown\fR in all other
1389 cases.
1390 .RE
1391
1392 .sp
1393 .ne 2
1394 .na
1395 \fB\fBSTATE\fR\fR
1396 .ad
1397 .sp .6
1398 .RS 4n
1399 The link state. This can be \fBup\fR, \fBdown\fR, or \fBunknown\fR.
1400 .RE
1401
1402 .sp
1403 .ne 2
1404 .na
1405 \fB\fBADDRESS\fR\fR
1406 .ad
1407 .sp .6
1408 .RS 4n
1409 The MAC address of the link or port.
1410 .RE
1411
1412 .sp
1413 .ne 2
1414 .na
1415 \fB\fBPORTSTATE\fR\fR
1416 .ad
1417 .sp .6
1418 .RS 4n
1419 This indicates whether the individual aggregation port is in the \fBstandby\fR
1420 or \fBattached\fR state.
1421 .RE
1422
1423 .RE
1424
1425 .sp
1426 .ne 2
1427 .na
1428 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
1429 .ad
1430 .sp .6
1431 .RS 4n
1432 A case-insensitive, comma-separated list of output fields to display. The field
1433 name must be one of the fields listed above, or the special value \fBall\fR, to
1434 display all fields. The fields applicable to the \fB-o\fR option are limited to
1435 those listed under each output mode. For example, if using \fB-L\fR, only the
1436 fields listed under \fB-L\fR, above, can be used with \fB-o\fR.
1437 .RE
1438
1439 .sp
1440 .ne 2
1441 .na
1442 \fB\fB-p\fR, \fB--parseable\fR\fR
1443 .ad
1444 .sp .6
1445 .RS 4n
1446 Display using a stable machine-parseable format. The \fB-o\fR option is
1447 required with \fB-p\fR. See "Parseable Output Format", below.
1448 .RE
1449
1450 .sp
1451 .ne 2
1452 .na
1453 \fB\fB-P\fR, \fB--persistent\fR\fR
1454 .ad
1455 .sp .6
1456 .RS 4n
1457 Display the persistent aggregation configuration rather than the state of the
1458 running system.
1459 .RE
1460
1461 .sp
1462 .ne 2
1463 .na
1464 \fB\fB-s\fR, \fB--statistics\fR\fR
1465 .ad
1466 .sp .6
1467 .RS 4n
1468 Displays aggregation statistics.
1469 .RE
1470
1471 .sp
1472 .ne 2
1473 .na
1474 \fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
1475 .ad
1476 .sp .6
1477 .RS 4n
1478 Used with the \fB-s\fR option to specify an interval, in seconds, at which
1479 statistics should be displayed. If this option is not specified, statistics
1480 will be displayed only once.
1481 .RE
1482
1483 .RE
1484
1485 .sp
1486 .ne 2
1487 .na
1488 \fB\fBdladm create-bridge\fR [ \fB-P\fR \fIprotect\fR] [\fB-R\fR
1489 \fIroot-dir\fR] [ \fB-p\fR \fIpriority\fR] [ \fB-m\fR \fImax-age\fR] [ \fB-h\fR
1490 \fIhello-time\fR] [ \fB-d\fR \fIforward-delay\fR] [ \fB-f\fR
1491 \fIforce-protocol\fR] [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR\fR
1492 .ad
1493 .sp .6
1494 .RS 4n
1495 Create an 802.1D bridge instance and optionally assign one or more network
1496 links to the new bridge. By default, no bridge instances are present on the
1497 system.
1498 .sp
1499 In order to bridge between links, you must create at least one bridge instance.
1500 Each bridge instance is separate, and there is no forwarding connection between
1501 bridges.
1502 .sp
1503 .ne 2
1504 .na
1505 \fB\fB-P\fR \fIprotect\fR, \fB--protect\fR=\fIprotect\fR\fR
1506 .ad
1507 .sp .6
1508 .RS 4n
1509 Specifies a protection method. The defined protection methods are \fBstp\fR for
1510 the Spanning Tree Protocol and trill for \fBTRILL\fR, which is used on
1511 RBridges. The default value is \fBstp\fR.
1512 .RE
1513
1514 .sp
1515 .ne 2
1516 .na
1517 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
1518 .ad
1519 .sp .6
1520 .RS 4n
1521 See "Options," above.
1522 .RE
1523
1524 .sp
1525 .ne 2
1526 .na
1527 \fB\fB-p\fR \fIpriority\fR, \fB--priority\fR=\fIpriority\fR\fR
1528 .ad
1529 .sp .6
1530 .RS 4n
1531 Specifies the Bridge Priority. This sets the IEEE STP priority value for
1532 determining the root bridge node in the network. The default value is
1533 \fB32768\fR. Valid values are \fB0\fR (highest priority) to \fB61440\fR (lowest
1534 priority), in increments of 4096.
1535 .sp
1536 If a value not evenly divisible by 4096 is used, the system silently rounds
1537 downward to the next lower value that is divisible by 4096.
1538 .RE
1539
1540 .sp
1541 .ne 2
1542 .na
1543 \fB\fB-m\fR \fImax-age\fR, \fB--max-age\fR=\fImax-age\fR\fR
1544 .ad
1545 .sp .6
1546 .RS 4n
1547 Specifies the maximum age for configuration information in seconds. This sets
1548 the STP Bridge Max Age parameter. This value is used for all nodes in the
1549 network if this node is the root bridge. Bridge link information older than
1550 this time is discarded. It defaults to 20 seconds. Valid values are from 6 to
1551 40 seconds. See the \fB-d\fR \fIforward-delay\fR parameter for additional
1552 constraints.
1553 .RE
1554
1555 .sp
1556 .ne 2
1557 .na
1558 \fB\fB-h\fR \fIhello-time\fR, \fB--hello-time\fR=\fIhello-time\fR\fR
1559 .ad
1560 .sp .6
1561 .RS 4n
1562 Specifies the STP Bridge Hello Time parameter. When this node is the root node,
1563 it sends Configuration BPDUs at this interval throughout the network. The
1564 default value is 2 seconds. Valid values are from 1 to 10 seconds. See the
1565 \fB-d\fR \fIforward-delay\fR parameter for additional constraints.
1566 .RE
1567
1568 .sp
1569 .ne 2
1570 .na
1571 \fB\fB-d\fR \fIforward-delay\fR, \fB--forward-delay\fR=\fIforward-delay\fR\fR
1572 .ad
1573 .sp .6
1574 .RS 4n
1575 Specifies the STP Bridge Forward Delay parameter. When this node is the root
1576 node, then all bridges in the network use this timer to sequence the link
1577 states when a port is enabled. The default value is 15 seconds. Valid values
1578 are from 4 to 30 seconds.
1579 .sp
1580 Bridges must obey the following two constraints:
1581 .sp
1582 .in +2
1583 .nf
1584 2 * (\fIforward-delay\fR - 1.0) >= \fImax-age\fR
1585
1586 \fImax-age\fR >= 2 * (\fIhello-time\fR + 1.0)
1587 .fi
1588 .in -2
1589 .sp
1590
1591 Any parameter setting that would violate those constraints is treated as an
1592 error and causes the command to fail with a diagnostic message. The message
1593 provides valid alternatives to the supplied values.
1594 .RE
1595
1596 .sp
1597 .ne 2
1598 .na
1599 \fB\fB-f\fR \fIforce-protocol\fR,
1600 \fB--force-protocol\fR=\fIforce-protocol\fR\fR
1601 .ad
1602 .sp .6
1603 .RS 4n
1604 Specifies the MSTP forced maximum supported protocol. The default value is 3.
1605 Valid values are non-negative integers. The current implementation does not
1606 support RSTP or MSTP, so this currently has no effect. However, to prevent MSTP
1607 from being used in the future, the parameter may be set to \fB0\fR for STP only
1608 or \fB2\fR for STP and RSTP.
1609 .RE
1610
1611 .sp
1612 .ne 2
1613 .na
1614 \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR
1615 .ad
1616 .sp .6
1617 .RS 4n
1618 Specifies one or more links to add to the newly-created bridge. This is similar
1619 to creating the bridge and then adding one or more links, as with the
1620 \fBadd-bridge\fR subcommand. However, if any of the links cannot be added, the
1621 entire command fails, and the new bridge itself is not created. To add multiple
1622 links on the same command line, repeat this option for each link. You are
1623 permitted to create bridges without links. For more information about link
1624 assignments, see the \fBadd-bridge\fR subcommand.
1625 .RE
1626
1627 Bridge creation and link assignment require the \fBPRIV_SYS_DL_CONFIG\fR
1628 privilege. Bridge creation might fail if the optional bridging feature is not
1629 installed on the system.
1630 .RE
1631
1632 .sp
1633 .ne 2
1634 .na
1635 \fB\fBdladm modify-bridge\fR [ \fB-P\fR \fIprotect\fR] [\fB-R\fR
1636 \fIroot-dir\fR] [ \fB-p\fR \fIpriority\fR] [ \fB-m\fR \fImax-age\fR] [ \fB-h\fR
1637 \fIhello-time\fR] [ \fB-d\fR \fIforward-delay\fR] [ \fB-f\fR
1638 \fIforce-protocol\fR] [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR\fR
1639 .ad
1640 .sp .6
1641 .RS 4n
1642 Modify the operational parameters of an existing bridge. The options are the
1643 same as for the \fBcreate-bridge\fR subcommand, except that the \fB-l\fR option
1644 is not permitted. To add links to an existing bridge, use the \fBadd-bridge\fR
1645 subcommand.
1646 .sp
1647 Bridge parameter modification requires the \fBPRIV_SYS_DL_CONFIG\fR privilege.
1648 .RE
1649
1650 .sp
1651 .ne 2
1652 .na
1653 \fB\fBdladm delete-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fIbridge-name\fR\fR
1654 .ad
1655 .sp .6
1656 .RS 4n
1657 Delete a bridge instance. The bridge being deleted must not have any attached
1658 links. Use the \fBremove-bridge\fR subcommand to deactivate links before
1659 deleting a bridge.
1660 .sp
1661 Bridge deletion requires the \fBPRIV_SYS_DL_CONFIG\fR privilege.
1662 .sp
1663 The \fB-R\fR (\fB--root-dir\fR) option is the same as for the
1664 \fBcreate-bridge\fR subcommand.
1665 .RE
1666
1667 .sp
1668 .ne 2
1669 .na
1670 \fB\fBdladm add-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR
1671 [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR\fR
1672 .ad
1673 .sp .6
1674 .RS 4n
1675 Add one or more links to an existing bridge. If multiple links are specified,
1676 and adding any one of them results in an error, the command fails and no
1677 changes are made to the system.
1678 .sp
1679 Link addition to a bridge requires the \fBPRIV_SYS_DL_CONFIG\fR privilege.
1680 .sp
1681 A link may be a member of at most one bridge. An error occurs when you attempt
1682 to add a link that already belongs to another bridge. To move a link from one
1683 bridge instance to another, remove it from the current bridge before adding it
1684 to a new one.
1685 .sp
1686 The links assigned to a bridge must not also be VLANs, VNICs, or tunnels. Only
1687 physical Ethernet datalinks, aggregation datalinks, wireless links, and
1688 Ethernet stubs are permitted to be assigned to a bridge.
1689 .sp
1690 Links assigned to a bridge must all have the same MTU. This is checked when the
1691 link is assigned. The link is added to the bridge in a deactivated form if it
1692 is not the first link on the bridge and it has a differing MTU.
1693 .sp
1694 Note that systems using bridging should not set the \fBeeprom\fR(1M)
1695 \fBlocal-mac-address?\fR variable to false.
1696 .sp
1697 The options are the same as for the \fBcreate-bridge\fR subcommand.
1698 .RE
1699
1700 .sp
1701 .ne 2
1702 .na
1703 \fB\fBdladm remove-bridge\fR [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR
1704 [\fB-l\fR \fIlink\fR...] \fIbridge-name\fR\fR
1705 .ad
1706 .sp .6
1707 .RS 4n
1708 Remove one or more links from a bridge instance. If multiple links are
1709 specified, and removing any one of them would result in an error, the command
1710 fails and none are removed.
1711 .sp
1712 Link removal from a bridge requires the \fBPRIV_SYS_DL_CONFIG\fR privilege.
1713 .sp
1714 The options are the same as for the \fBcreate-bridge\fR subcommand.
1715 .RE
1716
1717 .sp
1718 .ne 2
1719 .na
1720 \fB\fBdladm show-bridge\fR [\fB-flt\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
1721 [[\fB-p\fR] \fB-o\fR \fIfield\fR,...] [\fIbridge-name\fR]\fR
1722 .ad
1723 .sp .6
1724 .RS 4n
1725 Show the running status and configuration of bridges, their attached links,
1726 learned forwarding entries, and \fBTRILL\fR nickname databases. When showing
1727 overall bridge status and configuration, the bridge name can be omitted to show
1728 all bridges. The other forms require a specified bridge.
1729 .sp
1730 The show-bridge subcommand accepts the following options:
1731 .sp
1732 .ne 2
1733 .na
1734 \fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
1735 .ad
1736 .sp .6
1737 .RS 4n
1738 Used with the \fB-s\fR option to specify an interval, in seconds, at which
1739 statistics should be displayed. If this option is not specified, statistics
1740 will be displayed only once.
1741 .RE
1742
1743 .sp
1744 .ne 2
1745 .na
1746 \fB\fB-s\fR, \fB--statistics\fR\fR
1747 .ad
1748 .sp .6
1749 .RS 4n
1750 Display statistics for the specified bridges or for a given bridge's attached
1751 links. This option cannot be used with the \fB-f\fR and \fB-t\fR options.
1752 .RE
1753
1754 .sp
1755 .ne 2
1756 .na
1757 \fB\fB-p\fR, \fB--parseable\fR\fR
1758 .ad
1759 .sp .6
1760 .RS 4n
1761 Display using a stable machine-parsable format. See "Parsable Output Format,"
1762 below.
1763 .RE
1764
1765 .sp
1766 .ne 2
1767 .na
1768 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
1769 .ad
1770 .sp .6
1771 .RS 4n
1772 A case-insensitive, comma-separated list of output fields to display. The field
1773 names are described below. The special value all displays all fields. Each set
1774 of fields has its own default set to display when \fB-o\fR is not specified.
1775 .RE
1776
1777 By default, the \fBshow-bridge\fR subcommand shows bridge configuration. The
1778 following fields can be shown:
1779 .sp
1780 .ne 2
1781 .na
1782 \fB\fBBRIDGE\fR\fR
1783 .ad
1784 .sp .6
1785 .RS 4n
1786 The name of the bridge.
1787 .RE
1788
1789 .sp
1790 .ne 2
1791 .na
1792 \fB\fBADDRESS\fR\fR
1793 .ad
1794 .sp .6
1795 .RS 4n
1796 The Bridge Unique Identifier value (MAC address).
1797 .RE
1798
1799 .sp
1800 .ne 2
1801 .na
1802 \fB\fBPRIORITY\fR\fR
1803 .ad
1804 .sp .6
1805 .RS 4n
1806 Configured priority value; set by \fB-p\fR with \fBcreate-bridge\fR and
1807 \fBmodify-bridge\fR.
1808 .RE
1809
1810 .sp
1811 .ne 2
1812 .na
1813 \fB\fBBMAXAGE\fR\fR
1814 .ad
1815 .sp .6
1816 .RS 4n
1817 Configured bridge maximum age; set by \fB-m\fR with \fBcreate-bridge\fR and
1818 \fBmodify-bridge\fR.
1819 .RE
1820
1821 .sp
1822 .ne 2
1823 .na
1824 \fB\fBBHELLOTIME\fR\fR
1825 .ad
1826 .sp .6
1827 .RS 4n
1828 Configured bridge hello time; set by \fB-h\fR with \fBcreate-bridge\fR and
1829 \fBmodify-bridge\fR.
1830 .RE
1831
1832 .sp
1833 .ne 2
1834 .na
1835 \fB\fBBFWDDELAY\fR\fR
1836 .ad
1837 .sp .6
1838 .RS 4n
1839 Configured forwarding delay; set by \fB-d\fR with \fBcreate-bridge\fR and
1840 \fBmodify-bridge\fR.
1841 .RE
1842
1843 .sp
1844 .ne 2
1845 .na
1846 \fB\fBFORCEPROTO\fR\fR
1847 .ad
1848 .sp .6
1849 .RS 4n
1850 Configured forced maximum protocol; set by \fB-f\fR with \fBcreate-bridge\fR
1851 and \fBmodify-bridge\fR.
1852 .RE
1853
1854 .sp
1855 .ne 2
1856 .na
1857 \fB\fBTCTIME\fR\fR
1858 .ad
1859 .sp .6
1860 .RS 4n
1861 Time, in seconds, since last topology change.
1862 .RE
1863
1864 .sp
1865 .ne 2
1866 .na
1867 \fB\fBTCCOUNT\fR\fR
1868 .ad
1869 .sp .6
1870 .RS 4n
1871 Count of the number of topology changes.
1872 .RE
1873
1874 .sp
1875 .ne 2
1876 .na
1877 \fB\fBTCHANGE\fR\fR
1878 .ad
1879 .sp .6
1880 .RS 4n
1881 This indicates that a topology change was detected.
1882 .RE
1883
1884 .sp
1885 .ne 2
1886 .na
1887 \fB\fBDESROOT\fR\fR
1888 .ad
1889 .sp .6
1890 .RS 4n
1891 Bridge Identifier of the root node.
1892 .RE
1893
1894 .sp
1895 .ne 2
1896 .na
1897 \fB\fBROOTCOST\fR\fR
1898 .ad
1899 .sp .6
1900 .RS 4n
1901 Cost of the path to the root node.
1902 .RE
1903
1904 .sp
1905 .ne 2
1906 .na
1907 \fB\fBROOTPORT\fR\fR
1908 .ad
1909 .sp .6
1910 .RS 4n
1911 Port number used to reach the root node.
1912 .RE
1913
1914 .sp
1915 .ne 2
1916 .na
1917 \fB\fBMAXAGE\fR\fR
1918 .ad
1919 .sp .6
1920 .RS 4n
1921 Maximum age value from the root node.
1922 .RE
1923
1924 .sp
1925 .ne 2
1926 .na
1927 \fB\fBHELLOTIME\fR\fR
1928 .ad
1929 .sp .6
1930 .RS 4n
1931 Hello time value from the root node.
1932 .RE
1933
1934 .sp
1935 .ne 2
1936 .na
1937 \fB\fBFWDDELAY\fR\fR
1938 .ad
1939 .sp .6
1940 .RS 4n
1941 Forward delay value from the root node.
1942 .RE
1943
1944 .sp
1945 .ne 2
1946 .na
1947 \fB\fBHOLDTIME\fR\fR
1948 .ad
1949 .sp .6
1950 .RS 4n
1951 Minimum BPDU interval.
1952 .RE
1953
1954 By default, when the \fB-o\fR option is not specified, only the \fBBRIDGE\fR,
1955 \fBADDRESS\fR, \fBPRIORITY\fR, and \fBDESROOT\fR fields are shown.
1956 .sp
1957 When the \fB-s\fR option is specified, the \fBshow-bridge\fR subcommand shows
1958 bridge statistics. The following fields can be shown:
1959 .sp
1960 .ne 2
1961 .na
1962 \fB\fBBRIDGE\fR\fR
1963 .ad
1964 .sp .6
1965 .RS 4n
1966 Bridge name.
1967 .RE
1968
1969 .sp
1970 .ne 2
1971 .na
1972 \fB\fBDROPS\fR\fR
1973 .ad
1974 .sp .6
1975 .RS 4n
1976 Number of packets dropped due to resource problems.
1977 .RE
1978
1979 .sp
1980 .ne 2
1981 .na
1982 \fB\fBFORWARDS\fR\fR
1983 .ad
1984 .sp .6
1985 .RS 4n
1986 Number of packets forwarded from one link to another.
1987 .RE
1988
1989 .sp
1990 .ne 2
1991 .na
1992 \fB\fBMBCAST\fR\fR
1993 .ad
1994 .sp .6
1995 .RS 4n
1996 Number of multicast and broadcast packets handled by the bridge.
1997 .RE
1998
1999 .sp
2000 .ne 2
2001 .na
2002 \fB\fBRECV\fR\fR
2003 .ad
2004 .sp .6
2005 .RS 4n
2006 Number of packets received on all attached links.
2007 .RE
2008
2009 .sp
2010 .ne 2
2011 .na
2012 \fB\fBSENT\fR\fR
2013 .ad
2014 .sp .6
2015 .RS 4n
2016 Number of packets sent on all attached links.
2017 .RE
2018
2019 .sp
2020 .ne 2
2021 .na
2022 \fB\fBUNKNOWN\fR\fR
2023 .ad
2024 .sp .6
2025 .RS 4n
2026 Number of packets handled that have an unknown destination. Such packets are
2027 sent to all links.
2028 .RE
2029
2030 By default, when the \fB-o\fR option is not specified, only the \fBBRIDGE\fR,
2031 \fBDROPS\fR, and \fBFORWARDS\fR fields are shown.
2032 .sp
2033 The \fBshow-bridge\fR subcommand also accepts the following options:
2034 .sp
2035 .ne 2
2036 .na
2037 \fB\fB-l\fR, \fB--link\fR\fR
2038 .ad
2039 .sp .6
2040 .RS 4n
2041 Displays link-related status and statistics information for all links attached
2042 to a single bridge instance. By using this option and without the \fB-s\fR
2043 option, the following fields can be displayed for each link:
2044 .sp
2045 .ne 2
2046 .na
2047 \fB\fBLINK\fR\fR
2048 .ad
2049 .sp .6
2050 .RS 4n
2051 The link name.
2052 .RE
2053
2054 .sp
2055 .ne 2
2056 .na
2057 \fB\fBINDEX\fR\fR
2058 .ad
2059 .sp .6
2060 .RS 4n
2061 Port (link) index number on the bridge.
2062 .RE
2063
2064 .sp
2065 .ne 2
2066 .na
2067 \fB\fBSTATE\fR\fR
2068 .ad
2069 .sp .6
2070 .RS 4n
2071 State of the link. The state can be \fBdisabled\fR, \fBdiscarding\fR,
2072 \fBlearning\fR, \fBforwarding\fR, \fBnon-stp\fR, or \fBbad-mtu\fR.
2073 .RE
2074
2075 .sp
2076 .ne 2
2077 .na
2078 \fB\fBUPTIME\fR\fR
2079 .ad
2080 .sp .6
2081 .RS 4n
2082 Number of seconds since the last reset or initialization.
2083 .RE
2084
2085 .sp
2086 .ne 2
2087 .na
2088 \fB\fBOPERCOST\fR\fR
2089 .ad
2090 .sp .6
2091 .RS 4n
2092 Actual cost in use (1-65535).
2093 .RE
2094
2095 .sp
2096 .ne 2
2097 .na
2098 \fB\fBOPERP2P\fR\fR
2099 .ad
2100 .sp .6
2101 .RS 4n
2102 This indicates whether point-to-point (\fBP2P\fR) mode been detected.
2103 .RE
2104
2105 .sp
2106 .ne 2
2107 .na
2108 \fB\fBOPEREDGE\fR\fR
2109 .ad
2110 .sp .6
2111 .RS 4n
2112 This indicates whether edge mode has been detected.
2113 .RE
2114
2115 .sp
2116 .ne 2
2117 .na
2118 \fB\fBDESROOT\fR\fR
2119 .ad
2120 .sp .6
2121 .RS 4n
2122 The Root Bridge Identifier that has been seen on this port.
2123 .RE
2124
2125 .sp
2126 .ne 2
2127 .na
2128 \fB\fBDESCOST\fR\fR
2129 .ad
2130 .sp .6
2131 .RS 4n
2132 Path cost to the network root node through the designated port.
2133 .RE
2134
2135 .sp
2136 .ne 2
2137 .na
2138 \fB\fBDESBRIDGE\fR\fR
2139 .ad
2140 .sp .6
2141 .RS 4n
2142 Bridge Identifier for this port.
2143 .RE
2144
2145 .sp
2146 .ne 2
2147 .na
2148 \fB\fBDESPORT\fR\fR
2149 .ad
2150 .sp .6
2151 .RS 4n
2152 The ID and priority of the port used to transmit configuration messages for
2153 this port.
2154 .RE
2155
2156 .sp
2157 .ne 2
2158 .na
2159 \fB\fBTCACK\fR\fR
2160 .ad
2161 .sp .6
2162 .RS 4n
2163 This indicates whether Topology Change Acknowledge has been seen.
2164 .RE
2165
2166 When the \fB-l\fR option is specified without the \fB-o\fR option, only the
2167 \fBLINK\fR, \fBSTATE\fR, \fBUPTIME\fR, and \fBDESROOT\fR fields are shown.
2168 .sp
2169 When the \fB-l\fR option is specified, the \fB-s\fR option can be used to
2170 display the following fields for each link:
2171 .sp
2172 .ne 2
2173 .na
2174 \fB\fBLINK\fR\fR
2175 .ad
2176 .sp .6
2177 .RS 4n
2178 Link name.
2179 .RE
2180
2181 .sp
2182 .ne 2
2183 .na
2184 \fB\fBCFGBPDU\fR\fR
2185 .ad
2186 .sp .6
2187 .RS 4n
2188 Number of configuration BPDUs received.
2189 .RE
2190
2191 .sp
2192 .ne 2
2193 .na
2194 \fB\fBTCNBPDU\fR\fR
2195 .ad
2196 .sp .6
2197 .RS 4n
2198 Number of topology change BPDUs received.
2199 .RE
2200
2201 .sp
2202 .ne 2
2203 .na
2204 \fB\fBRSTPBPDU\fR\fR
2205 .ad
2206 .sp .6
2207 .RS 4n
2208 Number of Rapid Spanning Tree BPDUs received.
2209 .RE
2210
2211 .sp
2212 .ne 2
2213 .na
2214 \fB\fBTXBPDU\fR\fR
2215 .ad
2216 .sp .6
2217 .RS 4n
2218 Number of BPDUs transmitted.
2219 .RE
2220
2221 .sp
2222 .ne 2
2223 .na
2224 \fB\fBDROPS\fR\fR
2225 .ad
2226 .sp .6
2227 .RS 4n
2228 Number of packets dropped due to resource problems.
2229 .RE
2230
2231 .sp
2232 .ne 2
2233 .na
2234 \fB\fBRECV\fR\fR
2235 .ad
2236 .sp .6
2237 .RS 4n
2238 Number of packets received by the bridge.
2239 .RE
2240
2241 .sp
2242 .ne 2
2243 .na
2244 \fB\fBXMIT\fR\fR
2245 .ad
2246 .sp .6
2247 .RS 4n
2248 Number of packets sent by the bridge.
2249 .RE
2250
2251 When the \fB-o\fR option is not specified, only the \fBLINK\fR, \fBDROPS\fR,
2252 \fBRECV\fR, and \fBXMIT\fR fields are shown.
2253 .RE
2254
2255 .sp
2256 .ne 2
2257 .na
2258 \fB\fB-f\fR, \fB--forwarding\fR\fR
2259 .ad
2260 .sp .6
2261 .RS 4n
2262 Displays forwarding entries for a single bridge instance. With this option, the
2263 following fields can be shown for each forwarding entry:
2264 .sp
2265 .ne 2
2266 .na
2267 \fB\fBDEST\fR\fR
2268 .ad
2269 .sp .6
2270 .RS 4n
2271 Destination MAC address.
2272 .RE
2273
2274 .sp
2275 .ne 2
2276 .na
2277 \fB\fBAGE\fR\fR
2278 .ad
2279 .sp .6
2280 .RS 4n
2281 Age of entry in seconds and milliseconds. Omitted for local entries.
2282 .RE
2283
2284 .sp
2285 .ne 2
2286 .na
2287 \fB\fBFLAGS\fR\fR
2288 .ad
2289 .sp .6
2290 .RS 4n
2291 The \fBL\fR (local) flag is shown if the MAC address belongs to an attached
2292 link or to a VNIC on one of the attached links.
2293 .RE
2294
2295 .sp
2296 .ne 2
2297 .na
2298 \fB\fBOUTPUT\fR\fR
2299 .ad
2300 .sp .6
2301 .RS 4n
2302 For local entries, this is the name of the attached link that has the MAC
2303 address. Otherwise, for bridges that use Spanning Tree Protocol, this is the
2304 output interface name. For RBridges, this is the output \fBTRILL\fR nickname.
2305 .RE
2306
2307 When the \fB-o\fR option is not specified, the \fBDEST\fR, \fBAGE\fR,
2308 \fBFLAGS\fR, and \fBOUTPUT\fR fields are shown.
2309 .RE
2310
2311 .sp
2312 .ne 2
2313 .na
2314 \fB\fB-t\fR, \fB--trill\fR\fR
2315 .ad
2316 .sp .6
2317 .RS 4n
2318 Displays \fBTRILL\fR nickname entries for a single bridge instance. With this
2319 option, the following fields can be shown for each \fBTRILL\fR nickname entry:
2320 .sp
2321 .ne 2
2322 .na
2323 \fB\fBNICK\fR\fR
2324 .ad
2325 .sp .6
2326 .RS 4n
2327 \fBTRILL\fR nickname for this RBridge, which is a number from 1 to 65535.
2328 .RE
2329
2330 .sp
2331 .ne 2
2332 .na
2333 \fB\fBFLAGS\fR\fR
2334 .ad
2335 .sp .6
2336 .RS 4n
2337 The \fBL\fR flag is shown if the nickname identifies the local system.
2338 .RE
2339
2340 .sp
2341 .ne 2
2342 .na
2343 \fB\fBLINK\fR\fR
2344 .ad
2345 .sp .6
2346 .RS 4n
2347 Link name for output when sending messages to this RBridge.
2348 .RE
2349
2350 .sp
2351 .ne 2
2352 .na
2353 \fB\fBNEXTHOP\fR\fR
2354 .ad
2355 .sp .6
2356 .RS 4n
2357 MAC address of the next hop RBridge that is used to reach the RBridge with this
2358 nickname.
2359 .RE
2360
2361 When the \fB-o\fR option is not specified, the \fBNICK\fR, \fBFLAGS\fR,
2362 \fBLINK\fR, and \fBNEXTHOP\fR fields are shown.
2363 .RE
2364
2365 .RE
2366
2367 .sp
2368 .ne 2
2369 .na
2370 \fB\fBdladm create-vlan\fR [\fB-ft\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
2371 \fIether-link\fR \fB-v\fR \fIvid\fR [\fIvlan-link\fR]\fR
2372 .ad
2373 .sp .6
2374 .RS 4n
2375 Create a tagged VLAN link with an ID of \fIvid\fR over Ethernet link
2376 \fIether-link\fR. The name of the VLAN link can be specified as
2377 \fIvlan\fR-\fIlink\fR. If the name is not specified, a name will be
2378 automatically generated (assuming that \fIether-link\fR is \fIname\fR\fIPPA\fR)
2379 as:
2380 .sp
2381 .in +2
2382 .nf
2383 <\fIname\fR><1000 * \fIvlan-tag\fR + \fIPPA\fR>
2384 .fi
2385 .in -2
2386 .sp
2387
2388 For example, if \fIether-link\fR is \fBbge1\fR and \fIvid\fR is 2, the name
2389 generated is \fBbge2001\fR.
2390 .sp
2391 .ne 2
2392 .na
2393 \fB\fB-f\fR, \fB--force\fR\fR
2394 .ad
2395 .sp .6
2396 .RS 4n
2397 Force the creation of the VLAN link. Some devices do not allow frame sizes
2398 large enough to include a VLAN header. When creating a VLAN link over such a
2399 device, the \fB-f\fR option is needed, and the MTU of the IP interfaces on the
2400 resulting VLAN must be set to 1496 instead of 1500.
2401 .RE
2402
2403 .sp
2404 .ne 2
2405 .na
2406 \fB\fB-l\fR \fIether-link\fR\fR
2407 .ad
2408 .sp .6
2409 .RS 4n
2410 Specifies Ethernet link over which VLAN is created.
2411 .RE
2412
2413 .sp
2414 .ne 2
2415 .na
2416 \fB\fB-t\fR, \fB--temporary\fR\fR
2417 .ad
2418 .sp .6
2419 .RS 4n
2420 Specifies that the VLAN link is temporary. Temporary VLAN links last until the
2421 next reboot.
2422 .RE
2423
2424 .sp
2425 .ne 2
2426 .na
2427 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
2428 .ad
2429 .sp .6
2430 .RS 4n
2431 See "Options," above.
2432 .RE
2433
2434 .RE
2435
2436 .sp
2437 .ne 2
2438 .na
2439 \fB\fBdladm delete-vlan\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
2440 \fIvlan-link\fR\fR
2441 .ad
2442 .sp .6
2443 .RS 4n
2444 Delete the VLAN link specified.
2445 .sp
2446 The \fBdelete-vlan\fRsubcommand accepts the following options:
2447 .sp
2448 .ne 2
2449 .na
2450 \fB\fB-t\fR, \fB--temporary\fR\fR
2451 .ad
2452 .sp .6
2453 .RS 4n
2454 Specifies that the deletion is temporary. Temporary deletions last until the
2455 next reboot.
2456 .RE
2457
2458 .sp
2459 .ne 2
2460 .na
2461 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
2462 .ad
2463 .sp .6
2464 .RS 4n
2465 See "Options," above.
2466 .RE
2467
2468 .RE
2469
2470 .sp
2471 .ne 2
2472 .na
2473 \fB\fBdladm show-vlan\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
2474 [\fIvlan-link\fR]\fR
2475 .ad
2476 .sp .6
2477 .RS 4n
2478 Display VLAN configuration for all VLAN links or for the specified VLAN link.
2479 .sp
2480 The \fBshow-vlan\fRsubcommand accepts the following options:
2481 .sp
2482 .ne 2
2483 .na
2484 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
2485 .ad
2486 .sp .6
2487 .RS 4n
2488 A case-insensitive, comma-separated list of output fields to display. The field
2489 name must be one of the fields listed below, or the special value \fBall\fR, to
2490 display all fields. For each VLAN link, the following fields can be displayed:
2491 .sp
2492 .ne 2
2493 .na
2494 \fB\fBLINK\fR\fR
2495 .ad
2496 .sp .6
2497 .RS 4n
2498 The name of the VLAN link.
2499 .RE
2500
2501 .sp
2502 .ne 2
2503 .na
2504 \fB\fBVID\fR\fR
2505 .ad
2506 .sp .6
2507 .RS 4n
2508 The ID associated with the VLAN.
2509 .RE
2510
2511 .sp
2512 .ne 2
2513 .na
2514 \fB\fBOVER\fR\fR
2515 .ad
2516 .sp .6
2517 .RS 4n
2518 The name of the physical link over which this VLAN is configured.
2519 .RE
2520
2521 .sp
2522 .ne 2
2523 .na
2524 \fB\fBFLAGS\fR\fR
2525 .ad
2526 .sp .6
2527 .RS 4n
2528 A set of flags associated with the VLAN link. Possible flags are:
2529 .sp
2530 .ne 2
2531 .na
2532 \fB\fBf\fR\fR
2533 .ad
2534 .sp .6
2535 .RS 4n
2536 The VLAN was created using the \fB-f\fR option to \fBcreate-vlan\fR.
2537 .RE
2538
2539 .sp
2540 .ne 2
2541 .na
2542 \fB\fBi\fR\fR
2543 .ad
2544 .sp .6
2545 .RS 4n
2546 The VLAN was implicitly created when the DLPI link was opened. These VLAN links
2547 are automatically deleted on last close of the DLPI link (for example, when the
2548 IP interface associated with the VLAN link is unplumbed).
2549 .RE
2550
2551 Additional flags might be defined in the future.
2552 .RE
2553
2554 .RE
2555
2556 .sp
2557 .ne 2
2558 .na
2559 \fB\fB-p\fR, \fB--parseable\fR\fR
2560 .ad
2561 .sp .6
2562 .RS 4n
2563 Display using a stable machine-parseable format. The \fB-o\fR option is
2564 required with \fB-p\fR. See "Parseable Output Format", below.
2565 .RE
2566
2567 .sp
2568 .ne 2
2569 .na
2570 \fB\fB-P\fR, \fB--persistent\fR\fR
2571 .ad
2572 .sp .6
2573 .RS 4n
2574 Display the persistent VLAN configuration rather than the state of the running
2575 system.
2576 .RE
2577
2578 .RE
2579
2580 .sp
2581 .ne 2
2582 .na
2583 \fB\fBdladm scan-wifi\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
2584 [\fIwifi-link\fR]\fR
2585 .ad
2586 .sp .6
2587 .RS 4n
2588 Scans for \fBWiFi\fR networks, either on all \fBWiFi\fR links, or just on the
2589 specified \fIwifi-link\fR.
2590 .sp
2591 By default, currently all fields but \fBBSSTYPE\fR are displayed.
2592 .sp
2593 .ne 2
2594 .na
2595 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
2596 .ad
2597 .sp .6
2598 .RS 4n
2599 A case-insensitive, comma-separated list of output fields to display. The field
2600 name must be one of the fields listed below, or the special value \fBall\fR to
2601 display all fields. For each \fBWiFi\fR network found, the following fields can
2602 be displayed:
2603 .sp
2604 .ne 2
2605 .na
2606 \fB\fBLINK\fR\fR
2607 .ad
2608 .sp .6
2609 .RS 4n
2610 The name of the link the \fBWiFi\fR network is on.
2611 .RE
2612
2613 .sp
2614 .ne 2
2615 .na
2616 \fB\fBESSID\fR\fR
2617 .ad
2618 .sp .6
2619 .RS 4n
2620 The \fBESSID\fR (name) of the \fBWiFi\fR network.
2621 .RE
2622
2623 .sp
2624 .ne 2
2625 .na
2626 \fB\fBBSSID\fR\fR
2627 .ad
2628 .sp .6
2629 .RS 4n
2630 Either the hardware address of the \fBWiFi\fR network's Access Point (for
2631 \fBBSS\fR networks), or the \fBWiFi\fR network's randomly generated unique
2632 token (for \fBIBSS\fR networks).
2633 .RE
2634
2635 .sp
2636 .ne 2
2637 .na
2638 \fB\fBSEC\fR\fR
2639 .ad
2640 .sp .6
2641 .RS 4n
2642 Either \fBnone\fR for a \fBWiFi\fR network that uses no security, \fBwep\fR for
2643 a \fBWiFi\fR network that requires WEP (Wired Equivalent Privacy), or \fBwpa\fR
2644 for a WiFi network that requires WPA (Wi-Fi Protected Access).
2645 .RE
2646
2647 .sp
2648 .ne 2
2649 .na
2650 \fB\fBMODE\fR\fR
2651 .ad
2652 .sp .6
2653 .RS 4n
2654 The supported connection modes: one or more of \fBa\fR, \fBb\fR, or \fBg\fR.
2655 .RE
2656
2657 .sp
2658 .ne 2
2659 .na
2660 \fB\fBSTRENGTH\fR\fR
2661 .ad
2662 .sp .6
2663 .RS 4n
2664 The strength of the signal: one of \fBexcellent\fR, \fBvery good\fR,
2665 \fBgood\fR, \fBweak\fR, or \fBvery weak\fR.
2666 .RE
2667
2668 .sp
2669 .ne 2
2670 .na
2671 \fB\fBSPEED\fR\fR
2672 .ad
2673 .sp .6
2674 .RS 4n
2675 The maximum speed of the \fBWiFi\fR network, in megabits per second.
2676 .RE
2677
2678 .sp
2679 .ne 2
2680 .na
2681 \fB\fBBSSTYPE\fR\fR
2682 .ad
2683 .sp .6
2684 .RS 4n
2685 Either \fBbss\fR for \fBBSS\fR (infrastructure) networks, or \fBibss\fR for
2686 \fBIBSS\fR (ad-hoc) networks.
2687 .RE
2688
2689 .RE
2690
2691 .sp
2692 .ne 2
2693 .na
2694 \fB\fB-p\fR, \fB--parseable\fR\fR
2695 .ad
2696 .sp .6
2697 .RS 4n
2698 Display using a stable machine-parseable format. The \fB-o\fR option is
2699 required with \fB-p\fR. See "Parseable Output Format", below.
2700 .RE
2701
2702 .RE
2703
2704 .sp
2705 .ne 2
2706 .na
2707 \fB\fBdladm connect-wifi\fR [\fB-e\fR \fIessid\fR] [\fB-i\fR \fIbssid\fR]
2708 [\fB-k\fR \fIkey\fR,...] [\fB-s\fR \fBnone\fR | \fBwep\fR | \fBwpa\fR]
2709 [\fB-a\fR \fBopen\fR|\fBshared\fR] [\fB-b\fR \fBbss\fR|\fBibss\fR] [\fB-c\fR]
2710 [\fB-m\fR \fBa\fR|\fBb\fR|\fBg\fR] [\fB-T\fR \fItime\fR] [\fIwifi-link\fR]\fR
2711 .ad
2712 .sp .6
2713 .RS 4n
2714 Connects to a \fBWiFi\fR network. This consists of four steps: \fIdiscovery\fR,
2715 \fIfiltration\fR, \fIprioritization\fR, and \fIassociation\fR. However, to
2716 enable connections to non-broadcast \fBWiFi\fR networks and to improve
2717 performance, if a \fBBSSID\fR or \fBESSID\fR is specified using the \fB-e\fR or
2718 \fB-i\fR options, then the first three steps are skipped and \fBconnect-wifi\fR
2719 immediately attempts to associate with a \fBBSSID\fR or \fBESSID\fR that
2720 matches the rest of the provided parameters. If this association fails, but
2721 there is a possibility that other networks matching the specified criteria
2722 exist, then the traditional discovery process begins as specified below.
2723 .sp
2724 The discovery step finds all available \fBWiFi\fR networks on the specified
2725 WiFi link, which must not yet be connected. For administrative convenience, if
2726 there is only one \fBWiFi\fR link on the system, \fIwifi-link\fR can be
2727 omitted.
2728 .sp
2729 Once discovery is complete, the list of networks is filtered according to the
2730 value of the following options:
2731 .sp
2732 .ne 2
2733 .na
2734 \fB\fB-e\fR \fIessid,\fR \fB--essid\fR=\fIessid\fR\fR
2735 .ad
2736 .sp .6
2737 .RS 4n
2738 Networks that do not have the same \fIessid\fR are filtered out.
2739 .RE
2740
2741 .sp
2742 .ne 2
2743 .na
2744 \fB\fB-b\fR \fBbss\fR|\fBibss\fR, \fB--bsstype\fR=\fBbss\fR|\fBibss\fR\fR
2745 .ad
2746 .sp .6
2747 .RS 4n
2748 Networks that do not have the same \fBbsstype\fR are filtered out.
2749 .RE
2750
2751 .sp
2752 .ne 2
2753 .na
2754 \fB\fB-m\fR \fBa\fR|\fBb\fR|\fBg\fR, \fB--mode\fR=\fBa\fR|\fBb\fR|\fBg\fR\fR
2755 .ad
2756 .sp .6
2757 .RS 4n
2758 Networks not appropriate for the specified 802.11 mode are filtered out.
2759 .RE
2760
2761 .sp
2762 .ne 2
2763 .na
2764 \fB\fB-k\fR \fIkey,...\fR, \fB--key\fR=\fIkey, ...\fR\fR
2765 .ad
2766 .sp .6
2767 .RS 4n
2768 Use the specified \fBsecobj\fR named by the key to connect to the network.
2769 Networks not appropriate for the specified keys are filtered out.
2770 .RE
2771
2772 .sp
2773 .ne 2
2774 .na
2775 \fB\fB-s\fR \fBnone\fR|\fBwep\fR|\fBwpa\fR,
2776 \fB--sec\fR=\fBnone\fR|\fBwep\fR|\fBwpa\fR\fR
2777 .ad
2778 .sp .6
2779 .RS 4n
2780 Networks not appropriate for the specified security mode are filtered out.
2781 .RE
2782
2783 Next, the remaining networks are prioritized, first by signal strength, and
2784 then by maximum speed. Finally, an attempt is made to associate with each
2785 network in the list, in order, until one succeeds or no networks remain.
2786 .sp
2787 In addition to the options described above, the following options also control
2788 the behavior of \fBconnect-wifi\fR:
2789 .sp
2790 .ne 2
2791 .na
2792 \fB\fB-a\fR \fBopen\fR|\fBshared\fR, \fB--auth\fR=\fBopen\fR|\fBshared\fR\fR
2793 .ad
2794 .sp .6
2795 .RS 4n
2796 Connect using the specified authentication mode. By default, \fBopen\fR and
2797 \fBshared\fR are tried in order.
2798 .RE
2799
2800 .sp
2801 .ne 2
2802 .na
2803 \fB\fB-c\fR, \fB--create-ibss\fR\fR
2804 .ad
2805 .sp .6
2806 .RS 4n
2807 Used with \fB-b ibss\fR to create a new ad-hoc network if one matching the
2808 specified \fBESSID\fR cannot be found. If no \fBESSID\fR is specified, then
2809 \fB-c -b ibss\fR always triggers the creation of a new ad-hoc network.
2810 .RE
2811
2812 .sp
2813 .ne 2
2814 .na
2815 \fB\fB-T\fR \fItime\fR, \fB--timeout\fR=\fItime\fR\fR
2816 .ad
2817 .sp .6
2818 .RS 4n
2819 Specifies the number of seconds to wait for association to succeed. If
2820 \fItime\fR is \fBforever\fR, then the associate will wait indefinitely. The
2821 current default is ten seconds, but this might change in the future. Timeouts
2822 shorter than the default might not succeed reliably.
2823 .RE
2824
2825 .sp
2826 .ne 2
2827 .na
2828 \fB\fB-k\fR \fIkey,...\fR, \fB--key\fR=\fIkey,...\fR\fR
2829 .ad
2830 .sp .6
2831 .RS 4n
2832 In addition to the filtering previously described, the specified keys will be
2833 used to secure the association. The security mode to use will be based on the
2834 key class; if a security mode was explicitly specified, it must be compatible
2835 with the key class. All keys must be of the same class.
2836 .sp
2837 For security modes that support multiple key slots, the slot to place the key
2838 will be specified by a colon followed by an index. Therefore, \fB-k mykey:3\fR
2839 places \fBmykey\fR in slot 3. By default, slot 1 is assumed. For security modes
2840 that support multiple keys, a comma-separated list can be specified, with the
2841 first key being the active key.
2842 .RE
2843
2844 .RE
2845
2846 .sp
2847 .ne 2
2848 .na
2849 \fB\fBdladm disconnect-wifi\fR [\fB-a\fR] [\fIwifi-link\fR]\fR
2850 .ad
2851 .sp .6
2852 .RS 4n
2853 Disconnect from one or more \fBWiFi\fR networks. If \fIwifi-link\fR specifies a
2854 connected \fBWiFi\fR link, then it is disconnected. For administrative
2855 convenience, if only one \fBWiFi\fR link is connected, \fIwifi-link\fR can be
2856 omitted.
2857 .sp
2858 .ne 2
2859 .na
2860 \fB\fB-a\fR, \fB--all-links\fR\fR
2861 .ad
2862 .sp .6
2863 .RS 4n
2864 Disconnects from all connected links. This is primarily intended for use by
2865 scripts.
2866 .RE
2867
2868 .RE
2869
2870 .sp
2871 .ne 2
2872 .na
2873 \fB\fBdladm show-wifi\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR,...]
2874 [\fIwifi-link\fR]\fR
2875 .ad
2876 .sp .6
2877 .RS 4n
2878 Shows \fBWiFi\fR configuration information either for all \fBWiFi\fR links or
2879 for the specified link \fIwifi-link\fR.
2880 .sp
2881 .ne 2
2882 .na
2883 \fB\fB-o\fR \fIfield,...\fR, \fB--output\fR=\fIfield\fR\fR
2884 .ad
2885 .sp .6
2886 .RS 4n
2887 A case-insensitive, comma-separated list of output fields to display. The field
2888 name must be one of the fields listed below, or the special value \fBall\fR, to
2889 display all fields. For each \fBWiFi\fR link, the following fields can be
2890 displayed:
2891 .sp
2892 .ne 2
2893 .na
2894 \fB\fBLINK\fR\fR
2895 .ad
2896 .sp .6
2897 .RS 4n
2898 The name of the link being displayed.
2899 .RE
2900
2901 .sp
2902 .ne 2
2903 .na
2904 \fB\fBSTATUS\fR\fR
2905 .ad
2906 .sp .6
2907 .RS 4n
2908 Either \fBconnected\fR if the link is connected, or \fBdisconnected\fR if it is
2909 not connected. If the link is disconnected, all remaining fields have the value
2910 \fB--\fR.
2911 .RE
2912
2913 .sp
2914 .ne 2
2915 .na
2916 \fB\fBESSID\fR\fR
2917 .ad
2918 .sp .6
2919 .RS 4n
2920 The \fBESSID\fR (name) of the connected \fBWiFi\fR network.
2921 .RE
2922
2923 .sp
2924 .ne 2
2925 .na
2926 \fB\fBBSSID\fR\fR
2927 .ad
2928 .sp .6
2929 .RS 4n
2930 Either the hardware address of the \fBWiFi\fR network's Access Point (for
2931 \fBBSS\fR networks), or the \fBWiFi\fR network's randomly generated unique
2932 token (for \fBIBSS\fR networks).
2933 .RE
2934
2935 .sp
2936 .ne 2
2937 .na
2938 \fB\fBSEC\fR\fR
2939 .ad
2940 .sp .6
2941 .RS 4n
2942 Either \fBnone\fR for a \fBWiFi\fR network that uses no security, \fBwep\fR for
2943 a \fBWiFi\fR network that requires WEP, or \fBwpa\fR for a WiFi network that
2944 requires WPA.
2945 .RE
2946
2947 .sp
2948 .ne 2
2949 .na
2950 \fB\fBMODE\fR\fR
2951 .ad
2952 .sp .6
2953 .RS 4n
2954 The supported connection modes: one or more of \fBa\fR, \fBb\fR, or \fBg\fR.
2955 .RE
2956
2957 .sp
2958 .ne 2
2959 .na
2960 \fB\fBSTRENGTH\fR\fR
2961 .ad
2962 .sp .6
2963 .RS 4n
2964 The connection strength: one of \fBexcellent\fR, \fBvery good\fR, \fBgood\fR,
2965 \fBweak\fR, or \fBvery weak\fR.
2966 .RE
2967
2968 .sp
2969 .ne 2
2970 .na
2971 \fB\fBSPEED\fR\fR
2972 .ad
2973 .sp .6
2974 .RS 4n
2975 The connection speed, in megabits per second.
2976 .RE
2977
2978 .sp
2979 .ne 2
2980 .na
2981 \fB\fBAUTH\fR\fR
2982 .ad
2983 .sp .6
2984 .RS 4n
2985 Either \fBopen\fR or \fBshared\fR (see \fBconnect-wifi\fR).
2986 .RE
2987
2988 .sp
2989 .ne 2
2990 .na
2991 \fB\fBBSSTYPE\fR\fR
2992 .ad
2993 .sp .6
2994 .RS 4n
2995 Either \fBbss\fR for \fBBSS\fR (infrastructure) networks, or \fBibss\fR for
2996 \fBIBSS\fR (ad-hoc) networks.
2997 .RE
2998
2999 By default, currently all fields but \fBAUTH\fR, \fBBSSID\fR, \fBBSSTYPE\fR are
3000 displayed.
3001 .RE
3002
3003 .sp
3004 .ne 2
3005 .na
3006 \fB\fB-p\fR, \fB--parseable\fR\fR
3007 .ad
3008 .sp .6
3009 .RS 4n
3010 Displays using a stable machine-parseable format. The \fB-o\fR option is
3011 required with \fB-p\fR. See "Parseable Output Format", below.
3012 .RE
3013
3014 .RE
3015
3016 .sp
3017 .ne 2
3018 .na
3019 \fB\fBdladm show-ether\fR [\fB-x\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR,...]
3020 [\fIether-link\fR]\fR
3021 .ad
3022 .sp .6
3023 .RS 4n
3024 Shows state information either for all physical Ethernet links or for a
3025 specified physical Ethernet link.
3026 .sp
3027 The \fBshow-ether\fR subcommand accepts the following options:
3028 .sp
3029 .ne 2
3030 .na
3031 \fB\fB-o\fR \fIfield\fR,..., \fB--output\fR=\fIfield\fR\fR
3032 .ad
3033 .sp .6
3034 .RS 4n
3035 A case-insensitive, comma-separated list of output fields to display. The field
3036 name must be one of the fields listed below, or the special value \fBall\fR to
3037 display all fields. For each link, the following fields can be displayed:
3038 .sp
3039 .ne 2
3040 .na
3041 \fB\fBLINK\fR\fR
3042 .ad
3043 .sp .6
3044 .RS 4n
3045 The name of the link being displayed.
3046 .RE
3047
3048 .sp
3049 .ne 2
3050 .na
3051 \fB\fBPTYPE\fR\fR
3052 .ad
3053 .sp .6
3054 .RS 4n
3055 Parameter type, where \fBcurrent\fR indicates the negotiated state of the link,
3056 \fBcapable\fR indicates capabilities supported by the device, \fBadv\fR
3057 indicates the advertised capabilities, and \fBpeeradv\fR indicates the
3058 capabilities advertised by the link-partner.
3059 .RE
3060
3061 .sp
3062 .ne 2
3063 .na
3064 \fB\fBSTATE\fR\fR
3065 .ad
3066 .sp .6
3067 .RS 4n
3068 The state of the link.
3069 .RE
3070
3071 .sp
3072 .ne 2
3073 .na
3074 \fB\fBAUTO\fR\fR
3075 .ad
3076 .sp .6
3077 .RS 4n
3078 A \fByes\fR/\fBno\fR value indicating whether auto-negotiation is advertised.
3079 .RE
3080
3081 .sp
3082 .ne 2
3083 .na
3084 \fB\fBSPEED-DUPLEX\fR\fR
3085 .ad
3086 .sp .6
3087 .RS 4n
3088 Combinations of speed and duplex values available. The units of speed are
3089 encoded with a trailing suffix of \fBG\fR (Gigabits/s) or \fBM\fR (Mb/s).
3090 Duplex values are encoded as \fBf\fR (full-duplex) or \fBh\fR (half-duplex).
3091 .RE
3092
3093 .sp
3094 .ne 2
3095 .na
3096 \fB\fBPAUSE\fR\fR
3097 .ad
3098 .sp .6
3099 .RS 4n
3100 Flow control information. Can be \fBno\fR, indicating no flow control is
3101 available; \fBtx\fR, indicating that the end-point can transmit pause frames,
3102 but ignores any received pause frames; \fBrx\fR, indicating that the end-point
3103 receives and acts upon received pause frames; or \fBbi\fR, indicating
3104 bi-directional flow-control.
3105 .RE
3106
3107 .sp
3108 .ne 2
3109 .na
3110 \fB\fBREM_FAULT\fR\fR
3111 .ad
3112 .sp .6
3113 .RS 4n
3114 Fault detection information. Valid values are \fBnone\fR or \fBfault\fR.
3115 .RE
3116
3117 By default, all fields except \fBREM_FAULT\fR are displayed for the "current"
3118 \fBPTYPE\fR.
3119 .RE
3120
3121 .sp
3122 .ne 2
3123 .na
3124 \fB\fB-p\fR, \fB--parseable\fR\fR
3125 .ad
3126 .sp .6
3127 .RS 4n
3128 Displays using a stable machine-parseable format. The \fB-o\fR option is
3129 required with \fB-p\fR. See "Parseable Output Format", below.
3130 .RE
3131
3132 .sp
3133 .ne 2
3134 .na
3135 \fB\fB-x\fR, \fB--extended\fR\fR
3136 .ad
3137 .sp .6
3138 .RS 4n
3139 Extended output is displayed for \fBPTYPE\fR values of \fBcurrent\fR,
3140 \fBcapable\fR, \fBadv\fR and \fBpeeradv\fR.
3141 .RE
3142
3143 .RE
3144
3145 .sp
3146 .ne 2
3147 .na
3148 \fB\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR
3149 \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR\fR
3150 .ad
3151 .sp .6
3152 .RS 4n
3153 Sets the values of one or more properties on the link specified. The list of
3154 properties and their possible values depend on the link type, the network
3155 device driver, and networking hardware. These properties can be retrieved using
3156 \fBshow-linkprop\fR.
3157 .sp
3158 .ne 2
3159 .na
3160 \fB\fB-t\fR, \fB--temporary\fR\fR
3161 .ad
3162 .sp .6
3163 .RS 4n
3164 Specifies that the changes are temporary. Temporary changes last until the next
3165 reboot.
3166 .RE
3167
3168 .sp
3169 .ne 2
3170 .na
3171 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3172 .ad
3173 .sp .6
3174 .RS 4n
3175 See "Options," above.
3176 .RE
3177
3178 .sp
3179 .ne 2
3180 .na
3181 \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR
3182 \fIprop\fR=\fIvalue\fR[,...]\fR
3183 .ad
3184 .br
3185 .na
3186 \fB\fR
3187 .ad
3188 .sp .6
3189 .RS 4n
3190 A comma-separated list of properties to set to the specified values.
3191 .RE
3192
3193 Note that when the persistent value is set, the temporary value changes to the
3194 same value.
3195 .RE
3196
3197 .sp
3198 .ne 2
3199 .na
3200 \fB\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR
3201 \fIprop\fR,...] \fIlink\fR\fR
3202 .ad
3203 .sp .6
3204 .RS 4n
3205 Resets one or more properties to their values on the link specified. Properties
3206 are reset to the values they had at startup. If no properties are specified,
3207 all properties are reset. See \fBshow-linkprop\fR for a description of
3208 properties.
3209 .sp
3210 .ne 2
3211 .na
3212 \fB\fB-t\fR, \fB--temporary\fR\fR
3213 .ad
3214 .sp .6
3215 .RS 4n
3216 Specifies that the resets are temporary. Values are reset to default values.
3217 Temporary resets last until the next reboot.
3218 .RE
3219
3220 .sp
3221 .ne 2
3222 .na
3223 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3224 .ad
3225 .sp .6
3226 .RS 4n
3227 See "Options," above.
3228 .RE
3229
3230 .sp
3231 .ne 2
3232 .na
3233 \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR
3234 .ad
3235 .sp .6
3236 .RS 4n
3237 A comma-separated list of properties to reset.
3238 .RE
3239
3240 Note that when the persistent value is reset, the temporary value changes to
3241 the same value.
3242 .RE
3243
3244 .sp
3245 .ne 2
3246 .na
3247 \fB\fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR
3248 \fIfield\fR[,...]][\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]\fR
3249 .ad
3250 .sp .6
3251 .RS 4n
3252 Show the current or persistent values of one or more properties, either for all
3253 datalinks or for the specified link. By default, current values are shown. If
3254 no properties are specified, all available link properties are displayed. For
3255 each property, the following fields are displayed:
3256 .sp
3257 .ne 2
3258 .na
3259 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR\fR
3260 .ad
3261 .sp .6
3262 .RS 4n
3263 A case-insensitive, comma-separated list of output fields to display. The field
3264 name must be one of the fields listed below, or the special value \fBall\fR to
3265 display all fields. For each link, the following fields can be displayed:
3266 .sp
3267 .ne 2
3268 .na
3269 \fB\fBLINK\fR\fR
3270 .ad
3271 .sp .6
3272 .RS 4n
3273 The name of the datalink.
3274 .RE
3275
3276 .sp
3277 .ne 2
3278 .na
3279 \fB\fBPROPERTY\fR\fR
3280 .ad
3281 .sp .6
3282 .RS 4n
3283 The name of the property.
3284 .RE
3285
3286 .sp
3287 .ne 2
3288 .na
3289 \fB\fBPERM\fR\fR
3290 .ad
3291 .sp .6
3292 .RS 4n
3293 The read/write permissions of the property. The value shown is one of \fBro\fR
3294 or \fBrw\fR.
3295 .RE
3296
3297 .sp
3298 .ne 2
3299 .na
3300 \fB\fBVALUE\fR\fR
3301 .ad
3302 .sp .6
3303 .RS 4n
3304 The current (or persistent) property value. If the value is not set, it is
3305 shown as \fB--\fR. If it is unknown, the value is shown as \fB?\fR. Persistent
3306 values that are not set or have been reset will be shown as \fB--\fR and will
3307 use the system \fBDEFAULT\fR value (if any).
3308 .RE
3309
3310 .sp
3311 .ne 2
3312 .na
3313 \fB\fBDEFAULT\fR\fR
3314 .ad
3315 .sp .6
3316 .RS 4n
3317 The default value of the property. If the property has no default value,
3318 \fB--\fR is shown.
3319 .RE
3320
3321 .sp
3322 .ne 2
3323 .na
3324 \fB\fBPOSSIBLE\fR\fR
3325 .ad
3326 .sp .6
3327 .RS 4n
3328 A comma-separated list of the values the property can have. If the values span
3329 a numeric range, \fImin\fR - \fImax\fR might be shown as shorthand. If the
3330 possible values are unknown or unbounded, \fB--\fR is shown.
3331 .RE
3332
3333 The list of properties depends on the link type and network device driver, and
3334 the available values for a given property further depends on the underlying
3335 network hardware and its state. General link properties are documented in the
3336 \fBLINK PROPERTIES\fR section. However, link properties that begin with
3337 "\fB_\fR" (underbar) are specific to a given link or its underlying network
3338 device and subject to change or removal. See the appropriate network device
3339 driver man page for details.
3340 .RE
3341
3342 .sp
3343 .ne 2
3344 .na
3345 \fB\fB-c\fR, \fB--parseable\fR\fR
3346 .ad
3347 .sp .6
3348 .RS 4n
3349 Display using a stable machine-parseable format. The \fB-o\fR option is
3350 required with this option. See "Parseable Output Format", below.
3351 .RE
3352
3353 .sp
3354 .ne 2
3355 .na
3356 \fB\fB-P\fR, \fB--persistent\fR\fR
3357 .ad
3358 .sp .6
3359 .RS 4n
3360 Display persistent link property information
3361 .RE
3362
3363 .sp
3364 .ne 2
3365 .na
3366 \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR
3367 .ad
3368 .sp .6
3369 .RS 4n
3370 A comma-separated list of properties to show. See the sections on link
3371 properties following subcommand descriptions.
3372 .RE
3373
3374 .RE
3375
3376 .sp
3377 .ne 2
3378 .na
3379 \fB\fBdladm create-secobj\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-f\fR
3380 \fIfile\fR] \fB-c\fR \fIclass\fR \fIsecobj\fR\fR
3381 .ad
3382 .sp .6
3383 .RS 4n
3384 Create a secure object named \fIsecobj\fR in the specified \fIclass\fR to be
3385 later used as a WEP or WPA key in connecting to an encrypted network. The value
3386 of the secure object can either be provided interactively or read from a file.
3387 The sequence of interactive prompts and the file format depends on the class of
3388 the secure object.
3389 .sp
3390 Currently, the classes \fBwep\fR and \fBwpa\fR are supported. The \fBWEP\fR
3391 (Wired Equivalent Privacy) key can be either 5 or 13 bytes long. It can be
3392 provided either as an \fBASCII\fR or hexadecimal string -- thus, \fB12345\fR
3393 and \fB0x3132333435\fR are equivalent 5-byte keys (the \fB0x\fR prefix can be
3394 omitted). A file containing a \fBWEP\fR key must consist of a single line using
3395 either \fBWEP\fR key format. The WPA (Wi-Fi Protected Access) key must be
3396 provided as an ASCII string with a length between 8 and 63 bytes.
3397 .sp
3398 This subcommand is only usable by users or roles that belong to the "Network
3399 Link Security" \fBRBAC\fR profile.
3400 .sp
3401 .ne 2
3402 .na
3403 \fB\fB-c\fR \fIclass\fR, \fB--class\fR=\fIclass\fR\fR
3404 .ad
3405 .sp .6
3406 .RS 4n
3407 \fIclass\fR can be \fBwep\fR or \fBwpa\fR. See preceding discussion.
3408 .RE
3409
3410 .sp
3411 .ne 2
3412 .na
3413 \fB\fB-t\fR, \fB--temporary\fR\fR
3414 .ad
3415 .sp .6
3416 .RS 4n
3417 Specifies that the creation is temporary. Temporary creation last until the
3418 next reboot.
3419 .RE
3420
3421 .sp
3422 .ne 2
3423 .na
3424 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3425 .ad
3426 .sp .6
3427 .RS 4n
3428 See "Options," above.
3429 .RE
3430
3431 .sp
3432 .ne 2
3433 .na
3434 \fB\fB-f\fR \fIfile\fR, \fB--file\fR=\fIfile\fR\fR
3435 .ad
3436 .sp .6
3437 .RS 4n
3438 Specifies a file that should be used to obtain the secure object's value. The
3439 format of this file depends on the secure object class. See the \fBEXAMPLES\fR
3440 section for an example of using this option to set a \fBWEP\fR key.
3441 .RE
3442
3443 .RE
3444
3445 .sp
3446 .ne 2
3447 .na
3448 \fB\fBdladm delete-secobj\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
3449 \fIsecobj\fR[,...]\fR
3450 .ad
3451 .sp .6
3452 .RS 4n
3453 Delete one or more specified secure objects. This subcommand is only usable by
3454 users or roles that belong to the "Network Link Security" \fBRBAC\fR profile.
3455 .sp
3456 .ne 2
3457 .na
3458 \fB\fB-t\fR, \fB--temporary\fR\fR
3459 .ad
3460 .sp .6
3461 .RS 4n
3462 Specifies that the deletions are temporary. Temporary deletions last until the
3463 next reboot.
3464 .RE
3465
3466 .sp
3467 .ne 2
3468 .na
3469 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3470 .ad
3471 .sp .6
3472 .RS 4n
3473 See "Options," above.
3474 .RE
3475
3476 .RE
3477
3478 .sp
3479 .ne 2
3480 .na
3481 \fB\fBdladm show-secobj\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
3482 [\fIsecobj\fR,...]\fR
3483 .ad
3484 .sp .6
3485 .RS 4n
3486 Show current or persistent secure object information. If one or more secure
3487 objects are specified, then information for each is displayed. Otherwise, all
3488 current or persistent secure objects are displayed.
3489 .sp
3490 By default, current secure objects are displayed, which are all secure objects
3491 that have either been persistently created and not temporarily deleted, or
3492 temporarily created.
3493 .sp
3494 For security reasons, it is not possible to show the value of a secure object.
3495 .sp
3496 .ne 2
3497 .na
3498 \fB\fB-o\fR \fIfield\fR[,...] , \fB--output\fR=\fIfield\fR[,...]\fR
3499 .ad
3500 .sp .6
3501 .RS 4n
3502 A case-insensitive, comma-separated list of output fields to display. The field
3503 name must be one of the fields listed below. For displayed secure object, the
3504 following fields can be shown:
3505 .sp
3506 .ne 2
3507 .na
3508 \fB\fBOBJECT\fR\fR
3509 .ad
3510 .sp .6
3511 .RS 4n
3512 The name of the secure object.
3513 .RE
3514
3515 .sp
3516 .ne 2
3517 .na
3518 \fB\fBCLASS\fR\fR
3519 .ad
3520 .sp .6
3521 .RS 4n
3522 The class of the secure object.
3523 .RE
3524
3525 .RE
3526
3527 .sp
3528 .ne 2
3529 .na
3530 \fB\fB-p\fR, \fB--parseable\fR\fR
3531 .ad
3532 .sp .6
3533 .RS 4n
3534 Display using a stable machine-parseable format. The \fB-o\fR option is
3535 required with \fB-p\fR. See "Parseable Output Format", below.
3536 .RE
3537
3538 .sp
3539 .ne 2
3540 .na
3541 \fB\fB-P\fR, \fB--persistent\fR\fR
3542 .ad
3543 .sp .6
3544 .RS 4n
3545 Display persistent secure object information
3546 .RE
3547
3548 .RE
3549
3550 .sp
3551 .ne 2
3552 .na
3553 \fB\fBdladm create-vnic\fR [\fB-t\fR] \fB-l\fR \fIlink\fR [\fB-R\fR
3554 \fIroot-dir\fR] [\fB-m\fR \fIvalue\fR | auto | {factory [\fB-n\fR
3555 \fIslot-identifier\fR]} | {random [\fB-r\fR \fIprefix\fR]}] [\fB-v\fR
3556 \fIvlan-id\fR] [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIvnic-link\fR\fR
3557 .ad
3558 .sp .6
3559 .RS 4n
3560 Create a VNIC with name \fIvnic-link\fR over the specified link.
3561 .sp
3562 .ne 2
3563 .na
3564 \fB\fB-t\fR, \fB--temporary\fR\fR
3565 .ad
3566 .sp .6
3567 .RS 4n
3568 Specifies that the VNIC is temporary. Temporary VNICs last until the next
3569 reboot.
3570 .RE
3571
3572 .sp
3573 .ne 2
3574 .na
3575 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3576 .ad
3577 .sp .6
3578 .RS 4n
3579 See "Options," above.
3580 .RE
3581
3582 .sp
3583 .ne 2
3584 .na
3585 \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR
3586 .ad
3587 .sp .6
3588 .RS 4n
3589 \fIlink\fR can be a physical link or an \fBetherstub\fR.
3590 .RE
3591
3592 .sp
3593 .ne 2
3594 .na
3595 \fB\fB-m\fR \fIvalue\fR | \fIkeyword\fR, \fB--mac-address\fR=\fIvalue\fR |
3596 \fIkeyword\fR\fR
3597 .ad
3598 .sp .6
3599 .RS 4n
3600 Sets the VNIC's MAC address based on the specified value or keyword. If
3601 \fIvalue\fR is not a keyword, it is interpreted as a unicast MAC address, which
3602 must be valid for the underlying NIC. The following special keywords can be
3603 used:
3604 .sp
3605 .ne 2
3606 .na
3607 \fBfactory [\fB-n\fR \fIslot-identifier\fR],\fR
3608 .ad
3609 .br
3610 .na
3611 \fBfactory [\fB--slot\fR=\fIslot-identifier\fR]\fR
3612 .ad
3613 .sp .6
3614 .RS 4n
3615 Assign a factory MAC address to the VNIC. When a factory MAC address is
3616 requested, \fB-m\fR can be combined with the \fB-n\fR option to specify a MAC
3617 address slot to be used. If \fB-n\fR is not specified, the system will choose
3618 the next available factory MAC address. The \fB-m\fR option of the
3619 \fBshow-phys\fR subcommand can be used to display the list of factory MAC
3620 addresses, their slot identifiers, and their availability.
3621 .RE
3622
3623 .sp
3624 .ne 2
3625 .na
3626 \fB\fR
3627 .ad
3628 .br
3629 .na
3630 \fBrandom [\fB-r\fR \fIprefix\fR],\fR
3631 .ad
3632 .br
3633 .na
3634 \fBrandom [\fB--mac-prefix\fR=\fIprefix\fR]\fR
3635 .ad
3636 .sp .6
3637 .RS 4n
3638 Assign a random MAC address to the VNIC. A default prefix consisting of a valid
3639 IEEE OUI with the local bit set will be used. That prefix can be overridden
3640 with the \fB-r\fR option.
3641 .RE
3642
3643 .sp
3644 .ne 2
3645 .na
3646 \fBauto\fR
3647 .ad
3648 .sp .6
3649 .RS 4n
3650 Try and use a factory MAC address first. If none is available, assign a random
3651 MAC address. \fBauto\fR is the default action if the \fB-m\fR option is not
3652 specified.
3653 .RE
3654
3655 .sp
3656 .ne 2
3657 .na
3658 \fB\fB-v\fR \fIvlan-id\fR\fR
3659 .ad
3660 .sp .6
3661 .RS 4n
3662 Enable VLAN tagging for this VNIC. The VLAN tag will have id \fIvlan-id\fR.
3663 .RE
3664
3665 .RE
3666
3667 .sp
3668 .ne 2
3669 .na
3670 \fB\fB-p\fR \fIprop\fR=\fIvalue\fR,..., \fB--prop\fR
3671 \fIprop\fR=\fIvalue\fR,...\fR
3672 .ad
3673 .sp .6
3674 .RS 4n
3675 A comma-separated list of properties to set to the specified values.
3676 .RE
3677
3678 .RE
3679
3680 .sp
3681 .ne 2
3682 .na
3683 \fB\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
3684 \fIvnic-link\fR\fR
3685 .ad
3686 .sp .6
3687 .RS 4n
3688 Deletes the specified VNIC.
3689 .sp
3690 .ne 2
3691 .na
3692 \fB\fB-t\fR, \fB--temporary\fR\fR
3693 .ad
3694 .sp .6
3695 .RS 4n
3696 Specifies that the deletion is temporary. Temporary deletions last until the
3697 next reboot.
3698 .RE
3699
3700 .sp
3701 .ne 2
3702 .na
3703 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3704 .ad
3705 .sp .6
3706 .RS 4n
3707 See "Options," above.
3708 .RE
3709
3710 .RE
3711
3712 .sp
3713 .ne 2
3714 .na
3715 \fB\fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
3716 [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR]\fR
3717 .ad
3718 .sp .6
3719 .RS 4n
3720 Show VNIC configuration information (the default) or statistics, for all VNICs,
3721 all VNICs on a link, or only the specified \fIvnic-link\fR.
3722 .sp
3723 .ne 2
3724 .na
3725 \fB\fB-o\fR \fIfield\fR[,...] , \fB--output\fR=\fIfield\fR[,...]\fR
3726 .ad
3727 .sp .6
3728 .RS 4n
3729 A case-insensitive, comma-separated list of output fields to display. The field
3730 name must be one of the fields listed below. The field name must be one of the
3731 fields listed below, or the special value \fBall\fR to display all fields. By
3732 default (without \fB-o\fR), \fBshow-vnic\fR displays all fields.
3733 .sp
3734 .ne 2
3735 .na
3736 \fB\fBLINK\fR\fR
3737 .ad
3738 .sp .6
3739 .RS 4n
3740 The name of the VNIC.
3741 .RE
3742
3743 .sp
3744 .ne 2
3745 .na
3746 \fB\fBOVER\fR\fR
3747 .ad
3748 .sp .6
3749 .RS 4n
3750 The name of the physical link over which this VNIC is configured.
3751 .RE
3752
3753 .sp
3754 .ne 2
3755 .na
3756 \fB\fBSPEED\fR\fR
3757 .ad
3758 .sp .6
3759 .RS 4n
3760 The maximum speed of the VNIC, in megabits per second.
3761 .RE
3762
3763 .sp
3764 .ne 2
3765 .na
3766 \fB\fBMACADDRESS\fR\fR
3767 .ad
3768 .sp .6
3769 .RS 4n
3770 MAC address of the VNIC.
3771 .RE
3772
3773 .sp
3774 .ne 2
3775 .na
3776 \fB\fBMACADDRTYPE\fR\fR
3777 .ad
3778 .sp .6
3779 .RS 4n
3780 MAC address type of the VNIC. \fBdladm\fR distinguishes among the following MAC
3781 address types:
3782 .sp
3783 .ne 2
3784 .na
3785 \fB\fBrandom\fR\fR
3786 .ad
3787 .sp .6
3788 .RS 4n
3789 A random address assigned to the VNIC.
3790 .RE
3791
3792 .sp
3793 .ne 2
3794 .na
3795 \fB\fBfactory\fR\fR
3796 .ad
3797 .sp .6
3798 .RS 4n
3799 A factory MAC address used by the VNIC.
3800 .RE
3801
3802 .RE
3803
3804 .RE
3805
3806 .sp
3807 .ne 2
3808 .na
3809 \fB\fB-p\fR, \fB--parseable\fR\fR
3810 .ad
3811 .sp .6
3812 .RS 4n
3813 Display using a stable machine-parseable format. The \fB-o\fR option is
3814 required with \fB-p\fR. See "Parseable Output Format", below.
3815 .RE
3816
3817 .sp
3818 .ne 2
3819 .na
3820 \fB\fB-P\fR, \fB--persistent\fR\fR
3821 .ad
3822 .sp .6
3823 .RS 4n
3824 Display the persistent VNIC configuration.
3825 .RE
3826
3827 .sp
3828 .ne 2
3829 .na
3830 \fB\fB-s\fR, \fB--statistics\fR\fR
3831 .ad
3832 .sp .6
3833 .RS 4n
3834 Displays VNIC statistics.
3835 .RE
3836
3837 .sp
3838 .ne 2
3839 .na
3840 \fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
3841 .ad
3842 .sp .6
3843 .RS 4n
3844 Used with the \fB-s\fR option to specify an interval, in seconds, at which
3845 statistics should be displayed. If this option is not specified, statistics
3846 will be displayed only once.
3847 .RE
3848
3849 .sp
3850 .ne 2
3851 .na
3852 \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR
3853 .ad
3854 .sp .6
3855 .RS 4n
3856 Display information for all VNICs on the named link.
3857 .RE
3858
3859 .RE
3860
3861 .sp
3862 .ne 2
3863 .na
3864 \fB\fR
3865 .ad
3866 .br
3867 .na
3868 \fB\fBdladm create-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
3869 \fIetherstub\fR\fR
3870 .ad
3871 .sp .6
3872 .RS 4n
3873 Create an etherstub with the specified name.
3874 .sp
3875 .ne 2
3876 .na
3877 \fB\fB-t\fR, \fB--temporary\fR\fR
3878 .ad
3879 .sp .6
3880 .RS 4n
3881 Specifies that the etherstub is temporary. Temporary etherstubs do not persist
3882 across reboots.
3883 .RE
3884
3885 .sp
3886 .ne 2
3887 .na
3888 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3889 .ad
3890 .sp .6
3891 .RS 4n
3892 See "Options," above.
3893 .RE
3894
3895 VNICs can be created on top of etherstubs instead of physical NICs. As with
3896 physical NICs, such a creation causes the stack to implicitly create a virtual
3897 switch between the VNICs created on top of the same etherstub.
3898 .RE
3899
3900 .sp
3901 .ne 2
3902 .na
3903 \fB\fR
3904 .ad
3905 .br
3906 .na
3907 \fB\fBdladm delete-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
3908 \fIetherstub\fR\fR
3909 .ad
3910 .sp .6
3911 .RS 4n
3912 Delete the specified etherstub.
3913 .sp
3914 .ne 2
3915 .na
3916 \fB\fB-t\fR, \fB--temporary\fR\fR
3917 .ad
3918 .sp .6
3919 .RS 4n
3920 Specifies that the deletion is temporary. Temporary deletions last until the
3921 next reboot.
3922 .RE
3923
3924 .sp
3925 .ne 2
3926 .na
3927 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3928 .ad
3929 .sp .6
3930 .RS 4n
3931 See "Options," above.
3932 .RE
3933
3934 .RE
3935
3936 .sp
3937 .ne 2
3938 .na
3939 \fB\fBdladm show-etherstub\fR [\fIetherstub\fR]\fR
3940 .ad
3941 .sp .6
3942 .RS 4n
3943 Show all configured etherstubs by default, or the specified etherstub if
3944 \fIetherstub\fR is specified.
3945 .RE
3946
3947 .sp
3948 .ne 2
3949 .na
3950 \fB\fBdladm create-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-T\fR
3951 \fItype\fR [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR] \fIiptun-link\fR\fR
3952 .ad
3953 .sp .6
3954 .RS 4n
3955 Create an IP tunnel link named \fIiptun-link\fR. Such links can additionally be
3956 protected with IPsec using \fBipsecconf\fR(1M).
3957 .sp
3958 An IP tunnel is conceptually comprised of two parts: a virtual link between two
3959 or more IP nodes, and an IP interface above this link that allows the system to
3960 transmit and receive IP packets encapsulated by the underlying link. This
3961 subcommand creates a virtual link. The \fBifconfig\fR(1M) command is used to
3962 configure IP interfaces above the link.
3963 .sp
3964 .ne 2
3965 .na
3966 \fB\fB-t\fR, \fB--temporary\fR\fR
3967 .ad
3968 .sp .6
3969 .RS 4n
3970 Specifies that the IP tunnel link is temporary. Temporary tunnels last until
3971 the next reboot.
3972 .RE
3973
3974 .sp
3975 .ne 2
3976 .na
3977 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
3978 .ad
3979 .sp .6
3980 .RS 4n
3981 See "Options," above.
3982 .RE
3983
3984 .sp
3985 .ne 2
3986 .na
3987 \fB\fB-T\fR \fItype\fR, \fB--tunnel-type\fR=\fItype\fR\fR
3988 .ad
3989 .sp .6
3990 .RS 4n
3991 Specifies the type of tunnel to be created. The type must be one of the
3992 following:
3993 .sp
3994 .ne 2
3995 .na
3996 \fB\fBipv4\fR\fR
3997 .ad
3998 .sp .6
3999 .RS 4n
4000 A point-to-point, IP-over-IP tunnel between two IPv4 nodes. This type of tunnel
4001 requires IPv4 source and destination addresses to function. IPv4 and IPv6
4002 interfaces can be plumbed above such a tunnel to create IPv4-over-IPv4 and
4003 IPv6-over-IPv4 tunneling configurations.
4004 .RE
4005
4006 .sp
4007 .ne 2
4008 .na
4009 \fB\fBipv6\fR\fR
4010 .ad
4011 .sp .6
4012 .RS 4n
4013 A point-to-point, IP-over-IP tunnel between two IPv6 nodes as defined in IETF
4014 RFC 2473. This type of tunnel requires IPv6 source and destination addresses to
4015 function. IPv4 and IPv6 interfaces can be plumbed above such a tunnel to create
4016 IPv4-over-IPv6 and IPv6-over-IPv6 tunneling configurations.
4017 .RE
4018
4019 .sp
4020 .ne 2
4021 .na
4022 \fB\fB6to4\fR\fR
4023 .ad
4024 .sp .6
4025 .RS 4n
4026 A 6to4, point-to-multipoint tunnel as defined in IETF RFC 3056. This type of
4027 tunnel requires an IPv4 source address to function. An IPv6 interface is
4028 plumbed on such a tunnel link to configure a 6to4 router.
4029 .RE
4030
4031 .RE
4032
4033 .sp
4034 .ne 2
4035 .na
4036 \fB\fB-s\fR \fItsrc\fR, \fB--tunnel-src\fR=\fItsrc\fR\fR
4037 .ad
4038 .sp .6
4039 .RS 4n
4040 Literal IP address or hostname corresponding to the tunnel source. If a
4041 hostname is specified, it will be resolved to IP addresses, and one of those IP
4042 addresses will be used as the tunnel source. Because IP tunnels are created
4043 before naming services have been brought online during the boot process, it is
4044 important that any hostname used be included in \fB/etc/hosts\fR.
4045 .RE
4046
4047 .sp
4048 .ne 2
4049 .na
4050 \fB\fB-d\fR \fItdst\fR, \fB--tunnel-dst\fR=\fItdst\fR\fR
4051 .ad
4052 .sp .6
4053 .RS 4n
4054 Literal IP address or hostname corresponding to the tunnel destination.
4055 .RE
4056
4057 .RE
4058
4059 .sp
4060 .ne 2
4061 .na
4062 \fB\fBdladm modify-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-s\fR
4063 \fItsrc\fR] [\fB-d\fR \fItdst\fR] \fIiptun-link\fR\fR
4064 .ad
4065 .sp .6
4066 .RS 4n
4067 Modify the parameters of the specified IP tunnel.
4068 .sp
4069 .ne 2
4070 .na
4071 \fB\fB-t\fR, \fB--temporary\fR\fR
4072 .ad
4073 .sp .6
4074 .RS 4n
4075 Specifies that the modification is temporary. Temporary modifications last
4076 until the next reboot.
4077 .RE
4078
4079 .sp
4080 .ne 2
4081 .na
4082 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
4083 .ad
4084 .sp .6
4085 .RS 4n
4086 See "Options," above.
4087 .RE
4088
4089 .sp
4090 .ne 2
4091 .na
4092 \fB\fB-s\fR \fItsrc\fR, \fB--tunnel-src\fR=\fItsrc\fR\fR
4093 .ad
4094 .sp .6
4095 .RS 4n
4096 Specifies a new tunnel source address. See \fBcreate-iptun\fR for a
4097 description.
4098 .RE
4099
4100 .sp
4101 .ne 2
4102 .na
4103 \fB\fB-d\fR \fItdst\fR, \fB--tunnel-dst\fR=\fItdst\fR\fR
4104 .ad
4105 .sp .6
4106 .RS 4n
4107 Specifies a new tunnel destination address. See \fBcreate-iptun\fR for a
4108 description.
4109 .RE
4110
4111 .RE
4112
4113 .sp
4114 .ne 2
4115 .na
4116 \fB\fBdladm delete-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR]
4117 \fIiptun-link\fR\fR
4118 .ad
4119 .sp .6
4120 .RS 4n
4121 Delete the specified IP tunnel link.
4122 .sp
4123 .ne 2
4124 .na
4125 \fB\fB-t\fR, \fB--temporary\fR\fR
4126 .ad
4127 .sp .6
4128 .RS 4n
4129 Specifies that the deletion is temporary. Temporary deletions last until the
4130 next reboot.
4131 .RE
4132
4133 .sp
4134 .ne 2
4135 .na
4136 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
4137 .ad
4138 .sp .6
4139 .RS 4n
4140 See "Options," above.
4141 .RE
4142
4143 .RE
4144
4145 .sp
4146 .ne 2
4147 .na
4148 \fB\fBdladm show-iptun\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
4149 [\fIiptun-link\fR]\fR
4150 .ad
4151 .sp .6
4152 .RS 4n
4153 Show IP tunnel link configuration for a single IP tunnel or all IP tunnels.
4154 .sp
4155 .ne 2
4156 .na
4157 \fB\fB-P\fR, \fB--persistent\fR\fR
4158 .ad
4159 .sp .6
4160 .RS 4n
4161 Display the persistent IP tunnel configuration.
4162 .RE
4163
4164 .sp
4165 .ne 2
4166 .na
4167 \fB\fB-p\fR, \fB--parseable\fR\fR
4168 .ad
4169 .sp .6
4170 .RS 4n
4171 Display using a stable machine-parseable format. The -o option is required with
4172 -p. See "Parseable Output Format", below.
4173 .RE
4174
4175 .sp
4176 .ne 2
4177 .na
4178 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
4179 .ad
4180 .sp .6
4181 .RS 4n
4182 A case-insensitive, comma-separated list of output fields to display. The field
4183 name must be one of the fields listed below, or the special value \fBall\fR, to
4184 display all fields. By default (without \fB-o\fR), \fBshow-iptun\fR displays
4185 all fields.
4186 .sp
4187 .ne 2
4188 .na
4189 \fB\fBLINK\fR\fR
4190 .ad
4191 .sp .6
4192 .RS 4n
4193 The name of the IP tunnel link.
4194 .RE
4195
4196 .sp
4197 .ne 2
4198 .na
4199 \fB\fBTYPE\fR\fR
4200 .ad
4201 .sp .6
4202 .RS 4n
4203 Type of tunnel as specified by the \fB-T\fR option of \fBcreate-iptun\fR.
4204 .RE
4205
4206 .sp
4207 .ne 2
4208 .na
4209 \fB\fBFLAGS\fR\fR
4210 .ad
4211 .sp .6
4212 .RS 4n
4213 A set of flags associated with the IP tunnel link. Possible flags are:
4214 .sp
4215 .ne 2
4216 .na
4217 \fB\fBs\fR\fR
4218 .ad
4219 .sp .6
4220 .RS 4n
4221 The IP tunnel link is protected by IPsec policy. To display the IPsec policy
4222 associated with the tunnel link, enter:
4223 .sp
4224 .in +2
4225 .nf
4226 # \fBipsecconf -ln -i \fItunnel-link\fR\fR
4227 .fi
4228 .in -2
4229 .sp
4230
4231 See \fBipsecconf\fR(1M) for more details on how to configure IPsec policy.
4232 .RE
4233
4234 .sp
4235 .ne 2
4236 .na
4237 \fB\fBi\fR\fR
4238 .ad
4239 .sp .6
4240 .RS 4n
4241 The IP tunnel link was implicitly created with \fBifconfig\fR(1M), and will be
4242 automatically deleted when it is no longer referenced (that is, when the last
4243 IP interface over the tunnel is unplumbed). See \fBifconfig\fR(1M) for details
4244 on implicit tunnel creation.
4245 .RE
4246
4247 .RE
4248
4249 .sp
4250 .ne 2
4251 .na
4252 \fB\fBSOURCE\fR\fR
4253 .ad
4254 .sp .6
4255 .RS 4n
4256 The tunnel source address.
4257 .RE
4258
4259 .sp
4260 .ne 2
4261 .na
4262 \fB\fBDESTINATION\fR\fR
4263 .ad
4264 .sp .6
4265 .RS 4n
4266 The tunnel destination address.
4267 .RE
4268
4269 .RE
4270
4271 .RE
4272
4273 .sp
4274 .ne 2
4275 .na
4276 \fB\fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR
4277 \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR] [\fB-e\fR
4278 \fItime\fR] [\fIlink\fR]\fR
4279 .ad
4280 .sp .6
4281 .RS 4n
4282 Show the historical network usage from a stored extended accounting file.
4283 Configuration and enabling of network accounting through \fBacctadm\fR(1M) is
4284 required. The default output will be the summary of network usage for the
4285 entire period of time in which extended accounting was enabled.
4286 .sp
4287 .ne 2
4288 .na
4289 \fB\fB-a\fR\fR
4290 .ad
4291 .sp .6
4292 .RS 4n
4293 Display all historical network usage for the specified period of time during
4294 which extended accounting is enabled. This includes the usage information for
4295 the links that have already been deleted.
4296 .RE
4297
4298 .sp
4299 .ne 2
4300 .na
4301 \fB\fB-f\fR \fIfilename\fR, \fB--file\fR=\fIfilename\fR\fR
4302 .ad
4303 .sp .6
4304 .RS 4n
4305 Read extended accounting records of network usage from \fIfilename\fR.
4306 .RE
4307
4308 .sp
4309 .ne 2
4310 .na
4311 \fB\fB-F\fR \fIformat\fR, \fB--format\fR=\fIformat\fR\fR
4312 .ad
4313 .sp .6
4314 .RS 4n
4315 Specifies the format of \fIplotfile\fR that is specified by the \fB-p\fR
4316 option. As of this release, \fBgnuplot\fR is the only supported format.
4317 .RE
4318
4319 .sp
4320 .ne 2
4321 .na
4322 \fB\fB-p\fR \fIplotfile\fR, \fB--plot\fR=\fIplotfile\fR\fR
4323 .ad
4324 .sp .6
4325 .RS 4n
4326 Write network usage data to a file of the format specified by the \fB-F\fR
4327 option, which is required.
4328 .RE
4329
4330 .sp
4331 .ne 2
4332 .na
4333 \fB\fB-s\fR \fItime\fR, \fB--start\fR=\fItime\fR\fR
4334 .ad
4335 .br
4336 .na
4337 \fB\fB-e\fR \fItime\fR, \fB--stop\fR=\fItime\fR\fR
4338 .ad
4339 .sp .6
4340 .RS 4n
4341 Start and stop times for data display. Time is in the format
4342 \fIMM\fR/\fIDD\fR/\fIYYYY\fR,\fIhh\fR:\fImm\fR:\fIss\fR.
4343 .RE
4344
4345 .sp
4346 .ne 2
4347 .na
4348 \fB\fIlink\fR\fR
4349 .ad
4350 .sp .6
4351 .RS 4n
4352 If specified, display the network usage only for the named link. Otherwise,
4353 display network usage for all links.
4354 .RE
4355
4356 .RE
4357
4358 .sp
4359 .ne 2
4360 .na
4361 \fB\fBdladm help\fR [\fIsubcommand\fR]\fR
4362 .ad
4363 .sp .6
4364 .RS 4n
4365 Displays all subcommands or help on a single subcommand.
4366 .RE
4367
4368 .SS "Parseable Output Format"
4369 .sp
4370 .LP
4371 Many \fBdladm\fR subcommands have an option that displays output in a
4372 machine-parseable format. The output format is one or more lines of colon
4373 (\fB:\fR) delimited fields. The fields displayed are specific to the subcommand
4374 used and are listed under the entry for the \fB-o\fR option for a given
4375 subcommand. Output includes only those fields requested by means of the
4376 \fB-o\fR option, in the order requested.
4377 .sp
4378 .LP
4379 When you request multiple fields, any literal colon characters are escaped by a
4380 backslash (\fB\e\fR) before being output. Similarly, literal backslash
4381 characters will also be escaped (\fB\e\e\fR). This escape format is parseable
4382 by using shell \fBread\fR(1) functions with the environment variable
4383 \fBIFS=:\fR (see \fBEXAMPLES\fR, below). Note that escaping is not done when
4384 you request only a single field.
4385 .SS "General Link Properties"
4386 .sp
4387 .LP
4388 The following general link properties are supported:
4389 .sp
4390 .ne 2
4391 .na
4392 \fB\fBautopush\fR\fR
4393 .ad
4394 .sp .6
4395 .RS 4n
4396 Specifies the set of STREAMS modules to push on the stream associated with a
4397 link when its DLPI device is opened. It is a space-delimited list of modules.
4398 .sp
4399 The optional special character sequence \fB[anchor]\fR indicates that a STREAMS
4400 anchor should be placed on the stream at the module previously specified in the
4401 list. It is an error to specify more than one anchor or to have an anchor first
4402 in the list.
4403 .sp
4404 The \fBautopush\fR property is preferred over the more general
4405 \fBautopush\fR(1M) command.
4406 .RE
4407
4408 .sp
4409 .ne 2
4410 .na
4411 \fB\fBcpus\fR\fR
4412 .ad
4413 .sp .6
4414 .RS 4n
4415 Bind the processing of packets for a given data link to a processor or a set of
4416 processors. The value can be a comma-separated list of one or more processor
4417 ids. If the list consists of more than one processor, the processing will
4418 spread out to all the processors. Connection to processor affinity and packet
4419 ordering for any individual connection will be maintained.
4420 .sp
4421 The processor or set of processors are not exclusively reserved for the link.
4422 Only the kernel threads and interrupts associated with processing of the link
4423 are bound to the processor or the set of processors specified. In case it is
4424 desired that processors be dedicated to the link, \fBpsrset\fR(1M) can be used
4425 to create a processor set and then specifying the processors from the processor
4426 set to bind the link to.
4427 .sp
4428 If the link was already bound to processor or set of processors due to a
4429 previous operation, the binding will be removed and the new set of processors
4430 will be used instead.
4431 .sp
4432 The default is no CPU binding, which is to say that the processing of packets
4433 is not bound to any specific processor or processor set.
4434 .RE
4435
4436 .sp
4437 .ne 2
4438 .na
4439 \fB\fBlearn_limit\fR\fR
4440 .ad
4441 .sp .6
4442 .RS 4n
4443 Limits the number of new or changed MAC sources to be learned over a bridge
4444 link. When the number exceeds this value, learning on that link is temporarily
4445 disabled. Only non-VLAN, non-VNIC type links have this property.
4446 .sp
4447 The default value is \fB1000\fR. Valid values are greater or equal to 0.
4448 .RE
4449
4450 .sp
4451 .ne 2
4452 .na
4453 \fB\fBlearn_decay\fR\fR
4454 .ad
4455 .sp .6
4456 .RS 4n
4457 Specifies the decay rate for source changes limited by \fBlearn_limit\fR. This
4458 number is subtracted from the counter for a bridge link every 5 seconds. Only
4459 non-VLAN, non-VNIC type links have this property.
4460 .sp
4461 The default value is \fB200\fR. Valid values are greater or equal to 0.
4462 .RE
4463
4464 .sp
4465 .ne 2
4466 .na
4467 \fB\fBmaxbw\fR\fR
4468 .ad
4469 .sp .6
4470 .RS 4n
4471 Sets the full duplex bandwidth for the link. The bandwidth is specified as an
4472 integer with one of the scale suffixes (\fBK\fR, \fBM\fR, or \fBG\fR for Kbps,
4473 Mbps, and Gbps). If no units are specified, the input value will be read as
4474 Mbps. The default is no bandwidth limit.
4475 .RE
4476
4477 .sp
4478 .ne 2
4479 .na
4480 \fB\fBpriority\fR\fR
4481 .ad
4482 .sp .6
4483 .RS 4n
4484 Sets the relative priority for the link. The value can be given as one of the
4485 tokens \fBhigh\fR, \fBmedium\fR, or \fBlow\fR. The default is \fBhigh\fR.
4486 .RE
4487
4488 .sp
4489 .ne 2
4490 .na
4491 \fB\fBstp\fR\fR
4492 .ad
4493 .sp .6
4494 .RS 4n
4495 Enables or disables Spanning Tree Protocol on a bridge link. Setting this value
4496 to \fB0\fR disables Spanning Tree, and puts the link into forwarding mode with
4497 BPDU guarding enabled. This mode is appropriate for point-to-point links
4498 connected only to end nodes. Only non-VLAN, non-VNIC type links have this
4499 property. The default value is \fB1\fR, to enable STP.
4500 .RE
4501
4502 .sp
4503 .ne 2
4504 .na
4505 \fB\fBforward\fR\fR
4506 .ad
4507 .sp .6
4508 .RS 4n
4509 Enables or disables forwarding for a VLAN. Setting this value to \fB0\fR
4510 disables bridge forwarding for a VLAN link. Disabling bridge forwarding removes
4511 that VLAN from the "allowed set" for the bridge. The default value is \fB1\fR,
4512 to enable bridge forwarding for configured VLANs.
4513 .RE
4514
4515 .sp
4516 .ne 2
4517 .na
4518 \fB\fBdefault_tag\fR\fR
4519 .ad
4520 .sp .6
4521 .RS 4n
4522 Sets the default VLAN ID that is assumed for untagged packets sent to and
4523 received from this link. Only non-VLAN, non-VNIC type links have this property.
4524 Setting this value to \fB0\fR disables the bridge forwarding of untagged
4525 packets to and from the port. The default value is \fBVLAN ID 1\fR. Valid
4526 values values are from 0 to 4094.
4527 .RE
4528
4529 .sp
4530 .ne 2
4531 .na
4532 \fB\fBstp_priority\fR\fR
4533 .ad
4534 .sp .6
4535 .RS 4n
4536 Sets the STP and RSTP Port Priority value, which is used to determine the
4537 preferred root port on a bridge. Lower numerical values are higher priority.
4538 The default value is \fB128\fR. Valid values range from 0 to 255.
4539 .RE
4540
4541 .sp
4542 .ne 2
4543 .na
4544 \fB\fBstp_cost\fR\fR
4545 .ad
4546 .sp .6
4547 .RS 4n
4548 Sets the STP and RSTP cost for using the link. The default value is \fBauto\fR,
4549 which sets the cost based on link speed, using \fB100\fR for 10Mbps, \fB19\fR
4550 for 100Mbps, \fB4\fR for 1Gbps, and \fB2\fR for 10Gbps. Valid values range from
4551 1 to 65535.
4552 .RE
4553
4554 .sp
4555 .ne 2
4556 .na
4557 \fB\fBstp_edge\fR\fR
4558 .ad
4559 .sp .6
4560 .RS 4n
4561 Enables or disables bridge edge port detection. If set to \fB0\fR (false), the
4562 system assumes that the port is connected to other bridges even if no bridge
4563 PDUs of any type are seen. The default value is \fB1\fR, which detects edge
4564 ports automatically.
4565 .RE
4566
4567 .sp
4568 .ne 2
4569 .na
4570 \fB\fBstp_p2p\fR\fR
4571 .ad
4572 .sp .6
4573 .RS 4n
4574 Sets bridge point-to-point operation mode. Possible values are \fBtrue\fR,
4575 \fBfalse\fR, and \fBauto\fR. When set to \fBauto\fR, point-to-point connections
4576 are automatically discovered. When set to \fBtrue\fR, the port mode is forced
4577 to use point-to-point. When set to \fBfalse\fR, the port mode is forced to use
4578 normal multipoint mode. The default value is \fBauto\fR.
4579 .RE
4580
4581 .sp
4582 .ne 2
4583 .na
4584 \fB\fBstp_mcheck\fR\fR
4585 .ad
4586 .sp .6
4587 .RS 4n
4588 Triggers the system to run the RSTP \fBForce BPDU Migration Check\fR procedure
4589 on this link. The procedure is triggered by setting the property value to
4590 \fB1\fR. The property is automatically reset back to \fB0\fR. This value cannot
4591 be set unless the following are true:
4592 .RS +4
4593 .TP
4594 .ie t \(bu
4595 .el o
4596 The link is bridged
4597 .RE
4598 .RS +4
4599 .TP
4600 .ie t \(bu
4601 .el o
4602 The bridge is protected by Spanning Tree
4603 .RE
4604 .RS +4
4605 .TP
4606 .ie t \(bu
4607 .el o
4608 The bridge \fBforce-protocol\fR value is at least 2 (RSTP)
4609 .RE
4610 The default value is 0.
4611 .RE
4612
4613 .sp
4614 .ne 2
4615 .na
4616 \fB\fBzone\fR\fR
4617 .ad
4618 .sp .6
4619 .RS 4n
4620 Specifies the zone to which the link belongs. This property can be modified
4621 only temporarily through \fBdladm\fR, and thus the \fB-t\fR option must be
4622 specified. To modify the zone assignment such that it persists across reboots,
4623 please use \fBzonecfg\fR(1M). Possible values consist of any exclusive-IP zone
4624 currently running on the system. By default, the zone binding is as per
4625 \fBzonecfg\fR(1M).
4626 .RE
4627
4628 .SS "Wifi Link Properties"
4629 .sp
4630 .LP
4631 The following \fBWiFi\fR link properties are supported. Note that the ability
4632 to set a given property to a given value depends on the driver and hardware.
4633 .sp
4634 .ne 2
4635 .na
4636 \fB\fBchannel\fR\fR
4637 .ad
4638 .sp .6
4639 .RS 4n
4640 Specifies the channel to use. This property can be modified only by certain
4641 \fBWiFi\fR links when in \fBIBSS\fR mode. The default value and allowed range
4642 of values varies by regulatory domain.
4643 .RE
4644
4645 .sp
4646 .ne 2
4647 .na
4648 \fB\fBpowermode\fR\fR
4649 .ad
4650 .sp .6
4651 .RS 4n
4652 Specifies the power management mode of the \fBWiFi\fR link. Possible values are
4653 \fBoff\fR (disable power management), \fBmax\fR (maximum power savings), and
4654 \fBfast\fR (performance-sensitive power management). Default is \fBoff\fR.
4655 .RE
4656
4657 .sp
4658 .ne 2
4659 .na
4660 \fB\fBradio\fR\fR
4661 .ad
4662 .sp .6
4663 .RS 4n
4664 Specifies the radio mode of the \fBWiFi\fR link. Possible values are \fBon\fR
4665 or \fBoff\fR. Default is \fBon\fR.
4666 .RE
4667
4668 .sp
4669 .ne 2
4670 .na
4671 \fB\fBspeed\fR\fR
4672 .ad
4673 .sp .6
4674 .RS 4n
4675 Specifies a fixed speed for the \fBWiFi\fR link, in megabits per second. The
4676 set of possible values depends on the driver and hardware (but is shown by
4677 \fBshow-linkprop\fR); common speeds include 1, 2, 11, and 54. By default, there
4678 is no fixed speed.
4679 .RE
4680
4681 .SS "Ethernet Link Properties"
4682 .sp
4683 .LP
4684 The following MII Properties, as documented in \fBieee802.3\fR(5), are
4685 supported in read-only mode:
4686 .RS +4
4687 .TP
4688 .ie t \(bu
4689 .el o
4690 \fBduplex\fR
4691 .RE
4692 .RS +4
4693 .TP
4694 .ie t \(bu
4695 .el o
4696 \fBstate\fR
4697 .RE
4698 .RS +4
4699 .TP
4700 .ie t \(bu
4701 .el o
4702 \fBadv_autoneg_cap\fR
4703 .RE
4704 .RS +4
4705 .TP
4706 .ie t \(bu
4707 .el o
4708 \fBadv_10gfdx_cap\fR
4709 .RE
4710 .RS +4
4711 .TP
4712 .ie t \(bu
4713 .el o
4714 \fBadv_1000fdx_cap\fR
4715 .RE
4716 .RS +4
4717 .TP
4718 .ie t \(bu
4719 .el o
4720 \fBadv_1000hdx_cap\fR
4721 .RE
4722 .RS +4
4723 .TP
4724 .ie t \(bu
4725 .el o
4726 \fBadv_100fdx_cap\fR
4727 .RE
4728 .RS +4
4729 .TP
4730 .ie t \(bu
4731 .el o
4732 \fBadv_100hdx_cap\fR
4733 .RE
4734 .RS +4
4735 .TP
4736 .ie t \(bu
4737 .el o
4738 \fBadv_10fdx_cap\fR
4739 .RE
4740 .RS +4
4741 .TP
4742 .ie t \(bu
4743 .el o
4744 \fBadv_10hdx_cap\fR
4745 .RE
4746 .sp
4747 .LP
4748 Each \fBadv_\fR property (for example, \fBadv_10fdx_cap\fR) also has a
4749 read/write counterpart \fBen_\fR property (for example, \fBen_10fdx_cap\fR)
4750 controlling parameters used at auto-negotiation. In the absence of Power
4751 Management, the \fBadv\fR* speed/duplex parameters provide the values that are
4752 both negotiated and currently effective in hardware. However, with Power
4753 Management enabled, the speed/duplex capabilities currently exposed in hardware
4754 might be a subset of the set of bits that were used in initial link parameter
4755 negotiation. Thus the MII \fBadv_\fR* parameters are marked read-only, with an
4756 additional set of \fBen_\fR* parameters for configuring speed and duplex
4757 properties at initial negotiation.
4758 .sp
4759 .LP
4760 Note that the \fBadv_autoneg_cap\fR does not have an \fBen_autoneg_cap\fR
4761 counterpart: the \fBadv_autoneg_cap\fR is a 0/1 switch that turns off/on
4762 autonegotiation itself, and therefore cannot be impacted by Power Management.
4763 .sp
4764 .LP
4765 In addition, the following Ethernet properties are reported:
4766 .sp
4767 .ne 2
4768 .na
4769 \fB\fBspeed\fR\fR
4770 .ad
4771 .sp .6
4772 .RS 4n
4773 (read-only) The operating speed of the device, in Mbps.
4774 .RE
4775
4776 .sp
4777 .ne 2
4778 .na
4779 \fB\fBmtu\fR\fR
4780 .ad
4781 .sp .6
4782 .RS 4n
4783 The maximum client SDU (Send Data Unit) supported by the device. Valid range is
4784 68-65536.
4785 .RE
4786
4787 .sp
4788 .ne 2
4789 .na
4790 \fB\fBflowctrl\fR\fR
4791 .ad
4792 .sp .6
4793 .RS 4n
4794 Establishes flow-control modes that will be advertised by the device. Valid
4795 input is one of:
4796 .sp
4797 .ne 2
4798 .na
4799 \fB\fBno\fR\fR
4800 .ad
4801 .sp .6
4802 .RS 4n
4803 No flow control enabled.
4804 .RE
4805
4806 .sp
4807 .ne 2
4808 .na
4809 \fB\fBrx\fR\fR
4810 .ad
4811 .sp .6
4812 .RS 4n
4813 Receive, and act upon incoming pause frames.
4814 .RE
4815
4816 .sp
4817 .ne 2
4818 .na
4819 \fB\fBtx\fR\fR
4820 .ad
4821 .sp .6
4822 .RS 4n
4823 Transmit pause frames to the peer when congestion occurs, but ignore received
4824 pause frames.
4825 .RE
4826
4827 .sp
4828 .ne 2
4829 .na
4830 \fB\fBbi\fR\fR
4831 .ad
4832 .sp .6
4833 .RS 4n
4834 Bidirectional flow control.
4835 .RE
4836
4837 Note that the actual settings for this value are constrained by the
4838 capabilities allowed by the device and the link partner.
4839 .RE
4840
4841 .sp
4842 .ne 2
4843 .na
4844 \fB\fBtagmode\fR\fR
4845 .ad
4846 .sp .6
4847 .RS 4n
4848 This link property controls the conditions in which 802.1Q VLAN tags will be
4849 inserted in packets being transmitted on the link. Two mode values can be
4850 assigned to this property:
4851 .sp
4852 .ne 2
4853 .na
4854 \fB\fBnormal\fR\fR
4855 .ad
4856 .RS 12n
4857 Insert a VLAN tag in outgoing packets under the following conditions:
4858 .RS +4
4859 .TP
4860 .ie t \(bu
4861 .el o
4862 The packet belongs to a VLAN.
4863 .RE
4864 .RS +4
4865 .TP
4866 .ie t \(bu
4867 .el o
4868 The user requested priority tagging.
4869 .RE
4870 .RE
4871
4872 .sp
4873 .ne 2
4874 .na
4875 \fB\fBvlanonly\fR\fR
4876 .ad
4877 .RS 12n
4878 Insert a VLAN tag only when the outgoing packet belongs to a VLAN. If a tag is
4879 being inserted in this mode and the user has also requested a non-zero
4880 priority, the priority is honored and included in the VLAN tag.
4881 .RE
4882
4883 The default value is \fBvlanonly\fR.
4884 .RE
4885
4886 .SS "IP Tunnel Link Properties"
4887 .sp
4888 .LP
4889 The following IP tunnel link properties are supported.
4890 .sp
4891 .ne 2
4892 .na
4893 \fB\fBhoplimit\fR\fR
4894 .ad
4895 .sp .6
4896 .RS 4n
4897 Specifies the IPv4 TTL or IPv6 hop limit for the encapsulating outer IP header
4898 of a tunnel link. This property exists for all tunnel types. The default value
4899 is 64.
4900 .RE
4901
4902 .sp
4903 .ne 2
4904 .na
4905 \fB\fBencaplimit\fR\fR
4906 .ad
4907 .sp .6
4908 .RS 4n
4909 Specifies the IPv6 encapsulation limit for an IPv6 tunnel as defined in RFC
4910 2473. This value is the tunnel nesting limit for a given tunneled packet. The
4911 default value is 4. A value of 0 disables the encapsulation limit.
4912 .RE
4913
4914 .SH EXAMPLES
4915 .LP
4916 \fBExample 1 \fRConfiguring an Aggregation
4917 .sp
4918 .LP
4919 To configure a data-link over an aggregation of devices \fBbge0\fR and
4920 \fBbge1\fR with key 1, enter the following command:
4921
4922 .sp
4923 .in +2
4924 .nf
4925 # \fBdladm create-aggr -d bge0 -d bge1 1\fR
4926 .fi
4927 .in -2
4928 .sp
4929
4930 .LP
4931 \fBExample 2 \fRConnecting to a WiFi Link
4932 .sp
4933 .LP
4934 To connect to the most optimal available unsecured network on a system with a
4935 single \fBWiFi\fR link (as per the prioritization rules specified for
4936 \fBconnect-wifi\fR), enter the following command:
4937
4938 .sp
4939 .in +2
4940 .nf
4941 # \fBdladm connect-wifi\fR
4942 .fi
4943 .in -2
4944 .sp
4945
4946 .LP
4947 \fBExample 3 \fRCreating a WiFi Key
4948 .sp
4949 .LP
4950 To interactively create the \fBWEP\fR key \fBmykey\fR, enter the following
4951 command:
4952
4953 .sp
4954 .in +2
4955 .nf
4956 # \fBdladm create-secobj -c wep mykey\fR
4957 .fi
4958 .in -2
4959 .sp
4960
4961 .sp
4962 .LP
4963 Alternatively, to non-interactively create the \fBWEP\fR key \fBmykey\fR using
4964 the contents of a file:
4965
4966 .sp
4967 .in +2
4968 .nf
4969 # \fBumask 077\fR
4970 # \fBcat >/tmp/mykey.$$ <<EOF\fR
4971 \fB12345\fR
4972 \fBEOF\fR
4973 # \fBdladm create-secobj -c wep -f /tmp/mykey.$$ mykey\fR
4974 # \fBrm /tmp/mykey.$$\fR
4975 .fi
4976 .in -2
4977 .sp
4978
4979 .LP
4980 \fBExample 4 \fRConnecting to a Specified Encrypted WiFi Link
4981 .sp
4982 .LP
4983 To use key \fBmykey\fR to connect to \fBESSID\fR \fBwlan\fR on link \fBath0\fR,
4984 enter the following command:
4985
4986 .sp
4987 .in +2
4988 .nf
4989 # \fBdladm connect-wifi -k mykey -e wlan ath0\fR
4990 .fi
4991 .in -2
4992 .sp
4993
4994 .LP
4995 \fBExample 5 \fRChanging a Link Property
4996 .sp
4997 .LP
4998 To set \fBpowermode\fR to the value \fBfast\fR on link \fBpcwl0\fR, enter the
4999 following command:
5000
5001 .sp
5002 .in +2
5003 .nf
5004 # \fBdladm set-linkprop -p powermode=fast pcwl0\fR
5005 .fi
5006 .in -2
5007 .sp
5008
5009 .LP
5010 \fBExample 6 \fRConnecting to a WPA-Protected WiFi Link
5011 .sp
5012 .LP
5013 Create a WPA key \fBpsk\fR and enter the following command:
5014
5015 .sp
5016 .in +2
5017 .nf
5018 # \fBdladm create-secobj -c wpa psk\fR
5019 .fi
5020 .in -2
5021 .sp
5022
5023 .sp
5024 .LP
5025 To then use key \fBpsk\fR to connect to ESSID \fBwlan\fR on link \fBath0\fR,
5026 enter the following command:
5027
5028 .sp
5029 .in +2
5030 .nf
5031 # \fBdladm connect-wifi -k psk -e wlan ath0\fR
5032 .fi
5033 .in -2
5034 .sp
5035
5036 .LP
5037 \fBExample 7 \fRRenaming a Link
5038 .sp
5039 .LP
5040 To rename the \fBbge0\fR link to \fBmgmt0\fR, enter the following command:
5041
5042 .sp
5043 .in +2
5044 .nf
5045 # \fBdladm rename-link bge0 mgmt0\fR
5046 .fi
5047 .in -2
5048 .sp
5049
5050 .LP
5051 \fBExample 8 \fRReplacing a Network Card
5052 .sp
5053 .LP
5054 Consider that the \fBbge0\fR device, whose link was named \fBmgmt0\fR as shown
5055 in the previous example, needs to be replaced with a \fBce0\fR device because
5056 of a hardware failure. The \fBbge0\fR NIC is physically removed, and replaced
5057 with a new \fBce0\fR NIC. To associate the newly added \fBce0\fR device with
5058 the \fBmgmt0\fR configuration previously associated with \fBbge0\fR, enter the
5059 following command:
5060
5061 .sp
5062 .in +2
5063 .nf
5064 # \fBdladm rename-link ce0 mgmt0\fR
5065 .fi
5066 .in -2
5067 .sp
5068
5069 .LP
5070 \fBExample 9 \fRRemoving a Network Card
5071 .sp
5072 .LP
5073 Suppose that in the previous example, the intent is not to replace the
5074 \fBbge0\fR NIC with another NIC, but rather to remove and not replace the
5075 hardware. In that case, the \fBmgmt0\fR datalink configuration is not slated to
5076 be associated with a different physical device as shown in the previous
5077 example, but needs to be deleted. Enter the following command to delete the
5078 datalink configuration associated with the \fBmgmt0\fR datalink, whose physical
5079 hardware (\fBbge0\fR in this case) has been removed:
5080
5081 .sp
5082 .in +2
5083 .nf
5084 # \fBdladm delete-phys mgmt0\fR
5085 .fi
5086 .in -2
5087 .sp
5088
5089 .LP
5090 \fBExample 10 \fRUsing Parseable Output to Capture a Single Field
5091 .sp
5092 .LP
5093 The following assignment saves the MTU of link \fBnet0\fR to a variable named
5094 \fBmtu\fR.
5095
5096 .sp
5097 .in +2
5098 .nf
5099 # \fBmtu=`dladm show-link -p -o mtu net0`\fR
5100 .fi
5101 .in -2
5102 .sp
5103
5104 .LP
5105 \fBExample 11 \fRUsing Parseable Output to Iterate over Links
5106 .sp
5107 .LP
5108 The following script displays the state of each link on the system.
5109
5110 .sp
5111 .in +2
5112 .nf
5113 # \fBdladm show-link -p -o link,state | while IFS=: read link state; do
5114 print "Link $link is in state $state"
5115 done\fR
5116 .fi
5117 .in -2
5118 .sp
5119
5120 .LP
5121 \fBExample 12 \fRConfiguring VNICs
5122 .sp
5123 .LP
5124 Create two VNICs with names \fBhello0\fR and \fBtest1\fR over a single physical
5125 link \fBbge0\fR:
5126
5127 .sp
5128 .in +2
5129 .nf
5130 # \fBdladm create-vnic -l bge0 hello0\fR
5131 # \fBdladm create-vnic -l bge0 test1\fR
5132 .fi
5133 .in -2
5134 .sp
5135
5136 .LP
5137 \fBExample 13 \fRConfiguring VNICs and Allocating Bandwidth and Priority
5138 .sp
5139 .LP
5140 Create two VNICs with names \fBhello0\fR and \fBtest1\fR over a single physical
5141 link \fBbge0\fR and make \fBhello0\fR a high priority VNIC with a
5142 factory-assigned MAC address with a maximum bandwidth of 50 Mbps. Make
5143 \fBtest1\fR a low priority VNIC with a random MAC address and a maximum
5144 bandwidth of 100Mbps.
5145
5146 .sp
5147 .in +2
5148 .nf
5149 # \fBdladm create-vnic -l bge0 -m factory -p maxbw=50,priority=high hello0\fR
5150 # \fBdladm create-vnic -l bge0 -m random -p maxbw=100M,priority=low test1\fR
5151 .fi
5152 .in -2
5153 .sp
5154
5155 .LP
5156 \fBExample 14 \fRConfiguring a VNIC with a Factory MAC Address
5157 .sp
5158 .LP
5159 First, list the available factory MAC addresses and choose one of them:
5160
5161 .sp
5162 .in +2
5163 .nf
5164 # \fBdladm show-phys -m bge0\fR
5165 LINK SLOT ADDRESS INUSE CLIENT
5166 bge0 primary 0:e0:81:27:d4:47 yes bge0
5167 bge0 1 8:0:20:fe:4e:a5 no
5168 bge0 2 8:0:20:fe:4e:a6 no
5169 bge0 3 8:0:20:fe:4e:a7 no
5170 .fi
5171 .in -2
5172 .sp
5173
5174 .sp
5175 .LP
5176 Create a VNIC named \fBhello0\fR and use slot 1's address:
5177
5178 .sp
5179 .in +2
5180 .nf
5181 # \fBdladm create-vnic -l bge0 -m factory -n 1 hello0\fR
5182 # \fBdladm show-phys -m bge0\fR
5183 LINK SLOT ADDRESS INUSE CLIENT
5184 bge0 primary 0:e0:81:27:d4:47 yes bge0
5185 bge0 1 8:0:20:fe:4e:a5 yes hello0
5186 bge0 2 8:0:20:fe:4e:a6 no
5187 bge0 3 8:0:20:fe:4e:a7 no
5188 .fi
5189 .in -2
5190 .sp
5191
5192 .LP
5193 \fBExample 15 \fRCreating a VNIC with User-Specified MAC Address, Binding it to
5194 Set of Processors
5195 .sp
5196 .LP
5197 Create a VNIC with name \fBhello0\fR, with a user specified MAC address, and a
5198 processor binding \fB0, 1, 2, 3\fR.
5199
5200 .sp
5201 .in +2
5202 .nf
5203 # \fBdladm create-vnic -l bge0 -m 8:0:20:fe:4e:b8 -p cpus=0,1,2,3 hello0\fR
5204 .fi
5205 .in -2
5206 .sp
5207
5208 .LP
5209 \fBExample 16 \fRCreating a Virtual Network Without a Physical NIC
5210 .sp
5211 .LP
5212 First, create an etherstub with name \fBstub1\fR:
5213
5214 .sp
5215 .in +2
5216 .nf
5217 # \fBdladm create-etherstub stub1\fR
5218 .fi
5219 .in -2
5220 .sp
5221
5222 .sp
5223 .LP
5224 Create two VNICs with names \fBhello0\fR and \fBtest1\fR on the etherstub. This
5225 operation implicitly creates a virtual switch connecting \fBhello0\fR and
5226 \fBtest1\fR.
5227
5228 .sp
5229 .in +2
5230 .nf
5231 # \fBdladm create-vnic -l stub1 hello0\fR
5232 # \fBdladm create-vnic -l stub1 test1\fR
5233 .fi
5234 .in -2
5235 .sp
5236
5237 .LP
5238 \fBExample 17 \fRShowing Network Usage
5239 .sp
5240 .LP
5241 Network usage statistics can be stored using the extended accounting facility,
5242 \fBacctadm\fR(1M).
5243
5244 .sp
5245 .in +2
5246 .nf
5247 # \fBacctadm -e basic -f /var/log/net.log net\fR
5248 # \fBacctadm net\fR
5249 Network accounting: active
5250 Network accounting file: /var/log/net.log
5251 Tracked Network resources: basic
5252 Untracked Network resources: src_ip,dst_ip,src_port,dst_port,protocol,
5253 dsfield
5254 .fi
5255 .in -2
5256 .sp
5257
5258 .sp
5259 .LP
5260 The saved historical data can be retrieved in summary form using the
5261 \fBshow-usage\fR subcommand:
5262
5263 .sp
5264 .in +2
5265 .nf
5266 # \fBdladm show-usage -f /var/log/net.log\fR
5267 LINK DURATION IPACKETS RBYTES OPACKETS OBYTES BANDWIDTH
5268 e1000g0 80 1031 546908 0 0 2.44 Kbps
5269 .fi
5270 .in -2
5271 .sp
5272
5273 .LP
5274 \fBExample 18 \fRDisplaying Bridge Information
5275 .sp
5276 .LP
5277 The following commands use the \fBshow-bridge\fR subcommand with no and various
5278 options.
5279
5280 .sp
5281 .in +2
5282 .nf
5283 # \fBdladm show-bridge\fR
5284 BRIDGE PROTECT ADDRESS PRIORITY DESROOT
5285 foo stp 32768/8:0:20:bf:f 32768 8192/0:d0:0:76:14:38
5286 bar stp 32768/8:0:20:e5:8 32768 8192/0:d0:0:76:14:38
5287
5288 # \fBdladm show-bridge -l foo\fR
5289 LINK STATE UPTIME DESROOT
5290 hme0 forwarding 117 8192/0:d0:0:76:14:38
5291 qfe1 forwarding 117 8192/0:d0:0:76:14:38
5292
5293 # \fBdladm show-bridge -s foo\fR
5294 BRIDGE DROPS FORWARDS
5295 foo 0 302
5296
5297 # \fBdladm show-bridge -ls foo\fR
5298 LINK DROPS RECV XMIT
5299 hme0 0 360832 31797
5300 qfe1 0 322311 356852
5301
5302 # \fBdladm show-bridge -f foo\fR
5303 DEST AGE FLAGS OUTPUT
5304 8:0:20:bc:a7:dc 10.860 -- hme0
5305 8:0:20:bf:f9:69 -- L hme0
5306 8:0:20:c0:20:26 17.420 -- hme0
5307 8:0:20:e5:86:11 -- L qfe1
5308 .fi
5309 .in -2
5310 .sp
5311
5312 .LP
5313 \fBExample 19 \fRCreating an IPv4 Tunnel
5314 .sp
5315 .LP
5316 The following sequence of commands creates and then displays a persistent IPv4
5317 tunnel link named \fBmytunnel0\fR between 66.1.2.3 and 192.4.5.6:
5318
5319 .sp
5320 .in +2
5321 .nf
5322 # \fBdladm create-iptun -T ipv4 -s 66.1.2.3 -d 192.4.5.6 mytunnel0\fR
5323 # \fBdladm show-iptun mytunnel0\fR
5324 LINK TYPE FLAGS SOURCE DESTINATION
5325 mytunnel0 ipv4 -- 66.1.2.3 192.4.5.6
5326 .fi
5327 .in -2
5328 .sp
5329
5330 .sp
5331 .LP
5332 A point-to-point IP interface can then be created over this tunnel link:
5333
5334 .sp
5335 .in +2
5336 .nf
5337 # \fBifconfig mytunnel0 plumb 10.1.0.1 10.1.0.2 up\fR
5338 .fi
5339 .in -2
5340 .sp
5341
5342 .sp
5343 .LP
5344 As with any other IP interface, configuration persistence for this IP interface
5345 is achieved by placing the desired \fBifconfig\fR commands (in this case, the
5346 command for "\fB10.1.0.1 10.1.0.2\fR") into \fB/etc/hostname.mytunnel0\fR.
5347
5348 .LP
5349 \fBExample 20 \fRCreating a 6to4 Tunnel
5350 .sp
5351 .LP
5352 The following command creates a 6to4 tunnel link. The IPv4 address of the 6to4
5353 router is 75.10.11.12.
5354
5355 .sp
5356 .in +2
5357 .nf
5358 # \fBdladm create-iptun -T 6to4 -s 75.10.11.12 sitetunnel0\fR
5359 # \fBdladm show-iptun sitetunnel0\fR
5360 LINK TYPE FLAGS SOURCE DESTINATION
5361 sitetunnel0 6to4 -- 75.10.11.12 --
5362 .fi
5363 .in -2
5364 .sp
5365
5366 .sp
5367 .LP
5368 The following command plumbs an IPv6 interface on this tunnel:
5369
5370 .sp
5371 .in +2
5372 .nf
5373 # \fBifconfig sitetunnel0 inet6 plumb up\fR
5374 # \fBifconfig sitetunnel0 inet6\fR
5375 sitetunnel0: flags=2200041 <UP,RUNNING,NONUD,IPv6> mtu 65515 index 3
5376 inet tunnel src 75.10.11.12
5377 tunnel hop limit 64
5378 inet6 2002:4b0a:b0c::1/16
5379 .fi
5380 .in -2
5381 .sp
5382
5383 .sp
5384 .LP
5385 Note that the system automatically configures the IPv6 address on the 6to4 IP
5386 interface. See \fBifconfig\fR(1M) for a description of how IPv6 addresses are
5387 configured on 6to4 tunnel links.
5388
5389 .SH ATTRIBUTES
5390 .sp
5391 .LP
5392 See \fBattributes\fR(5) for descriptions of the following attributes:
5393 .sp
5394 .LP
5395 \fB/usr/sbin\fR
5396 .sp
5397
5398 .sp
5399 .TS
5400 box;
5401 c | c
5402 l | l .
5403 ATTRIBUTE TYPE ATTRIBUTE VALUE
5404 _
5405 Interface Stability Committed
5406 .TE
5407
5408 .sp
5409 .LP
5410 \fB/sbin\fR
5411 .sp
5412
5413 .sp
5414 .TS
5415 box;
5416 c | c
5417 l | l .
5418 ATTRIBUTE TYPE ATTRIBUTE VALUE
5419 _
5420 Interface Stability Committed
5421 .TE
5422
5423 .SH SEE ALSO
5424 .sp
5425 .LP
5426 \fBacctadm\fR(1M), \fBautopush\fR(1M), \fBifconfig\fR(1M), \fBipsecconf\fR(1M),
5427 \fBndd\fR(1M), \fBpsrset\fR(1M), \fBwpad\fR(1M), \fBzonecfg\fR(1M),
5428 \fBattributes\fR(5), \fBieee802.3\fR(5), \fBdlpi\fR(7P)
5429 .SH NOTES
5430 .sp
5431 .LP
5432 The preferred method of referring to an aggregation in the aggregation
5433 subcommands is by its link name. Referring to an aggregation by its integer
5434 \fIkey\fR is supported for backward compatibility, but is not necessary. When
5435 creating an aggregation, if a \fIkey\fR is specified instead of a link name,
5436 the aggregation's link name will be automatically generated by \fBdladm\fR as
5437 \fBaggr\fR\fIkey\fR.