JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
man pages section 1M: System Administration Commands
search filter icon
search icon

Document Information

Preface

Introduction

System Administration Commands - Part 1

6to4relay(1M)

accept(1M)

acct(1M)

acctadm(1M)

acctcms(1M)

acctcon1(1M)

acctcon(1M)

acctcon2(1M)

acctdisk(1M)

acctdusg(1M)

acctmerg(1M)

accton(1M)

acctprc1(1M)

acctprc(1M)

acctprc2(1M)

acctsh(1M)

acctwtmp(1M)

adbgen(1M)

add_allocatable(1M)

addbadsec(1M)

add_drv(1M)

add_install_client(1M)

add_to_install_server(1M)

afbconfig(1M)

aliasadm(1M)

answerbook2_admin(1M)

apache(1M)

arp(1M)

aset(1M)

aset.restore(1M)

atohexlabel(1M)

audit(1M)

auditconfig(1M)

auditd(1M)

auditreduce(1M)

audit_startup(1M)

auditstat(1M)

audit_warn(1M)

automount(1M)

automountd(1M)

autopush(1M)

bart(1M)

bdconfig(1M)

boot(1M)

bootadm(1M)

bootconfchk(1M)

bootparamd(1M)

bsmconv(1M)

bsmrecord(1M)

bsmunconv(1M)

busstat(1M)

cachefsd(1M)

cachefslog(1M)

cachefspack(1M)

cachefsstat(1M)

cachefswssize(1M)

captoinfo(1M)

catman(1M)

cfgadm(1M)

cfgadm_ac(1M)

cfgadm_cardbus(1M)

cfgadm_fp(1M)

cfgadm_ib(1M)

cfgadm_pci(1M)

cfgadm_sata(1M)

cfgadm_sbd(1M)

cfgadm_scsi(1M)

cfgadm_shp(1M)

cfgadm_sysctrl(1M)

cfgadm_usb(1M)

cfsadmin(1M)

chargefee(1M)

chat(1M)

check(1M)

check-hostname(1M)

check-permissions(1M)

chk_encodings(1M)

chroot(1M)

cimworkshop(1M)

ckpacct(1M)

clear_locks(1M)

clinfo(1M)

closewtmp(1M)

clri(1M)

comsat(1M)

consadm(1m)

conv_lp(1M)

conv_lpd(1M)

coreadm(1M)

cpustat(1M)

cron(1M)

cryptoadm(1M)

cvcd(1M)

datadm(1M)

dcopy(1M)

dcs(1M)

dd(1M)

devattr(1M)

devfree(1M)

devfsadm(1M)

devfsadmd(1M)

device_remap(1M)

devinfo(1M)

devlinks(1M)

devnm(1M)

devreserv(1M)

df(1M)

dfmounts(1M)

dfmounts_nfs(1M)

dfshares(1M)

dfshares_nfs(1M)

df_ufs(1M)

dhcpagent(1M)

dhcpconfig(1M)

dhcpmgr(1M)

dhtadm(1M)

dig(1M)

directoryserver(1M)

disks(1M)

diskscan(1M)

dispadmin(1M)

dladm(1M)

dmesg(1M)

dmi_cmd(1M)

dmiget(1M)

dminfo(1M)

dmispd(1M)

dnssec-dsfromkey(1M)

dnssec-keyfromlabel(1M)

dnssec-keygen(1M)

dnssec-signzone(1M)

dodisk(1M)

domainname(1M)

drd(1M)

drvconfig(1M)

dsvclockd(1M)

dtrace(1M)

dumpadm(1M)

editmap(1M)

edquota(1M)

eeprom(1M)

efdaemon(1M)

embedded_su(1M)

etrn(1M)

fbconfig(1M)

fcinfo(1M)

fdetach(1M)

fdisk(1M)

ff(1M)

ffbconfig(1M)

ff_ufs(1M)

fingerd(1M)

fiocompress(1M)

flar(1M)

flarcreate(1M)

fmadm(1M)

fmd(1M)

fmdump(1M)

fmstat(1M)

fmthard(1M)

format(1M)

fpsd(1M)

fruadm(1M)

fsck(1M)

fsck_cachefs(1M)

fsck_pcfs(1M)

fsck_udfs(1M)

fsck_ufs(1M)

fsdb(1M)

fsdb_udfs(1M)

fsdb_ufs(1M)

fsirand(1M)

fssnap(1M)

fssnap_ufs(1M)

fsstat(1M)

fstyp(1M)

ftpaddhost(1M)

ftpconfig(1M)

ftpd(1M)

ftprestart(1M)

ftpshut(1M)

fuser(1M)

fwflash(1M)

fwtmp(1M)

getdev(1M)

getdevpolicy(1M)

getdgrp(1M)

getent(1M)

gettable(1M)

getty(1M)

getvol(1M)

GFXconfig(1M)

gkadmin(1M)

groupadd(1M)

groupdel(1M)

groupmod(1M)

growfs(1M)

grpck(1M)

gsscred(1M)

gssd(1M)

halt(1M)

hextoalabel(1M)

host(1M)

hostconfig(1M)

hotplug(1M)

hotplugd(1M)

htable(1M)

ickey(1M)

id(1M)

idsconfig(1M)

ifconfig(1M)

if_mpadm(1M)

ifparse(1M)

ikeadm(1M)

ikecert(1M)

imqadmin(1M)

imqbrokerd(1M)

imqcmd(1M)

imqdbmgr(1M)

imqkeytool(1M)

imqobjmgr(1M)

imqusermgr(1M)

in.chargend(1M)

in.comsat(1M)

in.daytimed(1M)

in.dhcpd(1M)

in.discardd(1M)

in.echod(1M)

inetadm(1M)

inetconv(1M)

inetd(1M)

in.fingerd(1M)

infocmp(1M)

in.ftpd(1M)

in.iked(1M)

init(1M)

init.sma(1M)

init.wbem(1M)

inityp2l(1M)

in.lpd(1M)

in.mpathd(1M)

in.named(1M)

in.ndpd(1M)

in.rarpd(1M)

in.rdisc(1M)

in.rexecd(1M)

in.ripngd(1M)

in.rlogind(1M)

in.routed(1M)

in.rshd(1M)

in.rwhod(1M)

install(1M)

installboot(1M)

installer(1M)

installf(1M)

installgrub(1M)

install_scripts(1M)

install-solaris(1M)

in.stdiscover(1M)

in.stlisten(1M)

in.talkd(1M)

in.telnetd(1M)

in.tftpd(1M)

in.timed(1M)

in.tnamed(1M)

intrstat(1M)

in.uucpd(1M)

iostat(1M)

ipaddrsel(1M)

ipf(1M)

ipfs(1M)

ipfstat(1M)

ipmon(1M)

ipnat(1M)

ippool(1M)

ipqosconf(1M)

ipsecalgs(1M)

ipsecconf(1M)

ipseckey(1M)

iscsiadm(1M)

iscsitadm(1M)

iscsitgtd(1M)

itu(1M)

k5srvutil(1M)

kadb(1M)

kadmin(1M)

kadmind(1M)

kadmin.local(1M)

kcfd(1M)

kclient(1M)

kdb5_ldap_util(1M)

kdb5_util(1M)

kdmconfig(1M)

kernel(1M)

keyserv(1M)

killall(1M)

kprop(1M)

kpropd(1M)

kproplog(1M)

krb5kdc(1M)

ksslcfg(1M)

kstat(1M)

ktkt_warnd(1M)

labeld(1M)

labelit(1M)

labelit_hsfs(1M)

labelit_udfs(1M)

labelit_ufs(1M)

lastlogin(1M)

ldapaddent(1M)

ldap_cachemgr(1M)

ldapclient(1M)

ldmad(1M)

link(1M)

listdgrp(1M)

listen(1M)

llc2_loop(1M)

localeadm(1M)

localectr(1M)

locator(1M)

lockd(1M)

lockfs(1M)

lockstat(1M)

lofiadm(1M)

logadm(1M)

logins(1M)

lpadmin(1M)

lpfilter(1M)

lpforms(1M)

lpget(1M)

lpmove(1M)

lpsched(1M)

lpset(1M)

lpshut(1M)

lpsystem(1M)

lpusers(1M)

lu(1M)

luactivate(1M)

lucancel(1M)

lucompare(1M)

lucreate(1M)

lucurr(1M)

ludelete(1M)

ludesc(1M)

lufslist(1M)

lumake(1M)

lumount(1M)

lurename(1M)

lustatus(1M)

luumount(1M)

luupgrade(1M)

luxadm(1M)

m64config(1M)

mail.local(1M)

makedbm(1M)

makemap(1M)

makeuuid(1M)

masfcnv(1M)

mdlogd(1M)

mdmonitord(1M)

medstat(1M)

metaclear(1M)

metadb(1M)

metadetach(1M)

metadevadm(1M)

metahs(1M)

System Administration Commands - Part 2

System Administration Commands - Part 3

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 values of one or more properties, either for all data-links or for the specified link name. 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:

L2

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

L3

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

L4

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 listed below are supported. Note that these properties can be modified only temporarily through dladm, and thus the -t option must be specified. See the NOTES section for instructions on how to make property values persistent.

zone

Specifies the zone to which the link belongs. 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:

  • The packet belongs to a VLAN.

  • 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.

Examples

Example 1 Configuring an Aggregation

To configure a data-link over an aggregation of devices bge0 and bge1 with key 1, enter the following command:

# dladm create-aggr -d bge0 -d bge1 1

Attributes

See attributes(5) for descriptions of the following attributes:

/usr/sbin

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
SUNWcsu
Interface Stability
Evolving

/sbin

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
SUNWcsr
Interface Stability
Evolving

See Also

ifconfig(1M), zonecfg(1M), attributes(5), smf(5), dlpi(7P)

Notes

There are two ways to make values for link properties persistent across reboots:

The second method, using smf(5), is preferred.

To use the rc feature, perform steps such as the following:

  1. Create a shell script, with permissions 744.

  2. Store the script in /etc/rc3.d.

  3. Inside the script, enter a command such as the following:

    /usr/sbin/dladm set-linkprop -t -p tagmode=vlanonly ce1

    In this example, it is the value for the tagmode property that is being made persistent. The interface ce1 is also particular to this example. Your interface name might be different.

See /etc/rc3.d /README for further guidance.

The second, preferred means of making values persistent is to use the smf(5) facility. To do so, perform steps such as the following:

  1. Compose a manifest file. The following is an example of such a file:

    <service_bundle type='manifest'name='apply_linkprop'>
    <service
            name='network/apply_linkprop'
            type='service'
            version='1'>
    
            <instance name='default' enabled='true'>
    
            <dependency
                    name='dlmgmtd'
                    grouping='require_all'
                    restart_ov='none'
                    type='service'>
            <service_fmri value='svc:/network/datalink-management:default' />
            </dependency>
    
            <exec_method
                    type='method'
                    name='stop'
                    exec=':true'
                    timeout_seconds='3' />
    
            <property_group name='startd' type='framework'>
                    <propval name='duration' type='astring' value='transient' />
            </property_group>
    
            </instance>
    
               <stability value='Evolving' />
    </service>
    
    </service_bundle>

    Store this file in /lib/svc/manifest/network/.

  2. Create a shell script in /lib/svc/method that contains:

    /usr/sbin/dladm set-linkprop -t tagmode=vlanonly ce1

    The property, tagmode, and interface name, ce1, are examples. Use the names appropriate for your system.

Any additional properties you want to make persistent should be added, as separate commands, to the preceding shell script. There is no need to create an additional manifest file.