Print this page
    
DLPX-25998 TCP congestion control is inadequate
Reviewed at: http://reviews.delphix.com/r/34808/
    
      
        | Split | 
	Close | 
      
      | Expand all | 
      | Collapse all | 
    
    
          --- old/usr/src/man/man1m/ipadm.1m
          +++ new/usr/src/man/man1m/ipadm.1m
   1    1  .\"
   2    2  .\" This file and its contents are supplied under the terms of the
  
    | 
      ↓ open down ↓ | 
    2 lines elided | 
    
      ↑ open up ↑ | 
  
   3    3  .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4    4  .\" You may only use this file in accordance with the terms of version
   5    5  .\" 1.0 of the CDDL.
   6    6  .\"
   7    7  .\" A full copy of the text of the CDDL should have accompanied this
   8    8  .\" source.  A copy of the CDDL is also available via the Internet at
   9    9  .\" http://www.illumos.org/license/CDDL.
  10   10  .\"
  11   11  .\"
  12   12  .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
  13      -.\" Copyright (c) 2013 by Delphix. All rights reserved.
       13 +.\" Copyright (c) 2013, 2017 by Delphix. All rights reserved.
  14   14  .\" Copyright 2018 Nexenta Systems, Inc.
  15   15  .\" Copyright (c) 2016-2017, Chris Fraire <cfraire@me.com>.
  16   16  .\"
  17   17  .Dd February 6, 2018
  18   18  .Dt IPADM 1M
  19   19  .Os
  20   20  .Sh NAME
  21   21  .Nm ipadm
  22   22  .Nd configure IP interfaces, addresses and protocols
  23   23  .Sh SYNOPSIS
  24   24  .Nm
  25   25  .Ic create-if
  26   26  .Op Fl t
  27   27  .Ar interface
  28   28  .Nm
  29   29  .Ic disable-if
  30   30  .Fl t
  31   31  .Ar interface
  32   32  .Nm
  33   33  .Ic enable-if
  34   34  .Fl t
  35   35  .Ar interface
  36   36  .Nm
  37   37  .Ic delete-if
  38   38  .Ar interface
  39   39  .Nm
  40   40  .Ic show-if
  41   41  .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
  42   42  .Op Ar interface
  43   43  .Nm
  44   44  .Ic set-ifprop
  45   45  .Op Fl t
  46   46  .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
  47   47  .Fl m Ar protocol
  48   48  .Ar interface
  49   49  .Nm
  50   50  .Ic reset-ifprop
  51   51  .Op Fl t
  52   52  .Fl p Ar prop
  53   53  .Fl m Ar protocol
  54   54  .Ar interface
  55   55  .Nm
  56   56  .Ic show-ifprop
  57   57  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
  58   58  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
  59   59  .Op Fl m Ar protocol
  60   60  .Op Ar interface
  61   61  .Nm
  62   62  .Ic create-addr
  63   63  .Op Fl t
  64   64  .Fl T Cm static
  65   65  .Op Fl d
  66   66  .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
  67   67  .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
  68   68  .Ar addrobj
  69   69  .Nm
  70   70  .Ic create-addr
  71   71  .Op Fl t
  72   72  .Fl T Cm dhcp
  73   73  .Op Fl 1
  74   74  .Op Fl h Ar hostname
  75   75  .Op Fl w Bro Ar seconds Ns | Ns Cm forever Brc
  76   76  .Ar addrobj
  77   77  .Nm
  78   78  .Ic create-addr
  79   79  .Op Fl t
  80   80  .Fl T Cm addrconf
  81   81  .Op Fl i Ar interface-id
  82   82  .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
  83   83  .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
  84   84  .Ar addrobj
  85   85  .Nm
  86   86  .Ic down-addr
  87   87  .Op Fl t
  88   88  .Ar addrobj
  89   89  .Nm
  90   90  .Ic up-addr
  91   91  .Op Fl t
  92   92  .Ar addrobj
  93   93  .Nm
  94   94  .Ic disable-addr
  95   95  .Op Fl t
  96   96  .Ar addrobj
  97   97  .Nm
  98   98  .Ic enable-addr
  99   99  .Op Fl t
 100  100  .Ar addrobj
 101  101  .Nm
 102  102  .Ic refresh-addr
 103  103  .Op Fl i
 104  104  .Ar addrobj
 105  105  .Nm
 106  106  .Ic delete-addr
 107  107  .Op Fl r
 108  108  .Ar addrobj
 109  109  .Nm
 110  110  .Ic show-addr
 111  111  .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 112  112  .Op Ar addrobj
 113  113  .Nm
 114  114  .Ic set-addrprop
 115  115  .Op Fl t
 116  116  .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
 117  117  .Ar addrobj
 118  118  .Nm
 119  119  .Ic reset-addrprop
 120  120  .Op Fl t
 121  121  .Fl p Ar prop
 122  122  .Ar addrobj
 123  123  .Nm
 124  124  .Ic show-addrprop
 125  125  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 126  126  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
 127  127  .Op Ar addrobj
 128  128  .Nm
 129  129  .Ic set-prop
 130  130  .Op Fl t
 131  131  .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
 132  132  .Ar value Ns Oo , Ns Ar value Oc Ns ...
 133  133  .Ar protocol
 134  134  .Nm
 135  135  .Ic reset-prop
 136  136  .Op Fl t
 137  137  .Fl p Ar prop
 138  138  .Ar protocol
 139  139  .Nm
 140  140  .Ic show-prop
 141  141  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 142  142  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
 143  143  .Op Ar protocol
 144  144  .Sh DESCRIPTION
 145  145  The
 146  146  .Nm
 147  147  command is a stable replacement for the
 148  148  .Xr ifconfig 1M
 149  149  and
 150  150  .Xr ndd 1M
 151  151  commands.
 152  152  It is used to create IP interfaces and to configure IP addresses on those
 153  153  interfaces.
 154  154  It is also used to get, set or reset properties on interfaces, addresses and
 155  155  protocols.
 156  156  .Pp
 157  157  For subcommands that take an
 158  158  .Em addrobj ,
 159  159  the
 160  160  .Em addrobj
 161  161  specifies a unique address on the system.
 162  162  It is made up of two parts, delimited by a
 163  163  .Sq / .
 164  164  The first part is the name of the interface and the second part is a string up
 165  165  to 32 characters long.
 166  166  For example,
 167  167  .Qq lo0/v4
 168  168  is a loopback interface
 169  169  .Em addrobj
 170  170  name.
 171  171  .Pp
 172  172  For subcommands that take a
 173  173  .Em protocol ,
 174  174  this can be one of the following values:
 175  175  .Cm ip ,
 176  176  .Cm ipv4 ,
 177  177  .Cm ipv6 ,
 178  178  .Cm icmp ,
 179  179  .Cm tcp ,
 180  180  .Cm sctp
 181  181  or
 182  182  .Cm udp .
 183  183  .Sh SUBCOMMANDS
 184  184  The following subcommands are supported:
 185  185  .Bl -tag -width Ds
 186  186  .It Xo
 187  187  .Nm
 188  188  .Ic create-if
 189  189  .Op Fl t
 190  190  .Ar interface
 191  191  .Xc
 192  192  Create an IP interface that will handle both IPv4 and IPv6 packets.
 193  193  The interface will be enabled as part of the creation process.
 194  194  The IPv4 interface will have the address 0.0.0.0.
 195  195  The IPv6 interface will have the address ::.
 196  196  .Bl -tag -width Ds
 197  197  .It Fl t Ns \&, Ns Fl -temporary
 198  198  Temporary, not persistent across reboots.
 199  199  .El
 200  200  .It Xo
 201  201  .Nm
 202  202  .Ic disable-if
 203  203  .Fl t
 204  204  .Ar interface
 205  205  .Xc
 206  206  Disable the specified IP interface.
 207  207  .Bl -tag -width Ds
 208  208  .It Fl t Ns \&, Ns Fl -temporary
 209  209  Temporary, not persistent across reboots.
 210  210  .El
 211  211  .It Xo
 212  212  .Nm
 213  213  .Ic enable-if
 214  214  .Fl t
 215  215  .Ar interface
 216  216  .Xc
 217  217  Enable the specified IP interface.
 218  218  .Bl -tag -width Ds
 219  219  .It Fl t Ns \&, Ns Fl -temporary
 220  220  Temporary, not persistent across reboots.
 221  221  .El
 222  222  .It Xo
 223  223  .Nm
 224  224  .Ic delete-if
 225  225  .Ar interface
 226  226  .Xc
 227  227  Permanently delete the specified IP interface.
 228  228  .It Xo
 229  229  .Nm
 230  230  .Ic show-if
 231  231  .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 232  232  .Op Ar interface
 233  233  .Xc
 234  234  Show the current IP interface configuration.
 235  235  .Bl -tag -width Ds
 236  236  .It Fl o Ns \&, Ns Fl -output
 237  237  Select which fields will be shown.
 238  238  The field value can be one of the following names:
 239  239  .Bl -tag -compact -width "PERSISTENT"
 240  240  .It Cm ALL
 241  241  Display all fields.
 242  242  .It Cm IFNAME
 243  243  The name of the interface.
 244  244  .It Cm STATE
 245  245  The state can be one of the following values:
 246  246  .Bl -tag -compact -width "disabled"
 247  247  .It Sy ok
 248  248  resources for the interface have been allocated
 249  249  .It Sy offline
 250  250  the interface is offline
 251  251  .It Sy failed
 252  252  the interface's datalink is down
 253  253  .It Sy down
 254  254  the interface is down
 255  255  .It Sy disabled
 256  256  the interface is disabled
 257  257  .El
 258  258  .It Cm CURRENT
 259  259  A set of single character flags indicating the following:
 260  260  .Bl -tag -compact -width "b"
 261  261  .It Sy b
 262  262  broadcast (mutually exclusive with
 263  263  .Sq p )
 264  264  .It Sy m
 265  265  multicast
 266  266  .It Sy p
 267  267  point-to-point (mutually exclusive with
 268  268  .Sq b )
 269  269  .It Sy v
 270  270  virtual interface
 271  271  .It Sy I
 272  272  IPMP
 273  273  .It Sy s
 274  274  IPMP standby
 275  275  .It Sy i
 276  276  IPMP inactive
 277  277  .It Sy V
 278  278  VRRP
 279  279  .It Sy a
 280  280  VRRP accept mode
 281  281  .It Sy 4
 282  282  IPv4
 283  283  .It Sy 6
 284  284  IPv6
 285  285  .El
 286  286  .It Cm PERSISTENT
 287  287  A set of single character flags showing what configuration will be used the
 288  288  next time the interface is enabled:
 289  289  .Bl -tag -compact -width "s"
 290  290  .It Sy s
 291  291  IPMP standby
 292  292  .It Sy 4
 293  293  IPv4
 294  294  .It Sy 6
 295  295  IPv6
 296  296  .El
 297  297  .El
 298  298  .It Fl p Ns \&, Ns Fl -parsable
 299  299  Print the output in a parsable format.
 300  300  .El
 301  301  .It Xo
 302  302  .Nm
 303  303  .Ic set-ifprop
 304  304  .Op Fl t
 305  305  .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
 306  306  .Fl m Ar protocol
 307  307  .Ar interface
 308  308  .Xc
 309  309  Set a property's value(s) on the specified IP interface.
 310  310  .Bl -tag -width Ds
 311  311  .It Fl m Ns \&, Ns Fl -module
 312  312  Specify which protocol the setting applies to.
 313  313  .It Fl p Ns \&, Ns Fl -prop
 314  314  Specify the property name and value(s).
 315  315  The property name can be one of the following:
 316  316  .Bl -tag -compact -width "exchange_routes"
 317  317  .It Cm arp
 318  318  Address resolution protocol
 319  319  .Pq Cm on Ns / Ns Cm off .
 320  320  .It Cm exchange_routes
 321  321  Exchange of routing data
 322  322  .Pq Cm on Ns / Ns Cm off .
 323  323  .It Cm forwarding
 324  324  IP Forwarding
 325  325  .Pq Cm on Ns / Ns Cm off
 326  326  .It Cm metric
 327  327  Set the routing metric to the numeric value.
 328  328  The value is treated as extra hops to the destination.
 329  329  .It Cm mtu
 330  330  Set the maximum transmission unit to the numeric value.
 331  331  .It Cm nud
 332  332  Neighbor unreachability detection
 333  333  .Pq Cm on Ns / Ns Cm off
 334  334  .It Cm usesrc
 335  335  Indicates which interface to use for source address selection.
 336  336  A value
 337  337  .Cm none
 338  338  may also be used.
 339  339  .El
 340  340  .It Fl t Ns \&, Ns Fl -temporary
 341  341  Temporary, not persistent across reboots.
 342  342  .El
 343  343  .It Xo
 344  344  .Nm
 345  345  .Ic reset-ifprop
 346  346  .Op Fl t
 347  347  .Fl p Ar prop
 348  348  .Fl m Ar protocol
 349  349  .Ar interface
 350  350  .Xc
 351  351  Reset the specified IP interface's property value to the default.
 352  352  .Bl -tag -width Ds
 353  353  .It Fl m Ns \&, Ns Fl -module
 354  354  Specify which protocol the setting applies to.
 355  355  .It Fl p Ns \&, Ns Fl -prop
 356  356  Specify the property name.
 357  357  See the
 358  358  .Nm ipadm Ic set-ifprop
 359  359  subcommand for the list of property names.
 360  360  .It Fl t Ns \&, Ns Fl -temporary
 361  361  Temporary, not persistent across reboots.
 362  362  .El
 363  363  .It Xo
 364  364  .Nm
 365  365  .Ic show-ifprop
 366  366  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
 367  367  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
 368  368  .Op Fl m Ar protocol
 369  369  .Op Ar interface
 370  370  .Xc
 371  371  Display the property values for one or all of the IP interfaces.
 372  372  .Bl -tag -width Ds
 373  373  .It Fl c Ns \&, Ns Fl -parsable
 374  374  Print the output in a parsable format.
 375  375  .It Fl m Ns \&, Ns Fl -module
 376  376  Specify which protocol to display.
 377  377  .It Fl o Ns \&, Ns Fl -output
 378  378  Select which fields will be shown.
 379  379  The field value can be one of the following names:
 380  380  .Bl -tag -compact -width "PERSISTENT"
 381  381  .It Cm ALL
 382  382  Display all fields.
 383  383  .It Cm IFNAME
 384  384  The name of the interface.
 385  385  .It Cm PROPERTY
 386  386  The name of the property.
 387  387  .It Cm PROTO
 388  388  The name of the protocol.
 389  389  .It Cm PERM
 390  390  If the property is readable
 391  391  .Pq Qq r
 392  392  and/or writable
 393  393  .Pq Qq w .
 394  394  .It Cm CURRENT
 395  395  The value of the property.
 396  396  .It Cm PERSISTENT
 397  397  The persistent value of the property.
 398  398  .It Cm DEFAULT
 399  399  The default value of the property.
 400  400  .It Cm POSSIBLE
 401  401  The possible values for the property.
 402  402  .El
 403  403  .It Fl p Ns \&, Ns Fl -prop
 404  404  Specify which properties to display.
 405  405  See the
 406  406  .Nm ipadm Ic set-ifprop
 407  407  subcommand for the list of property names.
 408  408  .El
 409  409  .It Xo
 410  410  .Nm
 411  411  .Ic create-addr
 412  412  .Op Fl t
 413  413  .Fl T Cm static
 414  414  .Op Fl d
 415  415  .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
 416  416  .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
 417  417  .Ar addrobj
 418  418  .Xc
 419  419  Create an address on the specified IP interface using static configuration.
 420  420  The address will be enabled but can disabled using the
 421  421  .Nm ipadm Ic disable-addr
 422  422  subcommand.
 423  423  Note that
 424  424  .Cm addrconf
 425  425  address configured on an interface is required to configure
 426  426  .Cm static
 427  427  IPv6 address on the same interface.
 428  428  This takes the following options:
 429  429  .Bl -tag -width Ds
 430  430  .It Fl a Ns \&, Ns Fl -address
 431  431  Specify the address.
 432  432  The
 433  433  .Cm local
 434  434  or
 435  435  .Cm remote
 436  436  prefix can be used for a point-to-point interface.
 437  437  In this case, both addresses must be given.
 438  438  Otherwise, the equal sign
 439  439  .Pq Qq =
 440  440  should be omitted and the address should be provided by itself without second
 441  441  address.
 442  442  .It Fl d Ns \&, Ns Fl -down
 443  443  The address is down.
 444  444  .It Fl t Ns \&, Ns Fl -temporary
 445  445  Temporary, not persistent across reboots.
 446  446  .El
 447  447  .It Xo
 448  448  .Nm
 449  449  .Ic create-addr
 450  450  .Op Fl t
 451  451  .Fl T Cm dhcp
 452  452  .Op Fl 1
 453  453  .Op Fl h Ar hostname
 454  454  .Op Fl w Bro Ar seconds Ns | Ns Cm forever Brc
 455  455  .Ar addrobj
 456  456  .Xc
 457  457  Create an address on the specified IP interface using DHCP.
 458  458  This takes the following options:
 459  459  .Bl -tag -width Ds
 460  460  .It Fl 1 Ns \&, Ns Fl -primary
 461  461  Specify that the interface is primary.
 462  462  One effect will be that
 463  463  .Xr nodename 4
 464  464  will serve as
 465  465  .Fl h Ns \&, Ns Fl -reqhost
 466  466  if that switch is not otherwise specified.
 467  467  .It Fl h Ns \&, Ns Fl -reqhost
 468  468  Specify the host name to send to the DHCP server in order to request an
 469  469  association of a Fully Qualified Domain Name to the interface.
 470  470  An FQDN is determined from
 471  471  .Ar hostname
 472  472  if it is "rooted" (ending in a '.'), or if it consists of at least three
 473  473  DNS labels, or by appending to
 474  474  .Ar hostname
 475  475  the DNS domain name value configured in
 476  476  .Pa /etc/default/dhcpagent
 477  477  for
 478  478  .Xr dhcpagent 1m .
 479  479  N.b. that the DHCP server implementation ultimately determines whether and
 480  480  how the client-sent FQDN is used.
 481  481  .It Fl t Ns \&, Ns Fl -temporary
 482  482  Temporary, not persistent across reboots.
 483  483  .It Fl w Ns \&, Ns Fl -wait
 484  484  Specify the time, in seconds, that the command should wait to obtain an
 485  485  address; or specify
 486  486  .Cm forever
 487  487  to wait without interruption.
 488  488  The default value is 120.
 489  489  .El
 490  490  .It Xo
 491  491  .Nm
 492  492  .Ic create-addr
 493  493  .Op Fl t
 494  494  .Fl T Cm addrconf
 495  495  .Op Fl i Ar interface-id
 496  496  .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
 497  497  .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
 498  498  .Ar addrobj
 499  499  .Xc
 500  500  Create an auto-configured address on the specified IP interface.
 501  501  This takes the following options:
 502  502  .Bl -tag -width Ds
 503  503  .It Fl i Ns \&, Ns Fl -interface-id
 504  504  Specify the interface ID to be used.
 505  505  .It Fl p Ns \&, Ns Fl -prop
 506  506  Specify which method of auto-configuration should be used.
 507  507  .It Fl t Ns \&, Ns Fl -temporary
 508  508  Temporary, not persistent across reboots.
 509  509  .El
 510  510  .It Xo
 511  511  .Nm
 512  512  .Ic down-addr
 513  513  .Op Fl t
 514  514  .Ar addrobj
 515  515  .Xc
 516  516  Down the address.
 517  517  This will stop packets from being sent or received.
 518  518  .Bl -tag -width Ds
 519  519  .It Fl t Ns \&, Ns Fl -temporary
 520  520  Temporary, not persistent across reboots.
 521  521  .El
 522  522  .It Xo
 523  523  .Nm
 524  524  .Ic up-addr
 525  525  .Op Fl t
 526  526  .Ar addrobj
 527  527  .Xc
 528  528  Up the address.
 529  529  This will enable packets to be sent and received.
 530  530  .Bl -tag -width Ds
 531  531  .It Fl t Ns \&, Ns Fl -temporary
 532  532  Temporary, not persistent across reboots.
 533  533  .El
 534  534  .It Xo
 535  535  .Nm
 536  536  .Ic disable-addr
 537  537  .Op Fl t
 538  538  .Ar addrobj
 539  539  .Xc
 540  540  Disable the address.
 541  541  .Bl -tag -width Ds
 542  542  .It Fl t Ns \&, Ns Fl -temporary
 543  543  Temporary, not persistent across reboots.
 544  544  .El
 545  545  .It Xo
 546  546  .Nm
 547  547  .Ic enable-addr
 548  548  .Op Fl t
 549  549  .Ar addrobj
 550  550  .Xc
 551  551  Enable the address.
 552  552  .Bl -tag -width Ds
 553  553  .It Fl t Ns \&, Ns Fl -temporary
 554  554  Temporary, not persistent across reboots.
 555  555  .El
 556  556  .It Xo
 557  557  .Nm
 558  558  .Ic refresh-addr
 559  559  .Op Fl i
 560  560  .Ar addrobj
 561  561  .Xc
 562  562  Extend the lease for
 563  563  .Sy DHCP
 564  564  addresses.
 565  565  It also restarts duplicate address detection for
 566  566  .Cm static
 567  567  addresses.
 568  568  .Bl -tag -width Ds
 569  569  .It Fl i Ns \&, Ns Fl -inform
 570  570  Obtain network configuration from DHCP without taking a lease on the address.
 571  571  .El
 572  572  .It Xo
 573  573  .Nm
 574  574  .Ic delete-addr
 575  575  .Op Fl r
 576  576  .Ar addrobj
 577  577  .Xc
 578  578  Delete the given address.
 579  579  .Bl -tag -width Ds
 580  580  .It Fl r Ns \&, Ns Fl -release
 581  581  Indicate that the DHCP-assigned address should be released.
 582  582  .El
 583  583  .It Xo
 584  584  .Nm
 585  585  .Ic show-addr
 586  586  .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 587  587  .Op Ar addrobj
 588  588  .Xc
 589  589  Show the current address properties.
 590  590  .Bl -tag -width Ds
 591  591  .It Fl o Ns \&, Ns Fl -output
 592  592  Select which fields will be shown.
 593  593  The field value can be one of the following names:
 594  594  .Bl -tag -compact -width "PERSISTENT"
 595  595  .It Cm ALL
 596  596  Display all fields.
 597  597  .It Cm ADDROBJ
 598  598  The name of the address.
 599  599  .It Cm TYPE
 600  600  The type of the address
 601  601  .Pq Sy static Ns / Ns Sy dhcp Ns / Ns Sy addrconf .
 602  602  .It Cm STATE
 603  603  The state of the address.
 604  604  It can be one of the following values:
 605  605  .Bl -tag -compact -width "inaccessible"
 606  606  .It Sy disabled
 607  607  see the
 608  608  .Nm ipadm Ic disable-addr
 609  609  subcommand
 610  610  .It Sy down
 611  611  see the
 612  612  .Nm ipadm Ic down-addr
 613  613  subcommand
 614  614  .It Sy duplicate
 615  615  the address is a duplicate
 616  616  .It Sy inaccessible
 617  617  the interface for this address has failed
 618  618  .It Sy ok
 619  619  the address is up
 620  620  .It Sy tentative
 621  621  duplicate address detection in progress
 622  622  .El
 623  623  .It Cm CURRENT
 624  624  A set of single character flags indicating the following:
 625  625  .Bl -tag -compact -width "U"
 626  626  .It Sy U
 627  627  up
 628  628  .It Sy u
 629  629  unnumbered
 630  630  .Pq matches another local address
 631  631  .It Sy p
 632  632  private, not advertised to routing
 633  633  .It Sy t
 634  634  temporary IPv6 address
 635  635  .It Sy d
 636  636  deprecated
 637  637  .Pq not used for outgoing packets
 638  638  .El
 639  639  .It Cm PERSISTENT
 640  640  A set of single character flags showing the configuration which will be used
 641  641  when the address is enabled.
 642  642  .Bl -tag -compact -width "U"
 643  643  .It Sy U
 644  644  up
 645  645  .It Sy p
 646  646  private, not advertised to routing
 647  647  .It Sy d
 648  648  deprecated
 649  649  .Pq not used for outgoing packets
 650  650  .El
 651  651  .It Cm ADDR
 652  652  The address.
 653  653  .El
 654  654  .It Fl p Ns \&, Ns Fl -parsable
 655  655  Print the output in a parsable format.
 656  656  .El
 657  657  .It Xo
 658  658  .Nm
 659  659  .Ic set-addrprop
 660  660  .Op Fl t
 661  661  .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
 662  662  .Ar addrobj
 663  663  .Xc
 664  664  Set a property's value(s) on the addrobj.
 665  665  .Bl -tag -width Ds
 666  666  .It Fl p Ns \&, Ns Fl -prop
 667  667  Specify the property name and value(s).
 668  668  The property name can be one of the following:
 669  669  .Bl -tag -compact -width "deprecated"
 670  670  .It Cm broadcast
 671  671  The broadcast address (read-only).
 672  672  .It Cm deprecated
 673  673  The address should not be used to send packets but can still receive packets
 674  674  .Pq Cm on Ns / Ns Cm off .
 675  675  .It Cm prefixlen
 676  676  The number of bits in the IPv4 netmask or IPv6 prefix.
 677  677  .It Cm primary
 678  678  The DHCP primary interface flag (read-only).
 679  679  .It Cm private
 680  680  The address is not advertised to routing
 681  681  .Pq Cm on Ns / Ns Cm off .
 682  682  .It Cm reqhost
 683  683  The host name to send to the DHCP server in order to request an association
 684  684  of the FQDN to the interface.
 685  685  For a primary DHCP interface,
 686  686  .Xr nodename 4
 687  687  is sent if this property is not defined.
 688  688  See the
 689  689  .Nm
 690  690  .Ic create-addr
 691  691  .Fl T Cm dhcp
 692  692  subcommand for the explanation of how an FQDN is determined.
 693  693  .It Cm transmit
 694  694  Packets can be transmitted
 695  695  .Pq Cm on Ns / Ns Cm off .
 696  696  .It Cm zone
 697  697  The zone the addrobj is in (temporary-only--use
 698  698  .Xr zonecfg 1M
 699  699  to make persistent).
 700  700  .El
 701  701  .It Fl t Ns \&, Ns Fl -temporary
 702  702  Temporary, not persistent across reboots.
 703  703  .El
 704  704  .It Xo
 705  705  .Nm
 706  706  .Ic reset-addrprop
 707  707  .Op Fl t
 708  708  .Fl p Ar prop
 709  709  .Ar addrobj
 710  710  .Xc
 711  711  Reset the addrobj's property value to the default.
 712  712  .Bl -tag -width Ds
 713  713  .It Fl p Ns \&, Ns Fl -prop
 714  714  Specify the property name.
 715  715  See the
 716  716  .Nm ipadm Ic set-addrprop
 717  717  subcommand for the list of property names.
 718  718  .It Fl t Ns \&, Ns Fl -temporary
 719  719  Temporary, not persistent across reboots.
 720  720  .El
 721  721  .It Xo
 722  722  .Nm
 723  723  .Ic show-addrprop
 724  724  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 725  725  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
 726  726  .Op Ar addrobj
 727  727  .Xc
 728  728  Display the property values for one or all of the addrobjs.
 729  729  .Bl -tag -width Ds
 730  730  .It Fl c Ns \&, Ns Fl -parsable
 731  731  Print the output in a parsable format.
 732  732  .It Fl o Ns \&, Ns Fl -output
 733  733  Select which fields will be shown.
 734  734  The field value can be one of the following names:
 735  735  .Bl -tag -compact -width "PERSISTENT"
 736  736  .It Cm ALL
 737  737  Display all fields.
 738  738  .It Cm ADDROBJ
 739  739  The name of the addrobj.
 740  740  .It Cm PROPERTY
 741  741  The name of the property.
 742  742  .It Cm PERM
 743  743  If the property is readable
 744  744  .Pq Qq r
 745  745  and/or writable
 746  746  .Pq Qq w .
 747  747  .It Cm CURRENT
 748  748  The value of the property.
 749  749  .It Cm PERSISTENT
 750  750  The persistent value of the property.
 751  751  .It Cm DEFAULT
 752  752  The default value of the property.
 753  753  .It Cm POSSIBLE
 754  754  The possible values for the property.
 755  755  .El
 756  756  .It Fl p Ns \&, Ns Fl -prop
 757  757  Specify which properties to display.
 758  758  See the
 759  759  .Nm ipadm Ic set-addrprop
 760  760  subcommand for the list of property names.
 761  761  .El
 762  762  .It Xo
 763  763  .Ic set-prop
 764  764  .Op Fl t
 765  765  .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
 766  766  .Ar value Ns Oo , Ns Ar value Oc Ns ...
 767  767  .Ar protocol
 768  768  .Xc
  
    | 
      ↓ open down ↓ | 
    745 lines elided | 
    
      ↑ open up ↑ | 
  
 769  769  Set a property's value(s) on the protocol.
 770  770  .Bl -tag -width Ds
 771  771  .It Fl p Ns \&, Ns Fl -prop
 772  772  Specify the property name and value(s).
 773  773  The optional
 774  774  .Sy + Ns | Ns Sy -
 775  775  syntax can be used to add/remove values from the current list of values on the
 776  776  property.
 777  777  The property name can be one of the following:
 778  778  .Bl -tag -compact -width "smallest_nonpriv_port"
      779 +.It Cm congestion_control
      780 +The default congestion-control algorithm to be used for new connections
      781 +.Pq TCP .
 779  782  .It Cm ecn
 780  783  Explicit congestion control
 781  784  .Pq Cm never Ns / Ns Cm passive Ns / Ns Cm active
 782  785  .Pq TCP .
 783  786  .It Cm extra_priv_ports
 784  787  Additional privileged ports
 785  788  .Pq SCTP/TCP/UDP .
 786  789  .It Cm forwarding
 787  790  Packet forwarding
 788  791  .Pq Cm on Ns / Ns Cm off .
 789  792  .It Cm hoplimit
 790  793  The IPv6 hoplimit.
 791  794  .It Cm largest_anon_port
 792  795  Largest ephemeral port
 793  796  .Pq SCTP/TCP/UDP .
 794  797  .It Cm max_buf
 795  798  Maximum receive or send buffer size
 796  799  .Pq ICMP/SCTP/TCP/UDP .
 797  800  This also sets the upper limit for the
 798  801  .Cm recv_buf
 799  802  and
 800  803  .Cm send_buf
 801  804  properties.
 802  805  .It Cm recv_buf
 803  806  Default receive buffer size
 804  807  .Pq ICMP/SCTP/TCP/UDP .
 805  808  The maximum value for this property is controlled by the
 806  809  .Cm max_buf
 807  810  property.
 808  811  .It Cm sack
 809  812  Selective acknowledgement
 810  813  .Pq Cm active Ns / Ns Cm passive Ns / Ns Cm never
 811  814  .Pq TCP .
 812  815  .It Cm send_buf
 813  816  Default send buffer size
 814  817  .Pq ICMP/SCTP/TCP/UDP .
 815  818  The maximum value for this property is controlled by the
 816  819  .Cm max_buf
 817  820  property.
 818  821  .It Cm smallest_anon_port
 819  822  Smallest ephemeral port
 820  823  .Pq SCTP/TCP/UDP .
 821  824  .It Cm smallest_nonpriv_port
 822  825  Smallest non-privileged port
 823  826  .Pq SCTP/TCP/UDP .
 824  827  .It Cm ttl
 825  828  The IPv4 time-to-live.
 826  829  .El
 827  830  .It Fl t Ns \&, Ns Fl -temporary
 828  831  Temporary, not persistent across reboots.
 829  832  .El
 830  833  .It Xo
 831  834  .Nm
 832  835  .Ic reset-prop
 833  836  .Op Fl t
 834  837  .Fl p Ar prop
 835  838  .Ar protocol
 836  839  .Xc
 837  840  Reset a protocol's property value to the default.
 838  841  .Bl -tag -width Ds
 839  842  .It Fl p Ns \&, Ns Fl -prop
 840  843  Specify the property name.
 841  844  See the
 842  845  .Nm ipadm Ic set-prop
 843  846  subcommand for the list of property names.
 844  847  .It Fl t Ns \&, Ns Fl -temporary
 845  848  Temporary, not persistent across reboots.
 846  849  .El
 847  850  .It Xo
 848  851  .Nm
 849  852  .Ic show-prop
 850  853  .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
 851  854  .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
 852  855  .Op Ar protocol
 853  856  .Xc
 854  857  Display the property values for one or all of the protocols.
 855  858  .Bl -tag -width Ds
 856  859  .It Fl c Ns \&, Ns Fl -parsable
 857  860  Print the output in a parsable format.
 858  861  .It Fl o Ns \&, Ns Fl -output
 859  862  Select which fields will be shown.
 860  863  The field value can be one of the following names:
 861  864  .Bl -tag -compact -width "PERSISTENT"
 862  865  .It Cm ALL
 863  866  Display all fields.
 864  867  .It Cm PROTO
 865  868  The name of the protocol.
 866  869  .It Cm PROPERTY
 867  870  The name of the property.
 868  871  .It Cm PERM
 869  872  If the property is readable
 870  873  .Pq Qq r
 871  874  and/or writable
 872  875  .Pq Qq w .
 873  876  .It Cm CURRENT
 874  877  The value of the property.
 875  878  .It Cm PERSISTENT
 876  879  The persistent value of the property.
 877  880  .It Cm DEFAULT
 878  881  The default value of the property.
 879  882  .It Cm POSSIBLE
 880  883  The possible values for the property.
 881  884  .El
 882  885  .It Fl p Ns \&, Ns Fl -prop
 883  886  Specify which properties to display.
 884  887  See the
 885  888  .Nm ipadm Ic set-prop
 886  889  subcommand for the list of property names.
 887  890  .El
 888  891  .El
 889  892  .Sh SEE ALSO
 890  893  .Xr arp 1M ,
 891  894  .Xr cfgadm 1M ,
 892  895  .Xr dhcpagent 1M ,
 893  896  .Xr dladm 1M ,
 894  897  .Xr if_mpadm 1M ,
 895  898  .Xr ifconfig 1M ,
 896  899  .Xr ndd 1M ,
 897  900  .Xr zonecfg 1M ,
 898  901  .Xr nodename 4 ,
 899  902  .Xr nsswitch.conf 4 ,
 900  903  .Xr dhcp 5
  
    | 
      ↓ open down ↓ | 
    112 lines elided | 
    
      ↑ open up ↑ | 
  
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX