Content-type: text/html Man page of dladm

dladm

Section: System Administration Commands (1M)
Updated: 2 Jun 2009
Index Return to Main Contents

NAME

dladm - configure data-link interfaces

SYNOPSIS

dladm show-link [-s [-i interval]] [-p] [name]

dladm show-dev [-s [-i interval]] [-p] [dev]

dladm create-aggr [-t] [-R root-dir] [-P policy] [-l mode] 
     [-T time] [-u address] -d dev [-d dev] ... key

dladm delete-aggr [-t] [-R root-dir] key

dladm add-aggr [-t] [-R root-dir] -d dev [-d dev] ... key

dladm remove-aggr [-t] [-R root-dir] -d dev [-d dev] ... key

dladm modify-aggr [-t] [-R root-dir] [-P policy] [-l mode] 
     [-T time] [-u address] key

dladm show-aggr [-L] [-s [-i interval]] [-p] [key]

dladm set-linkprop [-t] [-R root-dir] -p prop=value[,...] name

dladm reset-linkprop [-t] [-R root-dir] [-p prop,...] name

dladm show-linkprop [-cP] [-p prop,...] [name]

dladm -?

DESCRIPTION

The dladm command is used to configure data-links. A configured data-link is represented in the system as a STREAMS DLPI (v2) interface which may be plumbed under protocol stacks such as TCP/IP. Each data-link relies on either a single network device or an aggregation of devices to send packets to or receive packets from a network.

The dladm command operates on the following kinds of object:

link

: Data-links, identified by a name. A name is a maximum of 30 characters. The first character must be alphabetic, the last numeric.

aggr

: Aggregations of network devices, identified by a key.

dev

: Network devices, identified by concatenation of a driver name and an instance number.

The behavior of the linkprop subcommands depends on the type of link and underlying device, currently only one linkprop, "zone" is supported.

Some devices do not support configurable data-links or aggregations. The fixed data-links provided by such devices can be viewed using dladm, but can not be configured.

SUBCOMMANDS

The following subcommands are supported:

show-link

: Show configuration information for all data-links or the specified data-link. By default, the system is configured to have one data-link for each known network device.

show-dev

: Shows information for all devices or the specified device.

create-aggr

: Creates an aggregation using the given key value from as many dev objects as are specified. A data-link is created by default, and is given a name which is the concatenation of "aggr" and the key value of the aggregation.

delete-aggr

: Deletes the specified aggregation.

add-aggr

: Adds as many dev objects as are specified to the given aggregation.

remove-aggr

: Removes as many dev objects as are specified from the given aggregation.

modify-aggr

: Modifies the parameters of the given aggregation.

show-aggr

: Shows configuration information for all aggregations or the specified aggregation.

set-linkprop

: Sets the values of one or more properties on the link specified by name. The list of properties and their possible values depend on the link type, the network device driver, and networking hardware, but can be retrieved using show-linkprop.

reset-linkprop

: Resets one or more properties to their values on the link specified by name. If no properties are specified, all properties are reset.

show-linkprop

: Show the current or persistent values of one or more properties, either for all data-links or for the specified link name. By default, current values are shown. If no properties are specified, all available link properties are displayed.

OPTIONS

The following options are supported:

-k key
--key=key

: The key of an aggregation. This must be an integer value between 1 and 999.

-d dev
--dev=dev

: A device specifier. This must be a concatenation of the name and instance of the driver bound to the device.

-P policy
--policy=policy

Specifies the port selection policy to use for load spreading of outbound traffic. The policy specifies which dev object is used to send packets. A policy consists of a list of one or more layers specifiers separated by commas. A layer specifier is one of the following:

: Select outbound device according to source and destination MAC addresses of the packet.

: Select outbound device according to source and destination IP addresses of the packet.

: Select outbound device according to the upper layer protocol information contained in the packet. For TCP and UDP, this includes source and destination ports. For IPsec, this includes the SPI (Security Parameters Index.)

In the absence of a policy specification, dladm uses the default, L4.

As an example of use of the Lnum identifiers, to use upper layer protocol information, specify the following policy:

-P L4

Note that, as the default, specification of L4 is superfluous.

To use the source and destination MAC addresses as well as the source and destination IP addresses, the following policy can be used:

-P L2,L3

-l mode
--lacp-mode=mode

: Specifies whether LACP should be used and, if used, the mode in which it should operate. Legal values are off, active or passive.

-T time
--lacp-timer=time

: Specifies the LACP timer value. The legal values are short or long.

-u address
--unicast=address

: Specifies a fixed unicast address to be used for the aggregation. If this option is not specified then an address is automatically chosen from the set of addresses of the component devices.

-L
--lacp

: Specifies whether detailed LACP information should be displayed.

-s
--statistics

: Used with the show-link, show-aggr, or show-dev subcommands to show the statistics of data-links, aggregations or devices, respectively.

-i interval
--interval=interval

: Used with the -s option to specify an interval, in seconds, at which statistics should be displayed. If this option is not specified, statistics will only be displayed once.

-t
--temporary

: Specifies that the change is temporary. Temporary changes last until the next reboot.

-R root-dir
--root-dir=root-dir

: Specifies an alternate root directory where dladm applies changes. This can be useful in JumpStart scripts, where the root directory of the system being modified is mounted elsewhere.

-p
--parseable

: Specifies that configuration information should be displayed in parseable format.

-?
--help

: Displays help information. (Stops interpretation of subsequent arguments).

LINK PROPERTIES

The following link properties are supported:

zone

: Specifies the zone to which the link belongs. This property can be modified only temporarily through dladm, and thus the -t option must be specified. To modify the zone assignment such that it persists across reboots, please use zonecfg(1M). Possible values consist of any exclusive-IP zone currently running on the system. By default, the zone binding is as per zonecfg(1M).

tagmode

This link property controls the conditions in which 802.1Q VLAN tags will be inserted in packets being transmitted on the link. Two mode values can be assigned to this property:

normal

Insert a VLAN tag in outgoing packets under the following conditions:

: o The packet belongs to a VLAN.

: o The user requested priority tagging.

vlanonly

: Insert a VLAN tag only when the outgoing packet belongs to a VLAN. If a tag is being inserted in this mode and the user has also requested a non-zero priority, the priority is honored and included in the VLAN tag.

The default value is vlanonly.