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