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