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 
 423 .sp
 424 .ne 2
 425 .na
 426 \fB\fBreset-ifprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fB-m\fR \fIprotocol\fR \fIinterface\fR\fR
 427 .ad
 428 .sp .6
 429 .RS 4n
 430 The \fBreset-ifprop\fR subcommand is used to reset an IP interface's property
 431 value to the default.
 432 .sp
 433 The \fB-t\fR option (also \fB--temporary\fR) means
 434 that the disable is temporary and will not be persistent across reboots.
 435 .sp
 436 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
 437 See the \fBset-ifprop\fR subcommand for the list of property names.
 438 .sp
 439 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
 440 the setting applies to.
 441 .sp
 442 
 443 .RE
 444 
 445 .sp
 446 .ne 2
 447 .na
 448 \fB\fBshow-ifprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] [\fB-m\fR \fIprotocol\fR]
 449   [\fIinterface\fR]\fR
 450 .ad
 451 .sp .6
 452 .RS 4n
 453 The \fBshow-ifprop\fR subcommand is used to display the property values
 454 for one or all of the IP interfaces.
 455 .sp
 456 The \fB-c\fR option (also \fB--parsable\fR) prints
 457 the output in a parsable format.
 458 .sp
 459 The \fB-o\fR option (also \fB--output\fR) is used
 460 to select which fields will be shown.  The field value can be one of the
 461 following names:
 462 .sp
 463 .ne 2
 464 .na
 465 .RS 4n
 466 \fBALL\fR
 467 .ad
 468 .RS 4n
 469 Display all fields
 470 .RE
 471 
 472 .sp
 473 .ne 2
 474 .na
 475 \fBIFNAME\fR
 476 .ad
 477 .RS 4n
 478 The name of the interface
 479 .RE
 480 
 481 .sp
 482 .ne 2
 483 .na
 484 \fBPROPERTY\fR
 485 .ad
 486 .RS 4n
 487 The name of the property
 488 .RE
 489 
 490 .sp
 491 .ne 2
 492 .na
 493 \fBPROTO\fR
 494 .ad
 495 .RS 4n
 496 The name of the protocol
 497 .RE
 498 
 499 .sp
 500 .ne 2
 501 .na
 502 \fBPERM\fR
 503 .ad
 504 .RS 4n
 505 If the property is readable ("r") and/or writable ("w").
 506 .RE
 507 
 508 .sp
 509 .ne 2
 510 .na
 511 \fBCURRENT\fR
 512 .ad
 513 .RS 4n
 514 The value of the property
 515 .RE
 516 
 517 .sp
 518 .ne 2
 519 .na
 520 \fBPERSISTENT\fR
 521 .ad
 522 .RS 4n
 523 The persistent value of the property
 524 .RE
 525 
 526 .sp
 527 .ne 2
 528 .na
 529 \fBDEFAULT\fR
 530 .ad
 531 .RS 4n
 532 The default value of the property
 533 .RE
 534 
 535 .sp
 536 .ne 2
 537 .na
 538 \fBPOSSIBLE\fR
 539 .ad
 540 .RS 4n
 541 The possible values for the property
 542 .RE
 543 .RE
 544 
 545 .sp
 546 The \fB-p\fR option (also \fB--prop\fR) is used
 547 to specify which properties to display.  See the \fBset-ifprop\fR
 548 subcommand for the list of property names.
 549 .sp
 550 The \fB-m\fR option (also \fB--module\fR) specifies which protocol
 551 to display.
 552 .sp
 553 
 554 .RE
 555 
 556 .sp
 557 .ne 2
 558 .na
 559 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR static [\fB-d\fR] \\
 560    \fB-a\fR {local|remote}=\fIaddr\fR[/\fIprefixlen\fR],... \fIaddrobj\fR\fR
 561 .br
 562 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR dhcp [\fB-w\fR \fIseconds\fR | forever ] \fIaddrobj\fR\fR
 563 .br
 564 \fB\fBcreate-addr\fR [\fB-t\fR] \fB-T\fR addrconf [\fB-i\fR \fIinterface-id\fR] \\
 565    [\fB-p\fR {stateful|stateless}={yes|no},..] \fIaddrobj\fR\fR
 566 .ad
 567 .sp .6
 568 .RS 4n
 569 The \fBcreate-addr\fR subcommand is used to set an address on an IP interface.
 570 The address will be enabled but can disabled using the \fBdisable-addr\fR
 571 subcommand. This subcommand has three different forms, depending on the
 572 value of the \fB-T\fR option.
 573 .sp
 574 The \fB-t\fR option (also \fB--temporary\fR) means
 575 that the address is temporary and will not be persistent across reboots.
 576 .sp
 577 The \fB-T\fR static option creates a static addrobj.  This takes the following
 578 options:
 579 .RS 4n
 580 
 581 The \fB-d\fR option (also \fB--down\fR) means the address is down.
 582 .sp
 583 The \fB-a\fR option (also \fB--address\fR) specifies the address.
 584 The "local" or "remote" prefix can be used for a point-to-point interface.
 585 In this case, both addresses must be given.
 586 Otherwise, the equal sign ("=") should be omitted and the address should be
 587 provided by itself and with no second address.
 588 .sp
 589 
 590 .RE
 591 
 592 The \fB-T\fR dhcp option causes the address to be obtained via DHCP.
 593 This takes the following options:
 594 .RS 4n
 595 
 596 The \fB-w\fR option (also \fB--wait\fR) gives the time, in seconds,
 597 that the command should wait to obtain an address.
 598 .sp
 599 
 600 .RE
 601 
 602 The \fB-T\fR addrconf option creates an auto-configured address.
 603 This takes the following options:
 604 .RS 4n
 605 
 606 The \fB-i\fR option (also \fB--interface-id\fR) gives the interface ID to
 607 be used.
 608 .sp
 609 The \fB-p\fR option (also \fB--prop\fR) indicates which method of
 610 auto-configuration should be used.
 611 .sp
 612 
 613 .RE
 614 .RE
 615 
 616 .sp
 617 .ne 2
 618 .na
 619 \fB\fBdown-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
 620 .ad
 621 .sp .6
 622 .RS 4n
 623 The \fBdown-addr\fR subcommand is used to down the address. This will
 624 stop packets from being sent or received.
 625 .sp
 626 The \fB-t\fR option (also \fB--temporary\fR) means
 627 that the down is temporary and will not be persistent across reboots.
 628 .sp
 629 
 630 .RE
 631 
 632 .sp
 633 .ne 2
 634 .na
 635 \fB\fBup-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
 636 .ad
 637 .sp .6
 638 .RS 4n
 639 The \fBup-addr\fR subcommand is used to up the address. This will
 640 enable packets to be sent and received.
 641 .sp
 642 The \fB-t\fR option (also \fB--temporary\fR) means
 643 that the up is temporary and will not be persistent across reboots.
 644 .sp
 645 
 646 .RE
 647 
 648 .sp
 649 .ne 2
 650 .na
 651 \fB\fBdisable-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
 652 .ad
 653 .sp .6
 654 .RS 4n
 655 The \fBdisable-addr\fR subcommand is used to disable the address.
 656 .sp
 657 The \fB-t\fR option (also \fB--temporary\fR) means
 658 that the disable is temporary and will not be persistent across reboots.
 659 .sp
 660 
 661 .RE
 662 
 663 .sp
 664 .ne 2
 665 .na
 666 \fB\fBenable-addr\fR [\fB-t\fR] \fIaddrobj\fR\fR
 667 .ad
 668 .sp .6
 669 .RS 4n
 670 The \fBenable-addr\fR subcommand is used to enable the address.
 671 .sp
 672 The \fB-t\fR option (also \fB--temporary\fR) means
 673 that the enable is temporary and will not be persistent across reboots.
 674 .sp
 675 
 676 .RE
 677 
 678 .sp
 679 .ne 2
 680 .na
 681 \fB\fBrefresh-addr\fR [\fB-i\fR] \fIaddrobj\fR\fR
 682 .ad
 683 .sp .6
 684 .RS 4n
 685 The \fBrefresh-addr\fR subcommand is used to extend the lease for DHCP
 686 addresses. It also restarts duplicate address detection for Static addresses.
 687 .sp
 688 The \fB-i\fR option (also \fB--inform\fR) means
 689 that the network configuration will be obtained from DHCP without taking
 690 a lease on the address.
 691 .sp
 692 
 693 .RE
 694 
 695 .sp
 696 .ne 2
 697 .na
 698 \fB\fBdelete-addr\fR [\fB-r\fR] \fIaddrobj\fR\fR
 699 .ad
 700 .sp .6
 701 .RS 4n
 702 The \fBdelete-addr\fR subcommand deletes the given address.
 703 .sp
 704 The \fB-r\fR option (also \fB--release\fR) is used for DHCP-assigned
 705 addresses to indicate that the address should be released.
 706 .sp
 707 
 708 .RE
 709 
 710 .sp
 711 .ne 2
 712 .na
 713 \fB\fBshow-addr\fR [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIaddrobj\fR]\fR
 714 .ad
 715 .sp .6
 716 .RS 4n
 717 The \fBshow-addr\fR subcommand is used to show the current address properties.
 718 .sp
 719 The \fB-p\fR option (also \fB--parsable\fR) prints
 720 the output in a parsable format.
 721 .sp
 722 The \fB-o\fR option (also \fB--output\fR) is used
 723 to select which fields will be shown.  The field value can be one of the
 724 following names:
 725 .sp
 726 .ne 2
 727 .na
 728 .RS 4n
 729 \fBALL\fR
 730 .ad
 731 .RS 4n
 732 Display all fields
 733 .RE
 734 
 735 .sp
 736 .ne 2
 737 .na
 738 \fBADDROBJ\fR
 739 .ad
 740 .RS 4n
 741 The name of the address
 742 .RE
 743 
 744 .sp
 745 .ne 2
 746 .na
 747 \fBTYPE\fR
 748 .ad
 749 .RS 4n
 750 The type of the address.  It can be "static", "dhcp" or "addrconf".
 751 .RE
 752 
 753 .sp
 754 .ne 2
 755 .na
 756 \fBSTATE\fR
 757 .ad
 758 .RS 4n
 759 The state of the address.  It can be one of the following values:
 760 .sp
 761 .ne 2
 762 .na
 763 .RS 4n
 764 disabled s see the \fBdisable-addr\fR subcommand
 765 .sp
 766 down - see the \fBdown-addr\fR subcommand
 767 .sp
 768 duplicate - the address is a duplicate
 769 .sp
 770 inaccessible - the interface for this address has failed
 771 .sp
 772 ok - the address is up
 773 .sp
 774 tentative - duplicate address detection in progress
 775 .RE
 776 .RE
 777 
 778 .sp
 779 .ne 2
 780 .na
 781 \fBCURRENT\fR
 782 .ad
 783 .RS 4n
 784 A set of single character flags indicating the following:
 785 .sp
 786 .ne 2
 787 .na
 788 .RS 4n
 789 U - up
 790 .br
 791 u - unnumbered (matches another local address)
 792 .br
 793 p - private, not advertised to routing
 794 .br
 795 t - temporary IPv6 address
 796 .br
 797 d - deprecated (not used for outgoing packets)
 798 .RE
 799 .RE
 800 
 801 .sp
 802 .ne 2
 803 .na
 804 \fBPERSISTENT\fR
 805 .ad
 806 .RS 4n
 807 A set of single character flags showing the configuration which will be used
 808 when the address is enabled.
 809 .sp
 810 .ne 2
 811 .na
 812 .RS 4n
 813 U - up
 814 .br
 815 p - private, not advertised to routing
 816 .br
 817 d - deprecated (not used for outgoing packets)
 818 .RE
 819 .RE
 820 
 821 .sp
 822 .ne 2
 823 .na
 824 \fBADDR\fR
 825 .ad
 826 .RS 4n
 827 The address
 828 .RE
 829 .RE
 830 
 831 .RE
 832 
 833 .sp
 834 .ne 2
 835 .na
 836 \fB\fBset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR=<\fIvalue\fR[,...]> \fIaddrobj\fR
 837 .ad
 838 .sp .6
 839 .RS 4n
 840 The \fBset-addrprop\fR subcommand is used to set a property's value(s) on the
 841 addrobj.
 842 .sp
 843 The \fB-t\fR option (also \fB--temporary\fR) means
 844 that the setting is temporary and will not be persistent across reboots.
 845 .sp
 846 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
 847 value(s).  The property name can be one of the following:
 848 .sp
 849 .ne 2
 850 .na
 851 
 852 .RS 4n
 853 
 854 \fBbroadcast\fR
 855 .ad
 856 .RS 4n
 857 The broadcast address (read-only)
 858 .RE
 859 
 860 .sp
 861 .ne 2
 862 .na
 863 \fBdeprecated\fR
 864 .ad
 865 .RS 4n
 866 The address should not be used to send packets but can still receive packets.
 867 Can be "on" or "off".
 868 .RE
 869 
 870 .sp
 871 .ne 2
 872 .na
 873 \fBprefixlen\fR
 874 .ad
 875 .RS 4n
 876 The number of bits in the IPv4 netmask or IPv6 prefix.
 877 .RE
 878 
 879 .sp
 880 .ne 2
 881 .na
 882 \fBprivate\fR
 883 .ad
 884 .RS 4n
 885 The address is not advertised to routing.
 886 Can be "on" or "off".
 887 .RE
 888 
 889 .sp
 890 .ne 2
 891 .na
 892 \fBtransmit\fR
 893 .ad
 894 .RS 4n
 895 Packets can be transmitted.
 896 Can be "on" or "off".
 897 .RE
 898 
 899 .sp
 900 .ne 2
 901 .na
 902 \fBzone\fR
 903 .ad
 904 .RS 4n
 905 The zone the addrobj is in.
 906 .RE
 907 
 908 .RE
 909 .RE
 910 
 911 .sp
 912 .ne 2
 913 .na
 914 \fB\fBreset-addrprop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIaddrobj\fR\fR
 915 .ad
 916 .sp .6
 917 .RS 4n
 918 The \fBreset-addrprop\fR subcommand is used to reset an addrobj's property
 919 value to the default.
 920 .sp
 921 The \fB-t\fR option (also \fB--temporary\fR) means
 922 that the disable is temporary and will not be persistent across reboots.
 923 .sp
 924 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
 925 See the \fBset-addrprop\fR subcommand for the list of property names.
 926 .sp
 927 
 928 .RE
 929 
 930 .sp
 931 .ne 2
 932 .na
 933 \fB\fBshow-addrprop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIaddrobj\fR]
 934 .ad
 935 .sp .6
 936 .RS 4n
 937 The \fBshow-addrprop\fR subcommand is used to display the property values
 938 for one or all of the addrobjs.
 939 .sp
 940 The \fB-c\fR option (also \fB--parsable\fR) prints
 941 the output in a parsable format.
 942 .sp
 943 The \fB-o\fR option (also \fB--output\fR) is used
 944 to select which fields will be shown.  The field value can be one of the
 945 following names:
 946 .sp
 947 .ne 2
 948 .na
 949 .RS 4n
 950 \fBALL\fR
 951 .ad
 952 .RS 4n
 953 Display all fields
 954 .RE
 955 
 956 .sp
 957 .ne 2
 958 .na
 959 \fBADDROBJ\fR
 960 .ad
 961 .RS 4n
 962 The name of the addrobj
 963 .RE
 964 
 965 .sp
 966 .ne 2
 967 .na
 968 \fBPROPERTY\fR
 969 .ad
 970 .RS 4n
 971 The name of the property
 972 .RE
 973 
 974 .sp
 975 .ne 2
 976 .na
 977 \fBPERM\fR
 978 .ad
 979 .RS 4n
 980 If the property is readable ("r") and/or writable ("w").
 981 .RE
 982 
 983 .sp
 984 .ne 2
 985 .na
 986 \fBCURRENT\fR
 987 .ad
 988 .RS 4n
 989 The value of the property
 990 .RE
 991 
 992 .sp
 993 .ne 2
 994 .na
 995 \fBPERSISTENT\fR
 996 .ad
 997 .RS 4n
 998 The persistent value of the property
 999 .RE
1000 
1001 .sp
1002 .ne 2
1003 .na
1004 \fBDEFAULT\fR
1005 .ad
1006 .RS 4n
1007 The default value of the property
1008 .RE
1009 
1010 .sp
1011 .ne 2
1012 .na
1013 \fBPOSSIBLE\fR
1014 .ad
1015 .RS 4n
1016 The possible values for the property
1017 .RE
1018 .RE
1019 
1020 .sp
1021 The \fB-p\fR option (also \fB--prop\fR) is used
1022 to specify which properties to display.  See the \fBset-addrprop\fR
1023 subcommand for the list of property names.
1024 .sp
1025 
1026 .RE
1027 
1028 .sp
1029 .ne 2
1030 .na
1031 \fB\fBset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR[+|-]=<\fIvalue\fR[,...]> \fIprotocol\fR
1032 .ad
1033 .sp .6
1034 .RS 4n
1035 The \fBset-prop\fR subcommand is used to set a property's value(s) on the
1036 protocol.
1037 .sp
1038 The \fB-t\fR option (also \fB--temporary\fR) means
1039 that the setting is temporary and will not be persistent across reboots.
1040 .sp
1041 The \fB-p\fR option (also \fB--prop\fR) specifies the property name and
1042 value(s). The optional [+|-] syntax can be used to add/remove values from the
1043 current list of values on the property.
1044 The property name can be one of the following:
1045 .sp
1046 .ne 2
1047 .na
1048 
1049 .RS 4n
1050 
1051 \fBecn\fR
1052 .ad
1053 .RS 4n
1054 Explicit congestion control (TCP-only)
1055 Can be "never", "passive" or "active".
1056 .RE
1057 
1058 \fBextra_priv_ports\fR
1059 .ad
1060 .RS 4n
1061 Additional privileged ports (SCTP, TCP or UDP)
1062 .RE
1063 
1064 \fBforwarding\fR
1065 .ad
1066 .RS 4n
1067 Packet forwarding is enabled.
1068 Can be "on" or "off".
1069 .RE
1070 
1071 \fBhoplimit\fR
1072 .ad
1073 .RS 4n
1074 The IPv6 hoplimit.
1075 .RE
1076 
1077 \fBlargest_anon_port\fR
1078 .ad
1079 .RS 4n
1080 Largest ephemeral port (SCTP, TCP or UDP)
1081 .RE
1082 
1083 \fBmax_buf\fR
1084 .ad
1085 .RS 4n
1086 Maximum receive or send buffer size (ICMP, SCTP, TCP, or UDP).  This also
1087 sets the upper limit for the \fBrecv_buf\fB and \fBsend_buf\fB properties.
1088 .RE
1089 
1090 \fBrecv_buf\fR
1091 .ad
1092 .RS 4n
1093 Default receive buffer size (ICMP, SCTP, TCP, or UDP).  The maximum value for
1094 this property is controlled by the \fBmax_buf\fR property.
1095 .RE
1096 
1097 \fBsack\fR
1098 .ad
1099 .RS 4n
1100 Selective acknowledgement (TCP).
1101 Can be "active", "passive" or "never".
1102 .RE
1103 
1104 \fBsend_buf\fR
1105 .ad
1106 .RS 4n
1107 Default send buffer size (ICMP, SCTP, TCP, or UDP).  The maximum value for
1108 this property is controlled by the \fBmax_buf\fR property.
1109 .RE
1110 
1111 \fBsmallest_anon_port\fR
1112 .ad
1113 .RS 4n
1114 Smallest ephemeral port (SCTP, TCP or UDP)
1115 .RE
1116 
1117 \fBsmallest_nonpriv_port\fR
1118 .ad
1119 .RS 4n
1120 Smallest non-privileged port (SCTP, TCP or UDP)
1121 .RE
1122 
1123 \fBttl\fR
1124 .ad
1125 .RS 4n
1126 The IPv4 time-to-live.
1127 .RE
1128 
1129 .RE
1130 .RE
1131 
1132 .sp
1133 .ne 2
1134 .na
1135 \fB\fBreset-prop\fR [\fB-t\fR] \fB-p\fR \fIprop\fR \fIprotocol\fR\fR
1136 .ad
1137 .sp .6
1138 .RS 4n
1139 The \fBreset-prop\fR subcommand is used to reset a protocol's property
1140 value to the default.
1141 .sp
1142 The \fB-t\fR option (also \fB--temporary\fR) means
1143 that the disable is temporary and will not be persistent across reboots.
1144 .sp
1145 The \fB-p\fR option (also \fB--prop\fR) specifies the property name.
1146 See the \fBset-prop\fR subcommand for the list of property names.
1147 .sp
1148 
1149 .RE
1150 
1151 .sp
1152 .ne 2
1153 .na
1154 \fB\fBshow-prop\fR [[\fB-c\fR]\fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR,...] \fIprotocol\fR]
1155 .ad
1156 .sp .6
1157 .RS 4n
1158 The \fBshow-prop\fR subcommand is used to display the property values
1159 for one or all of the protocols.
1160 .sp
1161 The \fB-c\fR option (also \fB--parsable\fR) prints
1162 the output in a parsable format.
1163 .sp
1164 The \fB-o\fR option (also \fB--output\fR) is used
1165 to select which fields will be shown.  The field value can be one of the
1166 following names:
1167 .sp
1168 .ne 2
1169 .na
1170 .RS 4n
1171 \fBALL\fR
1172 .ad
1173 .RS 4n
1174 Display all fields
1175 .RE
1176 
1177 .sp
1178 .ne 2
1179 .na
1180 \fBPROTO\fR
1181 .ad
1182 .RS 4n
1183 The name of the protocol
1184 .RE
1185 
1186 .sp
1187 .ne 2
1188 .na
1189 \fBPROPERTY\fR
1190 .ad
1191 .RS 4n
1192 The name of the property
1193 .RE
1194 
1195 .sp
1196 .ne 2
1197 .na
1198 \fBPERM\fR
1199 .ad
1200 .RS 4n
1201 If the property is readable ("r") and/or writable ("w").
1202 .RE
1203 
1204 .sp
1205 .ne 2
1206 .na
1207 \fBCURRENT\fR
1208 .ad
1209 .RS 4n
1210 The value of the property
1211 .RE
1212 
1213 .sp
1214 .ne 2
1215 .na
1216 \fBPERSISTENT\fR
1217 .ad
1218 .RS 4n
1219 The persistent value of the property
1220 .RE
1221 
1222 .sp
1223 .ne 2
1224 .na
1225 \fBDEFAULT\fR
1226 .ad
1227 .RS 4n
1228 The default value of the property
1229 .RE
1230 
1231 .sp
1232 .ne 2
1233 .na
1234 \fBPOSSIBLE\fR
1235 .ad
1236 .RS 4n
1237 The possible values for the property
1238 .RE
1239 .RE
1240 
1241 .sp
1242 The \fB-p\fR option (also \fB--prop\fR) is used
1243 to specify which properties to display.  See the \fBset-prop\fR
1244 subcommand for the list of property names.
1245 .sp
1246 
1247 .RE
1248 
1249 .SH SEE ALSO
1250 .sp
1251 .LP
1252 \fBifconfig\fR(1M), \fBdladm\fR(1M), \fBndd\fR(1M), \fBzonecfg\fR(1M),
1253 \fBarp\fR(1M), \fBcfgadm\fR(1M), \fBif_mpadm\fR(1M), \fBnsswitch.conf\fR(4),
1254 and \fBdhcp\fR(5).