Protocol, Interface and Address parameters supported by the ipadm(1M) Command

Protocol, Interface and Address parameters supported by the ipadm(1M) Command

The following list names all the TCP/IP properties that will be supported by the ipadm command. For all the time related properties, the default units will be milliseconds and for all the data size related properties, the default units will be bytes.

The interface stability of all these properties are 'committed'.

Protocol Properties:

 The following protocol properties are supported:

 ttl(ipv4), hoplimit(ipv6)
     Specifies the value that will be set for ttl/hoplimit field of IPv4
     or IPv6 header. Can be used to prevent the system from reaching
     other systems more than N hops away where N was the value specified.

 forwarding(ipv4), forwarding(ipv6)
     Enable/disable global IPv4 or IPv6 forwarding. All the configured
     interfaces will start/stop forwarding packets. Individual interfaces
     can override the global option using set-ifprop.

 recv_maxbuf(tcp, sctp, udp, icmp)
 send_maxbuf(tcp, sctp, udp, icmp)
     This property modifies the receive or send buffer sizes for
     the given protocol.

 sack(tcp)
     Selective acknowledgment (SACK) allows recipients to selectively
     acknowledge out-of-sequence data and is intended to increase
     performance for data transfers over lossy links. See RFC 2018 for
     information on the SACK. Possible values and meaning:
  never - will not accept SACK or send out SACK information
  passive - will accept SACK but not send out
  active - will both accept SACK and send out SACK information

 ecn (tcp)
     Explicit Congestion Control (See RFC 3168 for more information).
     Possible values are same as above; never, passive and active

 smallest_anon_port(tcp, sctp, udp)
 largest_anon_port(tcp, sctp, udp)
     These options define the upper and lower bounds on ephemeral ports.
     Ephemeral (means short-lived) ports are used when establishing
     outbound network connections.

 smallest_nonpriv_port(tcp, sctp, udp)
     This option define the start of non-privileged ports. The
     non-privileged port range normally starts at 1024. Any program that
     attempts to bind a non-privileged port does not have to run as root.

 extra_priv_ports(tcp, sctp, udp)
     This option define additional privileged ports outside of the
     1-1023 range. Any program that attempts to bind the ports listed
     here must run as root. This prevents normal users from starting
     server processes on specific ports.

     These ports can be added/removed/assigned using the set-prop and the
     modifiers +/-/=.

Interface Properties:

 The following interface properties are supported:

 arp
     Enables/disables the use of the Address Resolution Protocol (ARP)
     on an interface. ARP is used in  mapping between network level
     addresses and link level addresses (default). This is currently
     implemented for mapping between IPv4 addresses and MAC addresses.
     Possible values are on or off. Default is on.

 forwarding
     Enables/disables IP forwarding on an interface. When enabled, the
     IP packets can be forwarded to and from the interface. Possible
     values are on or off. Default is off.

 metric
     Set the routing metric of the interface to n; if no value is
     specified, the default is 0. The routing metric is used by the
     routing protocol. Higher metrics have the effect of making a route
     less favorable. Metrics are counted as addition hops to the
     destination network or host.

 mtu
     Set the maximum transmission unit of the interface to n. For many
     types of networks, the mtu has an upper limit, for example, 1500 for
     Ethernet.

 nud
     Enables/disables the neighbor unreachability detection  mechanism on
     a point-to-point physical interface.  Possible values are on or off.
     Default is on.

 usesrc
     Specifies a physical or virtual interface to be used for source
     address selection. If the keyword 'none' is used, then any previous
     selection is cleared. Default is 'none'.

 exchange_routes
     Enables/disables exchanging of routing information on this interface
     Possible values are on or off. Default is off.

Address Properties:

 The following address properties are supported: Note that modifying address
 properties for 'addrconf' address objects is not yet supported.

 broadcast
     Meaningful only for address objects that represent IPv4 addresses.
     This is a read only property and the values specifies the address
     that will be used to represent broadcasts to the network. The value
     of this property changes whenever the prefixlen for the address is
     changed.

 deprecated
     Address should no longer used as a source address in new communications,
     but packets addressed to such an address are processed as expected.
     Possible values are on or off. Default is off. This property is not
     supported on an address object of type "dhcp".

 prefixlen
     Specifies the number of left-most contiguous bits of the address
     that comprise the IPv6 prefix or IPv4 netmask of the address. The
     remaining low-order bits define the host part of the address. When
     prefixlen is converted to a text representation of the address,
     the address contain 1's for the bit positions which are to be used
     for the network part, and 0's for the host part. The prefixlen must
     be specified as a single decimal number. This property is not
     supported on an address object of type "dhcp".

 private
     Specifies that the addresses should not be advertised by the
     in.routed routing daemon. Possible values are on or off. Default
     is off. 

 transmit
     Enables packets to be transmitted using the addresses referenced by
     the address object. This is the default behavior when the address
     is up. Possible values are on or off. Default is on.

 zone
     Specifies the zone in which all the addresses referenced by the
     address object should be placed. The named zone  must be active in
     the kernel in the ready or running state. The interface is
     unplumbed when the zone is halted or rebooted. The zone must be
     configured to be an shared-IP zone. zonecfg(1M) is used  to  assign
     network interface names to exclusive-IP zones. To modify the zone
     assignment  such  that it persists across reboots, please use
     zonecfg(1M). Possible values are list of all the zones configured
     on the system. Default is global.