Print this page
3942 inject sanity into ipadm tcp buffer size properties
3943 _snd_lowat_fraction tcp tunable has no effect
Reviewed by: Adam Leventhal <ahl@delphix.com>
Reviewed by: Peng Dai <peng.dai@delphix.com>
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1m/ipadm.1m
+++ new/usr/src/man/man1m/ipadm.1m
1 1 '\" te
2 2 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
3 +.\" Copyright (c) 2013 by Delphix. All rights reserved.
3 4 .\" 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.
4 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 6 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 7 .TH IPADM 1M "May 14, 2012"
7 8 .SH NAME
8 9 ipadm \- configure IP network interfaces and protocol properties.
9 10 .SH SYNOPSIS
10 11 .LP
11 12 .nf
12 13 \fBipadm\fR create-if [\fB-t\fR] \fIinterface\fR
13 14 .fi
14 15
15 16 .LP
16 17 .nf
17 18 \fBipadm\fR disable-if [\fB-t\fR] \fIinterface\fR
18 19 .fi
19 20
20 21 .LP
21 22 .nf
22 23 \fBipadm\fR enable-if [\fB-t\fR] \fIinterface\fR
23 24 .fi
24 25
25 26 .LP
26 27 .nf
27 28 \fBipadm\fR delete-if \fIinterface\fR
28 29 .fi
29 30
30 31 .LP
31 32 .nf
32 33 \fBipadm\fR show-if [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR]
33 34 .fi
34 35
35 36 .LP
36 37 .nf
37 38 \fBipadm\fR set-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR
38 39 .fi
39 40
40 41 .LP
41 42 .nf
42 43 \fBipadm\fR reset-ifprop [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR
43 44 .fi
44 45
45 46 .LP
46 47 .nf
47 48 \fBipadm\fR show-ifprop [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR]
48 49 [\fIinterface\fR]
49 50 .fi
50 51
51 52 .LP
52 53 .nf
53 54 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR static [\fB-d\fR]
54 55 \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR
55 56 .fi
56 57
57 58 .LP
58 59 .nf
59 60 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR
60 61 .fi
61 62
62 63 .LP
63 64 .nf
64 65 \fBipadm\fR create-addr [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR]
65 66 [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR
66 67 .fi
67 68
68 69 .LP
69 70 .nf
70 71 \fBipadm\fR down-addr [\fB-t\fR] \fIaddrobj\fR
71 72 .fi
72 73
73 74 .LP
74 75 .nf
75 76 \fBipadm\fR up-addr [\fB-t\fR] \fIaddrobj\fR
76 77 .fi
77 78
78 79 .LP
79 80 .nf
80 81 \fBipadm\fR disable-addr [\fB-t\fR] \fIaddrobj\fR
81 82 .fi
82 83
83 84 .LP
84 85 .nf
85 86 \fBipadm\fR enable-addr [\fB-t\fR] \fIaddrobj\fR
86 87 .fi
87 88
88 89 .LP
89 90 .nf
90 91 \fBipadm\fR refresh-addr [\fB-i\fR] \fIaddrobj\fR
91 92 .fi
92 93
93 94 .LP
94 95 .nf
95 96 \fBipadm\fR delete-addr [\fB-r\fR] \fIaddrobj\fR
96 97 .fi
97 98
98 99 .LP
99 100 .nf
100 101 \fBipadm\fR show-addr [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]
101 102 .fi
102 103
103 104 .LP
104 105 .nf
105 106 \fBipadm\fR set-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
106 107 .fi
107 108
108 109 .LP
109 110 .nf
110 111 \fBipadm\fR reset-addrprop [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
111 112 .fi
112 113
113 114 .LP
114 115 .nf
115 116 \fBipadm\fR show-addrprop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fIaddrobj\fR]
116 117 .fi
117 118
118 119 .LP
119 120 .nf
120 121 \fBipadm\fR set-prop [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR
121 122 .fi
122 123
123 124 .LP
124 125 .nf
125 126 \fBipadm\fR reset-prop [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR
126 127 .fi
127 128
128 129 .LP
129 130 .nf
130 131 \fBipadm\fR show-prop [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIprotocol\fR]
131 132 .fi
132 133
133 134 .SH DESCRIPTION
134 135 .sp
135 136 .LP
136 137
137 138 The \fBipadm\fR command is a stable replacement for the \fBifconfig\fR(1M) and
138 139 \fBndd\fR(1M) commands. It is used to create IP interfaces and to confgure IP
139 140 addresses on those interfaces. It is also used to get, set or reset properties
140 141 on interfaces, addresses and protocols.
141 142 .LP
142 143 For subcommands that take an \fIaddrobj\fR, the \fIaddrobj\fR specifies a
143 144 unique address on the system. It is made up of two parts, delimited by a '/'.
144 145 The first part is the name of the interface and the second part is a string up
145 146 to 32 characters long. For example, "lo0/v4" is a loopback interface
146 147 addrobj name.
147 148 .LP
148 149 For subcommands that take a \fIprotocol\fR, this can be one of
149 150 the following values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
150 151
151 152 .SH SUBCOMMANDS
152 153 .sp
153 154 .LP
154 155 The following subcommands are supported:
155 156 .sp
156 157 .ne 2
157 158 .na
158 159 \fB\fBcreate-if\fR [\fB-t\fR] \fIinterface\fR\fR
159 160 .ad
160 161 .sp .6
161 162 .RS 4n
162 163 The \fBcreate-if\fR subcommand is used to create an IP interface that will
163 164 handle both IPv4 and IPv6 packets. The interface will be enabled as part of
164 165 the creation process. The IPv4 interface will have the address 0.0.0.0.
165 166 The IPv6 interface will have the adress ::.
166 167 .sp
167 168 The \fB-t\fR option (also \fB--temporary\fR) means
168 169 that the creation is temporary and will not be persistent across reboots.
169 170 .sp
170 171
171 172 .RE
172 173
173 174 .sp
174 175 .ne 2
175 176 .na
176 177 \fB\fBdisable-if\fR [\fB-t\fR] \fIinterface\fR\fR
177 178 .ad
178 179 .sp .6
179 180 .RS 4n
180 181 The \fBdisable-if\fR subcommand is used to disable an IP interface.
181 182 .sp
182 183 The \fB-t\fR option (also \fB--temporary\fR) means
183 184 that the disable is temporary and will not be persistent across reboots.
184 185 .sp
185 186
186 187 .RE
187 188
188 189 .sp
189 190 .ne 2
190 191 .na
191 192 \fB\fBenable-if\fR [\fB-t\fR] \fIinterface\fR\fR
192 193 .ad
193 194 .sp .6
194 195 .RS 4n
195 196 The \fBenable-if\fR subcommand is used to enable an IP interface.
196 197 .sp
197 198 The \fB-t\fR option (also \fB--temporary\fR) means
198 199 that the enable is temporary and will not be persistent across reboots.
199 200 .sp
200 201
201 202 .RE
202 203
203 204 .sp
204 205 .ne 2
205 206 .na
206 207 \fB\fbdelete-if\fR \fIinterface\fR\fR
207 208 .ad
208 209 .sp .6
209 210 .RS 4n
210 211 The \fBdelete-if\fR subcommand is used to permanently delete an IP interface.
211 212 .sp
212 213
213 214 .RE
214 215
215 216 .sp
216 217 .ne 2
217 218 .na
218 219 \fB\fBshow-if\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIinterface\fR]\fR
219 220 .ad
220 221 .sp .6
221 222 .RS 4n
222 223 The \fBshow-if\fR subcommand is used to show the current IP interface
223 224 configuration.
224 225 .sp
225 226 The \fB-p\fR option (also \fB--parsable\fR) prints
226 227 the output in a parsable format.
227 228 .sp
228 229 The \fB-o\fR option (also \fB--output\fR) is used
229 230 to select which fields will be shown. The field value can be one of the
230 231 following names:
231 232 .sp
232 233 .ne 2
233 234 .na
234 235 .RS 4n
235 236 \fBALL\fR
236 237 .ad
237 238 .RS 4n
238 239 Display all fields
239 240 .RE
240 241
241 242 .sp
242 243 .ne 2
243 244 .na
244 245 \fBIFNAME\fR
245 246 .ad
246 247 .RS 4n
247 248 The name of the interface
248 249 .RE
249 250
250 251 .sp
251 252 .ne 2
252 253 .na
253 254 \fBSTATE\fR
254 255 .ad
255 256 .RS 4n
256 257 The state can be one of the following values:
257 258 .sp
258 259 .ne 2
259 260 .na
260 261 .RS 4n
261 262 ok - resources for the interface have been allocated
262 263 .sp
263 264 offline - the interface is offline
264 265 .sp
265 266 failed - the interface's datalink is down
266 267 .sp
267 268 down - the interface is down
268 269 .sp
269 270 disabled - the interface is disabled
270 271 .RE
271 272 .RE
272 273
273 274 .sp
274 275 .ne 2
275 276 .na
276 277 \fBCURRENT\fR
277 278 .ad
278 279 .RS 4n
279 280 A set of single character flags indicating the following:
280 281 .sp
281 282 .ne 2
282 283 .na
283 284 .RS 4n
284 285 b - broadcast (mutually exclusive with 'p')
285 286 .br
286 287 m - multicast
287 288 .br
288 289 p - point-to-point (mutually exclusive with 'b')
289 290 .br
290 291 v - virtual interface
291 292 .br
292 293 I - IPMP
293 294 .br
294 295 s - IPMP standby
295 296 .br
296 297 i - IPMP inactive
297 298 .br
298 299 V - VRRP
299 300 .br
300 301 a - VRRP accept mode
301 302 .br
302 303 4 - IPv4
303 304 .br
304 305 6 - IPv6
305 306 .RE
306 307 .RE
307 308
308 309 .sp
309 310 .ne 2
310 311 .na
311 312 \fBPERSISTENT\fR
312 313 .ad
313 314 .RS 4n
314 315 A set of single character flags showing what configuration will be used the
315 316 next time the interface is enabled:
316 317 .sp
317 318 .ne 2
318 319 .na
319 320 .RS 4n
320 321 s - IPMP standby
321 322 .br
322 323 4 - IPv4
323 324 .br
324 325 6 - IPv6
325 326 .RE
326 327 .RE
327 328 .RE
328 329
329 330 .RE
330 331
331 332 .sp
332 333 .ne 2
333 334 .na
334 335 \fB\fBset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR
335 336 .ad
336 337 .sp .6
337 338 .RS 4n
338 339 The \fBset-ifprop\fR subcommand is used to set a property's value(s) on the IP
339 340 interface.
340 341 .sp
341 342 The \fB-t\fR option (also \fB--temporary\fR) means
342 343 that the setting is temporary and will not be persistent across reboots.
343 344 .sp
344 345 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
345 346 value(s). The property name can be one of the following:
346 347 .sp
347 348 .ne 2
348 349 .na
349 350
350 351 .RS 4n
351 352
352 353 \fBarp\fR
353 354 .ad
354 355 .RS 4n
355 356 Enables ("on") or disables ("off") ARP.
356 357 .RE
357 358
358 359 .sp
359 360 .ne 2
360 361 .na
361 362 \fBexchange_routes\fR
362 363 .ad
363 364 .RS 4n
364 365 Enables ("on") or disables ("off") the exchange of routing data.
365 366 .RE
366 367
367 368 .sp
368 369 .ne 2
369 370 .na
370 371 \fBforwarding\fR
371 372 .ad
372 373 .RS 4n
373 374 Enables ("on") or disables ("off") IP forwarding.
374 375 .RE
375 376
376 377 .sp
377 378 .ne 2
378 379 .na
379 380 \fBmetric\fR
380 381 .ad
381 382 .RS 4n
382 383 Set the routing metric to the numeric value. The value is treated as extra
383 384 hops to the destination.
384 385 .RE
385 386
386 387 .sp
387 388 .ne 2
388 389 .na
389 390 \fBmtu\fR
390 391 .ad
391 392 .RS 4n
392 393 Set the maximum transmission unit to the numeric value.
393 394 .RE
394 395
395 396 .sp
396 397 .ne 2
397 398 .na
398 399 \fBnud\fR
399 400 .ad
400 401 .RS 4n
401 402 Enables ("on") or disables ("off") neighbor unreachability detection.
402 403 .RE
403 404
404 405 .sp
405 406 .ne 2
406 407 .na
407 408 \fBusesrc\fR
408 409 .ad
409 410 .RS 4n
410 411 Indicates which interface to use for source address selection. A value
411 412 "none" may also be used.
412 413 .RE
413 414 .RE
414 415
415 416 .sp
416 417 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
417 418 the setting applies to.
418 419 .sp
419 420
420 421 .RE
421 422 .RE
422 423
423 424 .sp
424 425 .ne 2
425 426 .na
426 427 \fB\fBreset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR
427 428 .ad
428 429 .sp .6
429 430 .RS 4n
430 431 The \fBreset-ifprop\fR subcommand is used to reset an IP interface's property
431 432 value to the default.
432 433 .sp
433 434 The \fB-t\fR option (also \fB--temporary\fR) means
434 435 that the disable is temporary and will not be persistent across reboots.
435 436 .sp
436 437 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
437 438 See the \fBset-ifprop\fR subcommand for the list of property names.
438 439 .sp
439 440 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
440 441 the setting applies to.
441 442 .sp
442 443
443 444 .RE
444 445
445 446 .sp
446 447 .ne 2
447 448 .na
448 449 \fB\fBshow-ifprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR]
449 450 [\fIinterface\fR]\fR
450 451 .ad
451 452 .sp .6
452 453 .RS 4n
453 454 The \fBshow-ifprop\fR subcommand is used to display the property values
454 455 for one or all of the IP interfaces.
455 456 .sp
456 457 The \fB-c\fR option (also \fB--parsable\fR) prints
457 458 the output in a parsable format.
458 459 .sp
459 460 The \fB-o\fR option (also \fB--output\fR) is used
460 461 to select which fields will be shown. The field value can be one of the
461 462 following names:
462 463 .sp
463 464 .ne 2
464 465 .na
465 466 .RS 4n
466 467 \fBALL\fR
467 468 .ad
468 469 .RS 4n
469 470 Display all fields
470 471 .RE
471 472
472 473 .sp
473 474 .ne 2
474 475 .na
475 476 \fBIFNAME\fR
476 477 .ad
477 478 .RS 4n
478 479 The name of the interface
479 480 .RE
480 481
481 482 .sp
482 483 .ne 2
483 484 .na
484 485 \fBPROPERTY\fR
485 486 .ad
486 487 .RS 4n
487 488 The name of the property
488 489 .RE
489 490
490 491 .sp
491 492 .ne 2
492 493 .na
493 494 \fBPROTO\fR
494 495 .ad
495 496 .RS 4n
496 497 The name of the protocol
497 498 .RE
498 499
499 500 .sp
500 501 .ne 2
501 502 .na
502 503 \fBPERM\fR
503 504 .ad
504 505 .RS 4n
505 506 If the property is readable ("r") and/or writable ("w").
506 507 .RE
507 508
508 509 .sp
509 510 .ne 2
510 511 .na
511 512 \fBCURRENT\fR
512 513 .ad
513 514 .RS 4n
514 515 The value of the property
515 516 .RE
516 517
517 518 .sp
518 519 .ne 2
519 520 .na
520 521 \fBPERSISTENT\fR
521 522 .ad
522 523 .RS 4n
523 524 The persistent value of the property
524 525 .RE
525 526
526 527 .sp
527 528 .ne 2
528 529 .na
529 530 \fBDEFAULT\fR
530 531 .ad
531 532 .RS 4n
532 533 The default value of the property
533 534 .RE
534 535
535 536 .sp
536 537 .ne 2
537 538 .na
538 539 \fBPOSSIBLE\fR
539 540 .ad
540 541 .RS 4n
541 542 The possible values for the property
542 543 .RE
543 544 .RE
544 545
545 546 .sp
546 547 The \fB-p\fR option (also \fB--prop\fR) is used
547 548 to specify which properties to display. See the \fBset-ifprop\fR
548 549 subcommand for the list of property names.
549 550 .sp
550 551 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
551 552 to display.
552 553 .sp
553 554
554 555 .RE
555 556
556 557 .sp
557 558 .ne 2
558 559 .na
559 560 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR static [\fB-d\fR] \\
560 561 \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR\fR
561 562 .br
562 563 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR\fR
563 564 .br
564 565 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR] \\
565 566 [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR\fR
566 567 .ad
567 568 .sp .6
568 569 .RS 4n
569 570 The \fBcreate-addr\fR subcommand is used to set an address on an IP interface.
570 571 The address will be enabled but can disabled using the \fBdisable-addr\fR
571 572 subcommand. This subcommand has three different forms, depending on the
572 573 value of the \fB-T\fR option.
573 574 .sp
574 575 The \fB-t\fR option (also \fB--temporary\fR) means
575 576 that the address is temporary and will not be persistent across reboots.
576 577 .sp
577 578 The \fB-T\fR static option creates a static addrobj. This takes the following
578 579 options:
579 580 .RS 4n
580 581
581 582 The \fB-d\fR option (also \fB--down\fR) means the address is down.
582 583 .sp
583 584 The \fB-a\fR option (also \fB--address\fR) specifies the address.
584 585 The "local" or "remote" prefix can be used for a point-to-point interface.
585 586 In this case, both addresses must be given.
586 587 Otherwise, the equal sign ("=") should be omitted and the address should be
587 588 provided by itself and with no second address.
588 589 .sp
589 590
590 591 .RE
591 592
592 593 The \fB-T\fR dhcp option causes the address to be obtained via DHCP.
593 594 This takes the following options:
594 595 .RS 4n
595 596
596 597 The \fB-w\fR option (also \fB--wait\fR) gives the time, in seconds,
597 598 that the command should wait to obtain an address.
598 599 .sp
599 600
600 601 .RE
601 602
602 603 The \fB-T\fR addrconf option creates an auto-configured address.
603 604 This takes the following options:
604 605 .RS 4n
605 606
606 607 The \fB-i\fR option (also \fB--interface-id\fR) gives the interface ID to
607 608 be used.
608 609 .sp
609 610 The \fB-p\fR option (also \fB--prop\fR) indicates which method of
610 611 auto-configuration should be used.
611 612 .sp
612 613
613 614 .RE
614 615 .RE
615 616
616 617 .sp
617 618 .ne 2
618 619 .na
619 620 \fB\fBdown-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
620 621 .ad
621 622 .sp .6
622 623 .RS 4n
623 624 The \fBdown-addr\fR subcommand is used to down the address. This will
624 625 stop packets from being sent or received.
625 626 .sp
626 627 The \fB-t\fR option (also \fB--temporary\fR) means
627 628 that the down is temporary and will not be persistent across reboots.
628 629 .sp
629 630
630 631 .RE
631 632
632 633 .sp
633 634 .ne 2
634 635 .na
635 636 \fB\fBup-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
636 637 .ad
637 638 .sp .6
638 639 .RS 4n
639 640 The \fBup-addr\fR subcommand is used to up the address. This will
640 641 enable packets to be sent and received.
641 642 .sp
642 643 The \fB-t\fR option (also \fB--temporary\fR) means
643 644 that the up is temporary and will not be persistent across reboots.
644 645 .sp
645 646
646 647 .RE
647 648
648 649 .sp
649 650 .ne 2
650 651 .na
651 652 \fB\fBdisable-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
652 653 .ad
653 654 .sp .6
654 655 .RS 4n
655 656 The \fBdisable-addr\fR subcommand is used to disable the address.
656 657 .sp
657 658 The \fB-t\fR option (also \fB--temporary\fR) means
658 659 that the disable is temporary and will not be persistent across reboots.
659 660 .sp
660 661
661 662 .RE
662 663
663 664 .sp
664 665 .ne 2
665 666 .na
666 667 \fB\fBenable-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
667 668 .ad
668 669 .sp .6
669 670 .RS 4n
670 671 The \fBenable-addr\fR subcommand is used to enable the address.
671 672 .sp
672 673 The \fB-t\fR option (also \fB--temporary\fR) means
673 674 that the enable is temporary and will not be persistent across reboots.
674 675 .sp
675 676
676 677 .RE
677 678
678 679 .sp
679 680 .ne 2
680 681 .na
681 682 \fB\fBrefresh-addr\fR [\fB-i\fR] \fIaddrobj\fR\fR
682 683 .ad
683 684 .sp .6
684 685 .RS 4n
685 686 The \fBrefresh-addr\fR subcommand is used to extend the lease for DHCP
686 687 addresses. It also restarts duplicate address detection for Static addresses.
687 688 .sp
688 689 The \fB-i\fR option (also \fB--inform\fR) means
689 690 that the network configuration will be obtained from DHCP without taking
690 691 a lease on the address.
691 692 .sp
692 693
693 694 .RE
694 695
695 696 .sp
696 697 .ne 2
697 698 .na
698 699 \fB\fBdelete-addr\fR [\fB-r\fR] \fIaddrobj\fR\fR
699 700 .ad
700 701 .sp .6
701 702 .RS 4n
702 703 The \fBdelete-addr\fR subcommand deletes the given address.
703 704 .sp
704 705 The \fB-r\fR option (also \fB--release\fR) is used for DHCP-assigned
705 706 addresses to indicate that the address should be released.
706 707 .sp
707 708
708 709 .RE
709 710
710 711 .sp
711 712 .ne 2
712 713 .na
713 714 \fB\fBshow-addr\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]\fR
714 715 .ad
715 716 .sp .6
716 717 .RS 4n
717 718 The \fBshow-addr\fR subcommand is used to show the current address properties.
718 719 .sp
719 720 The \fB-p\fR option (also \fB--parsable\fR) prints
720 721 the output in a parsable format.
721 722 .sp
722 723 The \fB-o\fR option (also \fB--output\fR) is used
723 724 to select which fields will be shown. The field value can be one of the
724 725 following names:
725 726 .sp
726 727 .ne 2
727 728 .na
728 729 .RS 4n
729 730 \fBALL\fR
730 731 .ad
731 732 .RS 4n
732 733 Display all fields
733 734 .RE
734 735
735 736 .sp
736 737 .ne 2
737 738 .na
738 739 \fBADDROBJ\fR
739 740 .ad
740 741 .RS 4n
741 742 The name of the address
742 743 .RE
743 744
744 745 .sp
745 746 .ne 2
746 747 .na
747 748 \fBTYPE\fR
748 749 .ad
749 750 .RS 4n
750 751 The type of the address. It can be "static", "dhcp" or "addrconf".
751 752 .RE
752 753
753 754 .sp
754 755 .ne 2
755 756 .na
756 757 \fBSTATE\fR
757 758 .ad
758 759 .RS 4n
759 760 The state of the address. It can be one of the following values:
760 761 .sp
761 762 .ne 2
762 763 .na
763 764 .RS 4n
764 765 disabled s see the \fBdisable-addr\fR subcommand
765 766 .sp
766 767 down - see the \fBdown-addr\fR subcommand
767 768 .sp
768 769 duplicate - the address is a duplicate
769 770 .sp
770 771 inaccessible - the interface for this address has failed
771 772 .sp
772 773 ok - the address is up
773 774 .sp
774 775 tentative - duplicate address detection in progress
775 776 .RE
776 777 .RE
777 778
778 779 .sp
779 780 .ne 2
780 781 .na
781 782 \fBCURRENT\fR
782 783 .ad
783 784 .RS 4n
784 785 A set of single character flags indicating the following:
785 786 .sp
786 787 .ne 2
787 788 .na
788 789 .RS 4n
789 790 U - up
790 791 .br
791 792 u - unnumbered (matches another local address)
792 793 .br
793 794 p - private, not advertised to routing
794 795 .br
795 796 t - temporary IPv6 address
796 797 .br
797 798 d - deprecated (not used for outgoing packets)
798 799 .RE
799 800 .RE
800 801
801 802 .sp
802 803 .ne 2
803 804 .na
804 805 \fBPERSISTENT\fR
805 806 .ad
806 807 .RS 4n
807 808 A set of single character flags showing the configuration which will be used
808 809 when the address is enabled.
809 810 .sp
810 811 .ne 2
811 812 .na
812 813 .RS 4n
813 814 U - up
814 815 .br
815 816 p - private, not advertised to routing
816 817 .br
817 818 d - deprecated (not used for outgoing packets)
818 819 .RE
819 820 .RE
820 821
821 822 .sp
822 823 .ne 2
823 824 .na
824 825 \fBADDR\fR
825 826 .ad
826 827 .RS 4n
827 828 The address
828 829 .RE
829 830 .RE
830 831
831 832 .RE
832 833
833 834 .sp
834 835 .ne 2
835 836 .na
836 837 \fB\fBset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
837 838 .ad
838 839 .sp .6
839 840 .RS 4n
840 841 The \fBset-addrprop\fR subcommand is used to set a property's value(s) on the
841 842 addrobj.
842 843 .sp
843 844 The \fB-t\fR option (also \fB--temporary\fR) means
844 845 that the setting is temporary and will not be persistent across reboots.
845 846 .sp
846 847 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
847 848 value(s). The property name can be one of the following:
848 849 .sp
849 850 .ne 2
850 851 .na
851 852
852 853 .RS 4n
853 854
854 855 \fBbroadcast\fR
855 856 .ad
856 857 .RS 4n
857 858 The broadcast address (read-only)
858 859 .RE
859 860
860 861 .sp
861 862 .ne 2
862 863 .na
863 864 \fBdeprecated\fR
864 865 .ad
865 866 .RS 4n
866 867 The address should not be used to send packets but can still receive packets.
867 868 Can be "on" or "off".
868 869 .RE
869 870
870 871 .sp
871 872 .ne 2
872 873 .na
873 874 \fBprefixlen\fR
874 875 .ad
875 876 .RS 4n
876 877 The number of bits in the IPv4 netmask or IPv6 prefix.
877 878 .RE
878 879
879 880 .sp
880 881 .ne 2
881 882 .na
882 883 \fBprivate\fR
883 884 .ad
884 885 .RS 4n
885 886 The address is not advertised to routing.
886 887 Can be "on" or "off".
887 888 .RE
888 889
889 890 .sp
890 891 .ne 2
891 892 .na
892 893 \fBtransmit\fR
893 894 .ad
894 895 .RS 4n
895 896 Packets can be transmitted.
896 897 Can be "on" or "off".
897 898 .RE
898 899
899 900 .sp
900 901 .ne 2
901 902 .na
902 903 \fBzone\fR
903 904 .ad
904 905 .RS 4n
905 906 The zone the addrobj is in.
906 907 .RE
907 908
908 909 .RE
909 910 .RE
910 911
911 912 .sp
912 913 .ne 2
913 914 .na
914 915 \fB\fBreset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIaddrobj\fR\fR
915 916 .ad
916 917 .sp .6
917 918 .RS 4n
918 919 The \fBreset-addrprop\fR subcommand is used to reset an addrobj's property
919 920 value to the default.
920 921 .sp
921 922 The \fB-t\fR option (also \fB--temporary\fR) means
922 923 that the disable is temporary and will not be persistent across reboots.
923 924 .sp
924 925 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
925 926 See the \fBset-addrprop\fR subcommand for the list of property names.
926 927 .sp
927 928
928 929 .RE
929 930
930 931 .sp
931 932 .ne 2
932 933 .na
933 934 \fB\fBshow-addrprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIaddrobj\fR]
934 935 .ad
935 936 .sp .6
936 937 .RS 4n
937 938 The \fBshow-addrprop\fR subcommand is used to display the property values
938 939 for one or all of the addrobjs.
939 940 .sp
940 941 The \fB-c\fR option (also \fB--parsable\fR) prints
941 942 the output in a parsable format.
942 943 .sp
943 944 The \fB-o\fR option (also \fB--output\fR) is used
944 945 to select which fields will be shown. The field value can be one of the
945 946 following names:
946 947 .sp
947 948 .ne 2
948 949 .na
949 950 .RS 4n
950 951 \fBALL\fR
951 952 .ad
952 953 .RS 4n
953 954 Display all fields
954 955 .RE
955 956
956 957 .sp
957 958 .ne 2
958 959 .na
959 960 \fBADDROBJ\fR
960 961 .ad
961 962 .RS 4n
962 963 The name of the addrobj
963 964 .RE
964 965
965 966 .sp
966 967 .ne 2
967 968 .na
968 969 \fBPROPERTY\fR
969 970 .ad
970 971 .RS 4n
971 972 The name of the property
972 973 .RE
973 974
974 975 .sp
975 976 .ne 2
976 977 .na
977 978 \fBPERM\fR
978 979 .ad
979 980 .RS 4n
980 981 If the property is readable ("r") and/or writable ("w").
981 982 .RE
982 983
983 984 .sp
984 985 .ne 2
985 986 .na
986 987 \fBCURRENT\fR
987 988 .ad
988 989 .RS 4n
989 990 The value of the property
990 991 .RE
991 992
992 993 .sp
993 994 .ne 2
994 995 .na
995 996 \fBPERSISTENT\fR
996 997 .ad
997 998 .RS 4n
998 999 The persistent value of the property
999 1000 .RE
1000 1001
1001 1002 .sp
1002 1003 .ne 2
1003 1004 .na
1004 1005 \fBDEFAULT\fR
1005 1006 .ad
1006 1007 .RS 4n
1007 1008 The default value of the property
1008 1009 .RE
1009 1010
1010 1011 .sp
1011 1012 .ne 2
1012 1013 .na
1013 1014 \fBPOSSIBLE\fR
1014 1015 .ad
1015 1016 .RS 4n
1016 1017 The possible values for the property
1017 1018 .RE
1018 1019 .RE
1019 1020
1020 1021 .sp
1021 1022 The \fB-p\fR option (also \fB--prop\fR) is used
1022 1023 to specify which properties to display. See the \fBset-addrprop\fR
1023 1024 subcommand for the list of property names.
1024 1025 .sp
1025 1026
1026 1027 .RE
1027 1028
1028 1029 .sp
1029 1030 .ne 2
1030 1031 .na
1031 1032 \fB\fBset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR
1032 1033 .ad
1033 1034 .sp .6
1034 1035 .RS 4n
1035 1036 The \fBset-prop\fR subcommand is used to set a property's value(s) on the
1036 1037 protocol.
1037 1038 .sp
1038 1039 The \fB-t\fR option (also \fB--temporary\fR) means
1039 1040 that the setting is temporary and will not be persistent across reboots.
1040 1041 .sp
1041 1042 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
1042 1043 value(s). The optional [+|-] syntax can be used to add/remove values from the
1043 1044 current list of values on the property.
1044 1045 The property name can be one of the following:
1045 1046 .sp
1046 1047 .ne 2
1047 1048 .na
1048 1049
1049 1050 .RS 4n
1050 1051
1051 1052 \fBecn\fR
1052 1053 .ad
1053 1054 .RS 4n
1054 1055 Explicit congestion control (TCP-only)
1055 1056 Can be "never", "passive" or "active".
1056 1057 .RE
1057 1058
1058 1059 \fBextra_priv_ports\fR
1059 1060 .ad
1060 1061 .RS 4n
1061 1062 Additional privileged ports (SCTP, TCP or UDP)
1062 1063 .RE
1063 1064
1064 1065 \fBforwarding\fR
1065 1066 .ad
1066 1067 .RS 4n
1067 1068 Packet forwarding is enabled.
1068 1069 Can be "on" or "off".
1069 1070 .RE
1070 1071
1071 1072 \fBhoplimit\fR
1072 1073 .ad
↓ open down ↓ |
1060 lines elided |
↑ open up ↑ |
1073 1074 .RS 4n
1074 1075 The IPv6 hoplimit.
1075 1076 .RE
1076 1077
1077 1078 \fBlargest_anon_port\fR
1078 1079 .ad
1079 1080 .RS 4n
1080 1081 Largest ephemeral port (SCTP, TCP or UDP)
1081 1082 .RE
1082 1083
1083 -\fBrecv_maxbuf\fR
1084 +\fBmax_buf\fR
1084 1085 .ad
1085 1086 .RS 4n
1086 -Receive buffer size (ICMP, SCTP, TCP or UDP)
1087 +Maximum receive or send buffer size (ICMP, SCTP, TCP, or UDP). This also
1088 +sets the upper limit for the \fBrecv_buf\fB and \fBsend_buf\fB properties.
1087 1089 .RE
1088 1090
1091 +\fBrecv_buf\fR
1092 +.ad
1093 +.RS 4n
1094 +Default receive buffer size (ICMP, SCTP, TCP, or UDP). The maximum value for
1095 +this property is controlled by the \fBmax_buf\fR property.
1096 +.RE
1097 +
1089 1098 \fBsack\fR
1090 1099 .ad
1091 1100 .RS 4n
1092 1101 Selective acknowledgement (TCP).
1093 1102 Can be "active", "passive" or "never".
1094 1103 .RE
1095 1104
1096 -\fBsend_maxbuf\fR
1105 +\fBsend_buf\fR
1097 1106 .ad
1098 1107 .RS 4n
1099 -Send buffer size (ICMP, SCTP, TCP or UDP)
1108 +Default send buffer size (ICMP, SCTP, TCP, or UDP). The maximum value for
1109 +this property is controlled by the \fBmax_buf\fR property.
1100 1110 .RE
1101 1111
1102 1112 \fBsmallest_anon_port\fR
1103 1113 .ad
1104 1114 .RS 4n
1105 1115 Smallest ephemeral port (SCTP, TCP or UDP)
1106 1116 .RE
1107 1117
1108 1118 \fBsmallest_nonpriv_port\fR
1109 1119 .ad
1110 1120 .RS 4n
1111 1121 Smallest non-privileged port (SCTP, TCP or UDP)
1112 1122 .RE
1113 1123
1114 1124 \fBttl\fR
1115 1125 .ad
1116 1126 .RS 4n
1117 1127 The IPv4 time-to-live.
1118 1128 .RE
1119 1129
1120 1130 .RE
1121 1131 .RE
1122 1132
1123 1133 .sp
1124 1134 .ne 2
1125 1135 .na
1126 1136 \fB\fBreset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR\fR
1127 1137 .ad
1128 1138 .sp .6
1129 1139 .RS 4n
1130 1140 The \fBreset-prop\fR subcommand is used to reset a protocol's property
1131 1141 value to the default.
1132 1142 .sp
1133 1143 The \fB-t\fR option (also \fB--temporary\fR) means
1134 1144 that the disable is temporary and will not be persistent across reboots.
1135 1145 .sp
1136 1146 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
1137 1147 See the \fBset-prop\fR subcommand for the list of property names.
1138 1148 .sp
1139 1149
1140 1150 .RE
1141 1151
1142 1152 .sp
1143 1153 .ne 2
1144 1154 .na
1145 1155 \fB\fBshow-prop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIprotocol\fR]
1146 1156 .ad
1147 1157 .sp .6
1148 1158 .RS 4n
1149 1159 The \fBshow-prop\fR subcommand is used to display the property values
1150 1160 for one or all of the protocols.
1151 1161 .sp
1152 1162 The \fB-c\fR option (also \fB--parsable\fR) prints
1153 1163 the output in a parsable format.
1154 1164 .sp
1155 1165 The \fB-o\fR option (also \fB--output\fR) is used
1156 1166 to select which fields will be shown. The field value can be one of the
1157 1167 following names:
1158 1168 .sp
1159 1169 .ne 2
1160 1170 .na
1161 1171 .RS 4n
1162 1172 \fBALL\fR
1163 1173 .ad
1164 1174 .RS 4n
1165 1175 Display all fields
1166 1176 .RE
1167 1177
1168 1178 .sp
1169 1179 .ne 2
1170 1180 .na
1171 1181 \fBPROTO\fR
1172 1182 .ad
1173 1183 .RS 4n
1174 1184 The name of the protocol
1175 1185 .RE
1176 1186
1177 1187 .sp
1178 1188 .ne 2
1179 1189 .na
1180 1190 \fBPROPERTY\fR
1181 1191 .ad
1182 1192 .RS 4n
1183 1193 The name of the property
1184 1194 .RE
1185 1195
1186 1196 .sp
1187 1197 .ne 2
1188 1198 .na
1189 1199 \fBPERM\fR
1190 1200 .ad
1191 1201 .RS 4n
1192 1202 If the property is readable ("r") and/or writable ("w").
1193 1203 .RE
1194 1204
1195 1205 .sp
1196 1206 .ne 2
1197 1207 .na
1198 1208 \fBCURRENT\fR
1199 1209 .ad
1200 1210 .RS 4n
1201 1211 The value of the property
1202 1212 .RE
1203 1213
1204 1214 .sp
1205 1215 .ne 2
1206 1216 .na
1207 1217 \fBPERSISTENT\fR
1208 1218 .ad
1209 1219 .RS 4n
1210 1220 The persistent value of the property
1211 1221 .RE
1212 1222
1213 1223 .sp
1214 1224 .ne 2
1215 1225 .na
1216 1226 \fBDEFAULT\fR
1217 1227 .ad
1218 1228 .RS 4n
1219 1229 The default value of the property
1220 1230 .RE
1221 1231
1222 1232 .sp
1223 1233 .ne 2
1224 1234 .na
1225 1235 \fBPOSSIBLE\fR
1226 1236 .ad
1227 1237 .RS 4n
1228 1238 The possible values for the property
1229 1239 .RE
1230 1240 .RE
1231 1241
1232 1242 .sp
1233 1243 The \fB-p\fR option (also \fB--prop\fR) is used
1234 1244 to specify which properties to display. See the \fBset-prop\fR
1235 1245 subcommand for the list of property names.
1236 1246 .sp
1237 1247
1238 1248 .RE
1239 1249
1240 1250 .SH SEE ALSO
1241 1251 .sp
1242 1252 .LP
1243 1253 \fBifconfig\fR(1M), \fBdladm\fR(1M), \fBndd\fR(1M), \fBzonecfg\fR(1M),
1244 1254 \fBarp\fR(1M), \fBcfgadm\fR(1M), \fBif_mpadm\fR(1M), \fBnsswitch.conf\fR(4),
1245 1255 and \fBdhcp\fR(5).
↓ open down ↓ |
136 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX