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