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