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