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