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