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

Document Information

Preface

Introduction

System Administration Commands - Part 1

6to4relay(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)

acpihpd(1M)

adbgen(1M)

add_allocatable(1M)

addbadsec(1M)

add_drv(1M)

aimanifest(1M)

arp(1M)

asradm(1M)

asr-notify(1M)

atohexlabel(1M)

audit(1M)

auditconfig(1M)

auditd(1M)

auditrecord(1M)

auditreduce(1M)

auditstat(1M)

audit_warn(1M)

automount(1M)

automountd(1M)

autopush(1M)

bart(1M)

beadm(1M)

boot(1M)

bootadm(1M)

bootconfchk(1M)

bootparamd(1M)

busstat(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_sdcard(1M)

cfgadm_shp(1M)

cfgadm_sysctrl(1M)

cfgadm_usb(1M)

chargefee(1M)

chat(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)

configCCR(1M)

consadm(1m)

console-reset(1M)

coreadm(1M)

cpustat(1M)

croinfo(1M)

cron(1M)

cryptoadm(1M)

datadm(1M)

dcopy(1M)

dcs(1M)

dd(1M)

ddu(1M)

ddu-text(1M)

devchassisd(1M)

devfsadm(1M)

devfsadmd(1M)

device_allocate(1M)

device_remap(1M)

devinfo(1M)

devlinks(1M)

devnm(1M)

devprop(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)

diskinfo(1M)

disks(1M)

diskscan(1M)

dispadmin(1M)

distro_const(1M)

dladm(1M)

dlmgmtd(1M)

dlstat(1M)

dmesg(1M)

dminfo(1M)

dns-sd(1M)

dnssec-dsfromkey(1M)

dnssec-keyfromlabel(1M)

dnssec-keygen(1M)

dnssec-makekeyset(1M)

dnssec-signkey(1M)

dnssec-signzone(1M)

dodisk(1M)

domainname(1M)

drd(1M)

drvconfig(1M)

dsbitmap(1M)

dscfg(1M)

dscfgadm(1M)

dscfglockd(1M)

dsstat(1M)

dsvclockd(1M)

dtrace(1M)

dumpadm(1M)

editmap(1M)

edquota(1M)

eeprom(1M)

efdaemon(1M)

embedded_su(1M)

emCCR(1M)

emocmrsp(1M)

etrn(1M)

fbconfig(1M)

fbconf_xorg(1M)

fcadm(1M)

fcinfo(1M)

fdetach(1M)

fdisk(1M)

ff(1M)

ff_ufs(1M)

fingerd(1M)

fiocompress(1M)

flowadm(1M)

flowstat(1M)

fmadm(1M)

fmd(1M)

fmdump(1M)

fmstat(1M)

fmthard(1M)

format(1M)

fruadm(1M)

fsck(1M)

fsck_pcfs(1M)

fsck_udfs(1M)

fsck_ufs(1M)

fsdb(1M)

fsdb_udfs(1M)

fsdb_ufs(1M)

fsflush(1M)

fsirand(1M)

fssnap(1M)

fssnap_ufs(1M)

fsstat(1M)

fstyp(1M)

fuser(1M)

fwflash(1M)

fwtmp(1M)

getdevpolicy(1M)

getent(1M)

gettable(1M)

getty(1M)

gkadmin(1M)

groupadd(1M)

groupdel(1M)

groupmod(1M)

growfs(1M)

grpck(1M)

gsscred(1M)

gssd(1M)

hald(1M)

hal-device(1M)

hal-fdi-validate(1M)

hal-find(1M)

hal-find-by-capability(1M)

hal-find-by-property(1M)

hal-get-property(1M)

hal-set-property(1M)

halt(1M)

hextoalabel(1M)

host(1M)

hostconfig(1M)

hotplug(1M)

hotplugd(1M)

htable(1M)

ickey(1M)

id(1M)

idmap(1M)

idmapd(1M)

idsconfig(1M)

ifconfig(1M)

if_mpadm(1M)

ifparse(1M)

iiadm(1M)

iicpbmp(1M)

iicpshd(1M)

ikeadm(1M)

ikecert(1M)

ilbadm(1M)

ilbd(1M)

ilomconfig(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.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)

installadm(1M)

installboot(1M)

installf(1M)

installgrub(1M)

in.stdiscover(1M)

in.stlisten(1M)

in.talkd(1M)

in.telnetd(1M)

in.tftpd(1M)

in.timed(1M)

intrd(1M)

intrstat(1M)

in.uucpd(1M)

iostat(1M)

ipaddrsel(1M)

ipadm(1M)

ipf(1M)

ipfs(1M)

ipfstat(1M)

ipmgmtd(1M)

ipmon(1M)

ipmpstat(1M)

ipnat(1M)

ippool(1M)

ipqosconf(1M)

ipsecalgs(1M)

ipsecconf(1M)

ipseckey(1M)

iscsiadm(1M)

isns(1M)

isnsadm(1M)

itadm(1M)

itu(1M)

js2ai(1M)

k5srvutil(1M)

kadb(1M)

kadmin(1M)

kadmind(1M)

kadmin.local(1M)

kcfd(1M)

kclient(1M)

kdb5_ldap_util(1M)

kdb5_util(1M)

kdcmgr(1M)

kernel(1M)

keyserv(1M)

killall(1M)

kmem_task(1M)

kmscfg(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)

latencytop(1M)

ldapaddent(1M)

ldap_cachemgr(1M)

ldapclient(1M)

ldmad(1M)

link(1M)

llc2_loop(1M)

lldpadm(1M)

lldpd(1M)

lms(1M)

locator(1M)

lockd(1M)

lockfs(1M)

lockstat(1M)

lofiadm(1M)

logadm(1M)

logins(1M)

lshal(1M)

System Administration Commands - Part 2

System Administration Commands - Part 3

lldpadm

- Link Layer Discovery Protocol administration tool

Synopsis

lldpadm set-agentprop -p prop[+|-]=value[,...] lldp_agent
lldpadm reset-agentprop -p prop[,...] lldp_agent
lldpadm show-agentprop [[-c] -o field,...] -p prop[,...] [lldp_agent]
lldpadm set-tlvprop -p prop[+|-]=value[,...] tlv_name
lldpadm reset-tlvprop -p prop[,...] tlv_name
lldpadm show-tlvprop [[-c] -o field,...] -p prop[,...] [tlv_name]
lldpadm set-agenttlvprop -p prop[+|-]=value[,...] -a lldp_agent
     tlv_name
lldpadm reset-agenttlvprop -p prop[,...] -a lldp_agent tlv_name
lldpadm show-agenttlvprop [[-c] -o field,...] -p prop[,...]
     [-a lldp_agent] [tlv_name]
lldpadm show-agent [-c] [-s] [-v] -o field,...] [-l|-r] [lldp_agent]

Description

The lldpadm command is used to enable or disable a Link Layer Discovery Protocol (LLDP) agent on a physical datalink. lldpadm is also used to configure the behavior of an LLDP agent. The LLDP agent implements the LLDP protocol for a given physical datalink. LLDP is a one-way link layer protocol that allows an IEEE 802 LAN station to advertise the capabilities and current status of the system to other stations attached to the same LAN. The LLDP agent can also receive information about the capabilities and current status of the system associated with a remote station. LLDP agent can either be enabled for transmission only, for reception only, or for both.

Information to be exchanged is packed as a sequence of type, length, and value (TLVs), wherein the type field identifies the type of information, the length field indicates the length of the information field in octets, and the value field contains the information itself.

Operands

Each lldpadm subcommand operates on one of the following objects:

lldp_agent

An LLDP agent implements the LLDP protocol for a given physical datalink that is connected to IEEE 802 LAN. The only supported physical links are the ones of media type Ethernet. Thus, LLDP can be enabled on all the links displayed in dladm show-phys output that are of media type Ethernet. The name of the lldp_agent is the name of the datalink itself.

tlv_name

Name of the TLV whose value can be modified. The supported modifiable TLVs are:

  • syscapab and mgmtaddr. These form Global TLVs that are common to all the LLDP agents on the system.

  • pfc, ets, and appln. Per-LLDP agent TLVs.

Sub-commands

lldpadm supports the following subcommands.

lldpadm set-agentprop|set-ap -p prop[+|-]=value[,...] lldp_agent

Sets the value of one or more LLDP agent properties to the value specified. If the property takes multiple values then the value should be specified with a comma as the delimiter. The value is always made persistent and thus will be reapplied on system reboot or lldpd(1M) daemon restart. The list of properties supported and each property's possible values can be retrieved using show-agentprop subcommand.

-p prop[+|-]=value[,...], --prop prop[+|-]=value[,...]

A comma-separated list of properties to be set to the specified values. It also provides the following qualifiers to perform add and delete operations in addition to assignment.

+

Adds the given value to the current list of value(s).

-

Removes the given value from the current list of value(s).

=

Makes a new assignment and removes all the current value(s).

See EXAMPLES for more information on how to use the qualifiers.

lldpadm reset-agentprop|reset-ap -p prop[,...] lldp_agent

Resets one or more properties to their default values. The default values for properties can be retrieved using show-agentprop subcommand.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to reset.

lldpadm show-agentprop|show-ap [[-c] -o field,...] -p prop[,...] [lldp_agent]

Show the current value of one or more properties, either for all of the LLDP agents or for the specified LLDP agent. Several properties of interest can be retrieved at a time by providing comma-separated property names to -p option. If the -p option is not specified, all available properties are displayed.

-o field[,...], --output field[,...]

A case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed below, or the special value all to display all fields. For each LLDP agent, the following fields can be displayed:

AGENT

The name of the LLDP agent.

PROPERTY

The name of the property.

PERM

The read/write permissions of the property. The value shown will be r (read only), w (write only) or rw (read/write).

VALUE

The current value of the property. If the value is not set, it is shown as --. If it is unknown, the value is shown as ?.

DEFAULT

The default value of the property. If the property has no default value, -- is shown.

POSSIBLE

A comma-separated list of the values the property can have. If the values span a numeric range, min - max might be shown as shorthand. If the possible values are unknown or unbounded, -- is shown.

-c, --parsable

Display using a stable machine-parsable format. The -o option is required with this option. See “Parsable Output Format”, below.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to display.

For the supported list of agent properties, see “Agent Properties” section below.

lldpadm set-tlvprop|set-tp -p prop[+|-]=value[,...] tlv_name

Sets the value of one or more TLV properties to the value specified. If the property takes multiple values, the value should be specified with a comma as the delimiter. The value is always persisted and will be reapplied on system reboot or lldpd(1M) daemon restart. The list of properties supported and each property's possible values can be retrieved using show-tlvprop subcommand.


Note - The TLVs modified using this subcommand apply to all the LLDP agents running on the system.


-p prop[+|-]=value[,...], --prop prop[+|-]=value[,...]

See the description of this option under the set-agentprop subcommand, above.

lldpadm reset-tlvprop|reset-tp -p prop[,...] tlv_name

Resets one or more properties to their default values. The default values for properties can be retrieved using show-tlvprop subcommand.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to reset.

lldpadm show-tlvprop|show-tp [[-c] -o field,...] -p prop[,...] [lldp_agent]

Show the current value of one or more properties, either for all the TLVs or for a specified TLV. Several properties of interest can be retrieved at a time by providing comma-separated property names to -p option. If the -p option is not specified, all available properties are displayed.

-o field[,...], --output field[,...]

A case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed below, or the special value all to display all fields. For each TLV, the following fields can be displayed:

TLVNAME

The name of the TLV.

PROPERTY

The name of the property.

PERM

The read/write permissions of the property. The value shown will be r (read only), w (write only) or rw (read/write).

VALUE

The current value of the property. If the value is not set, it is shown as --. If it is unknown, the value is shown as ?.

DEFAULT

The default value of the property. If the property has no default value, -- is shown.

POSSIBLE

A comma-separated list of the values the property can have. If the values span a numeric range, min - max might be shown as shorthand. If the possible values are unknown or unbounded, -- is shown.

-c, --parsable

Display using a stable machine-parsable format. The -o option is required with this option. See “Parsable Output Format”, below.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to display.

lldpadm set-agenttlvprop|set-atp -p prop[+|-]=value[,...] -a lldp_agent tlv_name

Sets the value of one or more TLV properties to the value specified. The -a option is mandatory and identifies the name of the agent for which the TLV property needs to be set. In this way, the TLV property modification is reflected only on the specified agent. If the property takes multiple values then the value should be specified with a comma as the delimiter. The value is always made persistent and will be reapplied on system reboot or lldpd(1M) daemon restart. The list of properties supported and each property's possible values can be retrieved using show-agenttlvprop subcommand.

-p prop[+|-]=value[,...], --prop prop[+|-]=value[,...]

See the description of this option under the set-agentprop subcommand, above.

-a lldp_agent, --agent=lldp_agent

The name of the LLDP agent for which TLV properties need to be displayed.

lldpadm reset-agenttlvprop|reset-atp -p prop[,...]=value[,...] -a lldp_agent tlv_name

Resets one or more properties to their default values. The -a option is mandatory and identifies the name of the agent for which the TLV property needs to be reset. The default values for properties can be retrieved using show-agenttlvprop subcommand.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to display.

-a lldp_agent, --agent=lldp_agent

The name of the LLDP agent for which TLV properties need to be displayed.

lldpadm show-agenttlvprop|show-atp [[-c] -o field,...] -p prop[,...] [-a lldp_agent] [tlv_name]

Show the current value of one or more properties, either for all of the TLVs or for a specified TLV. If a single LLDP agent is not specified (using -a), TLV properties for all LLDP agents are displayed. Several properties of interest can be retrieved at a time by providing comma-separated property names to the -p option. If the -p option is not specified, all available properties are displayed.

-o field[,...], --output field[,...]

A case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed below, or the special value all to display all fields. For each LLDP agent, the following fields can be displayed:

AGENT

The name of the LLDP agent.

TLVNAME

The name of the TLV.

PROPERTY

The name of the property.

PERM

The read/write permissions of the property. The value shown will be r (read only), w (write only) or rw (read/write).

VALUE

The current value of the property. If the value is not set, it is shown as --. If it is unknown, the value is shown as ?.

DEFAULT

The default value of the property. If the property has no default value, -- is shown.

POSSIBLE

A comma-separated list of the values the property can have. If the values span a numeric range, min - max might be shown as shorthand. If the possible values are unknown or unbounded, -- is shown.

-c, --parsable

Display using a stable machine-parsable format. The -o option is required with this option. See “Parsable Output Format”, below.

-p prop[,...], --prop prop[,...]

A comma-separated list of properties to display.

-a lldp_agent, --agent=lldp_agent

The name of the LLDP agent for which TLV properties need to be displayed.

For the supported list of TLV properties that apply on a per-LLDP agent basis, see the “Per-LLDP agent TLV properties” section, below.

lldpadm show-agent [-c] [-s] [-v] -o field,...] [-l | -r] [lldp_agent]

Show the information advertised by the specified LLDP agent or information advertised by the adjacent neighbors to the specified LLDP agent. If no LLDP agent is specified, then the local or remote information will be displayed for all the LLDP agents. The information is displayed as a multi-line output, with each line containing information about a single TLV in the following format:

<Name of the TLV> : <TLV Information expressed as a string>

The following lines can be displayed:

                     Agent:
        Chassis ID Subtype:
                Chassis ID:
           Port ID Subtype:
                   Port ID:
          Port Description:
              Time to Live:
               System Name:
        System Description:
    Supported Capabilities:
      Enabled Capabilities:
        Management Address:
        Maximum Frame Size:
              Port VLAN ID:
              VLAN Name/ID:
       VNIC PortID/VLAN ID:
   Aggregation Information:
               PFC Willing:
                   PFC Cap:
                   PFC MBC:
                PFC Enable:
                PFC Pending:  [displayed only when -l is used]
               ETS Willing:
        ETS Configured CBS:
        ETS Configured TCS:
        ETS Configured PAT:
        ETS Configured BAT:
        ETS Configured TSA:
       ETS Recommended PAT:
       ETS Recommended BAT:
       ETS Recommended TSA:
Application(s)(ID/Sel/Pri):
                  EVB Mode:
         EVB GID (Station):
                 EVB RRREQ:
                EVB RRSTAT:
          EVB GID (Bridge):
                 EVB RRCAP:
                 EVB RRCTR:
                     EVB R:
                   EVB RTE:
               EVB ROL RWD:
                   EVB RWD:
               EVB ROL RKA:
                   EVB RKA:
  Next Packet Transmission:  [displayed only when -l is used] 
   Information Valid Until:  [displayed only when -r is used]

In preceding output, the ETS parameters are described as follows:

ETS Configured CBS

Indicates whether Credit-Based Shaper is supported.

ETS Configured TCS

Number of Traffic Classes supported.

ETS Configured PAT

Priority Assignment Table.

ETS Configured BAT

Bandwidth Assignment Table.

ETS Configured TSA

Transmission Selection Algorithm supported.

ETS Recommended values

Values that will be recommended to the peer.

-c, --parsable

Display using a stable machine-parsable format. The -o option is required with this option. See “Parsable Output Format”, below.

-l, --local

Displays information advertised by the local LLDP agent. This option is mutually exclusive of the -r option.

-r, --remote

Displays information advertised by the adjacent neighbors. This option is mutually exclusive of the -l option.

-s

Show the statistics for the specified LLDP agents or for all the LLDP agents on the system. Every LLDP agent maintains statistical counters that are used to count significant events in the transmit and receive state machines. These counters are defined to be 32-bit unsigned integers.

-o field[,...], --output field[,...]

A case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed below, or the special value all to display all fields. For each TLV, the following fields can be displayed:

AGENT

The name of the LLDP agent.

IFRAMES

Count of all LLDP frames received by AGENT.

IERR

Count of all LLDPDUs received with one or more detectable errors.

IDISCARD

Count of all LLDPDUs received and then discarded for any of the following reasons:

  • incorrectly formed LLDPDUs with respect to the first three mandatory TLVs

  • insufficient space to store the incoming LLDPDU

OFRAMES

Count of all LLDP frames transmitted by AGENT.

OLENERR

Count of times the outgoing LLDPDU exceeded the length restrictions of 1500 bytes.

TLVDISCARD

Count of all TLVs received and then discarded because the TLVs did not adhere to the TLV usage rules as specified by the standard.

TLVUNRECOG

Count of all TLVs received that are not recognized by the LLDP agent.

AGEOUT

Count of the times that a neighbor's information has been deleted because of aging.

-v, --verbose

Displays detailed information.

Parsable Output Format

The lldpadm show subcommands have a -c option that displays output in a machine-parsable format. The output format is one or more lines of colon (:)-delimited fields. The fields displayed are specific to the subcommand used and are listed under the entry for the -o option for a given subcommand. Output includes only those fields requested by means of the --o option, in the order requested. Note that the -o all option, which displays all the fields for a given subcommand, cannot be used with the parsable output option.

When you request multiple fields, any literal colon characters are escaped by a backslash (\) before being output. Similarly, literal backslash characters are also escaped with a backslash. This escape format is parsable by using shell read(1) functions with the environment variable set as IFS=: Note that escaping is not done when you request only a single field.

Agent Properties

The following LLDP agent properties are supported:

mode

Configures the operation mode of the LLDP agent. Possible values are:

txonly

Enables LLDP for transmission only.

rxonly

Enables LLDP for receiving only.

both

Enables LLDP for both transmission and receiving.

disable

Disables LLDP on the LLDP agent.

Every LLDP packet (LLDPDU) transmitted by an LLDP agent contains multiple TLVs. The following four TLVs are mandatory and therefore included in all the LLDPDUs transmitted by an agent configured in the txonly or both mode:

CHASSIS ID

The value transmitted in the Chassis ID TLV is:

  • subtype = 7 (locally assigned)

  • Chassis ID = hostid(1)

PORT ID

The value transmitted in the Port ID TLV is:

  • subtype = 3 (MAC address)

  • Port ID = primary MAC address of the agent

TTL

The duration for which this packet is valid. The default value is 30 seconds.

End of PDU TLV

End of PDU indicator.

Optional TLVs that can be advertised are configured using the following properties:

basic-tlv

Configures the Basic Management TLVs that should be advertised by the LLDP agent. The possible values are:

portdesc

Alphanumeric string that identifies the datalink. Value set to the linkname.

sysname

Alphanumeric string that identifies the system. Value set to the output of 'uname -n'.

sysdesc

Alphanumeric string that describes the system. Value set to the output of 'uname -a'.

syscapab

Indicates the systems supported and enabled capabilities.

mgmtaddr

Indicates the IP address of the system that can be used by network management.

dot1-tlv

Configures the IEEE 802.1 Organizationally Specific TLVs that should be advertised by the LLDP agent. The possible values are:

vlanname

Indicates the names and IDs of all the VLANS configured on the datalink.

pvid

Indicates the default VLAN ID associated with the given datalink. It corresponds to the default_tag datalink property that is managed by means of the dladm(1M) utility.

linkaggr

Indicates whether underlying datalink is in an aggregation or is capable of being part of an aggregation.

pfc

Indicates whether underlying datalink supports PFC (Priority Flow Control) and the priorities for which the PFC pause frame is enabled. Also indicates whether the local endpoint is willing to negotiate the PFC configuration.

ets-cfg

Indicates the ETS (Enhanced Transmission Selection) configuration on the host when the underlying physical link supports ETS feature. Also indicates whether the local endpoint is willing to negotiate the ETS configuration.

appln

Indicates the priority that will be used by an application.

dot3-tlv

Configures the IEEE 802.3 Organizationally Specific TLVs that should be advertised by the LLDP agent. The possible values are:

max-framesize

Indicates the maximum supported frame size for the underlying datalink.

virt-tlv

Configures the Solaris's Virtualization Specific TLVs that should be advertised by the LLDP agent. The possible values are:

vnic

Indicates the MAC address of the Virtual NIC created on top of the underlying physical link. Also indicates any VLAN id associated with the VNIC. See dladm(1M) for more information on VNIC.

Global TLVs and Their Properties

The following Global TLV properties are supported:

syscapab (TLV name)

This property can one of the following values:

supported

Indicates the supported capabilities on the system. The default supported capabilities are: bridge, router, and station.

enabled

Indicates the enabled capabilities on the system. The enabled capabilities must be a subset of the supported capabilities.

mgmtaddr (TLV name)

This property can have the following value:

ipaddr

The IP address(es), either IPv4 or IPv6, associated with the local LLDP agent that will be used to reach higher layer entities to assist discovery by network management.

Per-Agent TLVs and Their Properties

The following Agent TLV properties are supported:

appln (TLV name)

This property can have the following value:

apt

Configures the Application Priority Table for an Application TLV. One can add or remove entries from this table using the + and - qualifiers. Each entry in the table indicates the application and the priority that will be used for that application. Its value is of the form:

id/selector/priority

The meaning of the id is determined by the selector field. The selector field can be any one of the following:

  • 1id indicates an Ethertype (an L2 protocol), therefore id's value should be greater than 1536

  • 2id indicates a port number over TCP or SCTP

  • 3id indicates a port number over UDP or DCCP

  • 4id indicates a port number over TCP, SCTP, UDP, or DCCP

The priority indicates the priority value (0-7) that will be used for given application.

ets (TLV name)

This property can have the following value:

willing

Indicates whether the host is willing to accept the peer's ETS recommendation. This property is likely to change in the future.

pfc (TLV name)

This property can have the following value:

willing

Configures the willingness to accept the configuration from the remote peer and change the operational configuration on the host locally for a Priority-based Flow Control TLV. Its value can be on (default) or off. This property is subject to change in future releases.

Authorizations

The following subcommands require solaris.network.lldp authorization:

The various show-* subcommands do not need any authorization.

Examples

Example 1 Enabling LLDP Protocol on an LLDP Agent

The following command enables the LLDP protocol on an LLDP agent for both transmission and reception of LLDPDUs.

# lldpadm set-agentprop -p mode=both net0

Example 2 Disabling LLDP Protocol on an LLDP Agent

The following command disables the LLDP protocol on an LLDP agent.

# lldpadm set-agentprop -p mode=disable net0

Example 3 Configuring TLVs

The following command configures transmission of the Port Description and System Name TLV.

# lldpadm set-agentprop -p basic-tlv=portdesc,sysname net0

The following command configures transmission of a VLAN Name TLV and a Link Aggregation TLV.

# lldpadm set-agentprop -p dot1-tlv=vlanname net0
# lldpadm set-agentprop -p dot1-tlv+=linkaggr net0

The following command configures transmission of all dot3-tlvs.

# lldpadm set-agentprop -p dot3-tlv=all net0

All the above lldpadm invocations can be combined into the following, single invocation.

# lldpadm set-agentprop -p basic-tlv=portdesc,sysname,\
dot1-tlv=vlanname,linkaggr,dot3-tlv=all net0

Example 4 Disabling Transmission

The following command disables the transmission of all dot1-tlvs out of an LLDP agent.

# lldpadm set-agentprop -p dot1-tlv=none net0

The following command is equivalent to the preceding.

# lldpadm reset-agentprop -p dot1-tlv net0

Example 5 Configuring Enabled Capabilities

The following command configures the enabled capabilities on a system.

# lldpadm set-tlvprop -p enabled=router syscapab

With this configuration, when an LLDP agent is enabled for advertising a System Capabilities TLV, the adjacent neighbors would learn of the local system's capabilities.

Example 6 Configuring a Management Address for Subsequent Advertising

The following command configures the management address that will be advertised by means of the Management Address TLV.

# lldpadm set-tlvprop -p ipaddr=192.168.1.2 mgmtaddr

Note that this address would be identified as an address associated with the local LLDP agent that will be used to reach higher layer entities to assist discovery by network management.

Example 7 Configuring an Application TLV

The following sequence of commands configures the application TLV to advertise the priority that will be used by FCoE.

# lldpadm set-agenttlvprop -p apt=8906/1/4 -a net0 appln
# lldpadm show-agenttlvprop -a net0 appln
AGENT    TLVNAME PROPERTY  PERM VALUE        DEFAULT        POSSIBLE
net0     appln   apt         rw 8906/1/4     --             --

Example 8 Show Local Information Advertised by LLDP Agent

The following commands show, respectively, brief and detailed local information advertised by an LLDP agent.

Brief information:

# lldpadm show-agent -l net0
AGENT               CHASSISID           PORTID
net0                004bb87f            00:14:4f:01:77:5d

Detailed information:

# lldpadm show-agent -lv net0
                     Agent: net0
        Chassis ID Subtype: Local(7)
                Chassis ID: 004bb87f
           Port ID Subtype: MacAddress(3)
                   Port ID: 00:14:4f:01:77:5d
          Port Description: net0
              Time to Live: 81 (seconds)
               System Name: hosta.example.com
        System Description: SunOS 5.11 dcb-clone-x-01-19-11 i86pc
    Supported Capabilities: bridge, router, station
      Enabled Capabilities: router
        Management Address: 192.168.1.2
        Maximum Frame Size: 3000
              Port VLAN ID: --
              VLAN Name/ID: vlan25/25
      VNIC PortID/VLAN ID : --
   Aggregation Information: Capable, Not Aggregated
               PFC Willing: --
                   PFC Cap: --
                   PFC MBC: --
                PFC Enable: --
               PFC Pending: --
        ETS Configured CBS: 0
        ETS Configured TCS: 8
        ETS Configured PAT: 0,1,2,3,4,5,6,7
        ETS Configured BAT: 70,30,0,0,0,0,0,0
        ETS Configured TSA: 2,2,2,2,2,2,2,2
       ETS Recommended PAT: --
       ETS Recommended BAT: --
       ETS Recommended TSA: --
Application(s)(ID/Sel/Pri): --
                  EVB Mode: Station
         EVB GID (Station): Not Supported
                 EVB RRREQ: Not Requested
                EVB RRSTAT: RR Unknown
          EVB GID (Bridge): Not Supported
                 EVB RRCAP: Not Supported
                 EVB RRCTR: Not Enabled
                     EVB R: 3
                   EVB RTE: 20
               EVB ROL RWD: Local
                   EVB RWD: 20
               EVB ROL RKA: Local
                   EVB RKA: 20
  Next Packet Transmission: 18 (seconds)

The above ETS-related information indicates that CBS is not supported, 8 Traffic Classes are supported, there is a 1-to-1 mapping between the priority and the Traffic Class, the bandwidth allocation among the Traffic Classes are 70,30, 000000, and the transmission algorithm used for all the Traffic Classes is ETS.

Example 9 Show Remote Information about Adjacent Devices for an LLDP Agent

The following commands show, respectively, brief and detailed remote information about adjacent devices for a given LLDP agent.

Brief information:

# lldpadm show-agent -r net0
AGENT      SYSNAME      CHASSISID       PORTID
net0       hostb        0083b390        00:14:4f:01:59:ab

Detailed information:

# lldpadm show-agent -rv net0
                     Agent: net0
        Chassis ID Subtype: Local(7)
                Chassis ID: 0083b390
           Port ID Subtype: MacAddress(3)
                   Port ID: 00:14:4f:01:59:ab
          Port Description: net0
              Time to Live: 121 (seconds)
               System Name: hostb.example.com
        System Description: SunOS 5.11 dcb-clone-x-01-19-11 i86pc
    Supported Capabilities: bridge, router, station
      Enabled Capabilities: router
        Management Address: 192.168.1.3
        Maximum Frame Size: 3000
              Port VLAN ID: --
              VLAN Name/ID: vlan25/25
      VNIC PortID/VLAN ID : 02:08:20:72:71:31
   Aggregation Information: Capable, Not Aggregated
               PFC Willing: --
                   PFC Cap: --
                   PFC MBC: --
                PFC Enable: --
               PFC Pending: --
        ETS Configured CBS: 0
        ETS Configured TCS: 8
        ETS Configured PAT: 0,1,2,3,4,5,6,7
        ETS Configured BAT: 100,0,0,0,0,0,0,0
        ETS Configured TSA: 2,2,2,2,2,2,2,2
       ETS Recommended PAT: --
       ETS Recommended BAT: --
       ETS Recommended TSA: --
Application(s)(ID/Sel/Pri): --
                  EVB Mode: Bridge
         EVB GID (Station): Not Supported
                 EVB RRREQ: Not Requested
                EVB RRSTAT: RR Unknown
          EVB GID (Bridge): Not Supported
                 EVB RRCAP: Not Supported
                 EVB RRCTR: Not Enabled
                     EVB R: 3
                   EVB RTE: 20
               EVB ROL RWD: Local
                   EVB RWD: 20
               EVB ROL RKA: Local
                   EVB RKA: 20
   Information Valid Until: 117 (seconds)

Example 10 Show LLDP Agent Statistics

The following command displays LLDP agent statistics.

# lldpadm show-agent -s net0
AGENT IFRAMES IERR IDISCARD OFRAMES OLENERR TLVDISCARD TLVUNRECOG AGEOUT
net0       44    0        0      57       0          0          0      0

Attributes

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

/sbin

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
service/network/lldp
Interface Stability
Committed

See Also

hostid(1), read(1), uname(1), dladm(1M), lldpd(1M), svcadm(1M), attributes(5)

IEEE Std 802.1AB-2009, IEEE Standard for Local and Metropolitan Area Networks: Station and Media Access Control Connectivity Discovery

IEEE Draft 802.1Qbb, Virtual Bridged Local Area Networks - Amendment : Priority-based Flow Control

IEEE Draft 802.1Qaz, Virtual Bridged Local Area Networks - Amendment XX: Enhanced Transmission Selection for Bandwidth Sharing between Traffic Classes

Notes

The lldpd(1M) daemon that implements the LLDP protocol must be first enabled before using the lldpadm command. The lldpd daemon is controlled through the service management facility (SMF) service instance:

svc:/network/lldp:default

Use svcadm(1M) to enable this service.