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