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