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