Peter Memishian wrote:
> Some additional comments, below:
>
> > NAME
> > dladm - administer data links
> >
> > SYNOPSIS
> > dladm show-link [-pP] [-s [-i interval]] [-o field[,...]] [link]
> > dladm rename-link [-R root-dir] link new-link
> >
> >
> > dladm show-dev [-p] [-s [-i interval]] [-o field[,...]] [dev]
> >
> >
> > dladm delete-phys link
> > dladm show-phys [-pP] [-o field[,...]] [link]
> >
> >
> > dladm show-ether [-px] [-o field[,...]] [link]
>
> show-ether probably belongs after show-wifi, since it's mactype-specific.
Fixed.
>
> > Each dladm subcommand operates on one of the following
> > objects:
> >
> > link Datalinks, identified by a name.
> >
> >
> > dev Network devices, identified by concatenation of a
> > driver name and an instance number.
> >
> >
> > aggr Aggregations of network devices, identified either
> > by a name or an administratively-chosen key between 1 and
> > 999.
>
> The mention of "aggr" here seems a bit strange since we no longer use it
> elsewhere in the manpage. It might make sense to keep it given that it
> would simplify some of the descriptions of the aggr subcommands, but OTOH
> if we did that, we'd probably want to follow-suit with "vlan" and (one
> day) iptun. (However, if we do decide to keep it, it should be changed to
> say "aggregations of datalinks".)
I agree, and it does simplify the subcommand descriptions. I'll send out
an update once I've made all of the associated changes.
>
> > CLASS
> >
> > The class of the datalink. dladm distinguishes
> > between the following classes:
> >
> > phys
> >
> > A physical datalink. The show-phys subcommand
> > displays more detail for this class of datalink.
> > For WiFi physical datalinks, the show-wifi
> > subcommand will also display WiFi-specific
> > information.
>
> Seems like the WiFi sentence should be generalized given the arrival of
> show-ether.
Or removed entirely. I've removed it.
> > dladm rename-link [-R root-dir] link new-link
> >
> > Rename "link" to "new-link". This is used to give a link a
>
> In general, I presume most uses of "" are only for review and will be
> replaced with appropriate markup in the official version (Terry?)
I'll let Terry answer that, but my understanding is that, yes, quotes are
replaced by some other markup like italics or bold.
>
> > dladm delete-phys link
> >
> > This command is used to delete the persistent configuration of
> > a link associated with physical hardware which has been removed
> > from the system.
>
> This subcommand is also probably worthy of an example.
Here's the example I came up with:
Example 9 Removing a Network Card
Suppose that in the previous example, the intent is not to replace
the bge0 NIC with another NIC at all, but simply to remove the
hardware. In that case, the mgmt0 datalink configuration is not
slated to be associated with a different physical device as shown
in the previous example, but needs to be deleted. Enter the
following command to delete the datalink configuration associated
with the mgmt0 datalink, whose physical hardware (bge0 in this
case) has bee removed:
# dladm delete-phys mgmt0
>
> > dladm create-aggr [-t] [-R root-dir] [-P policy] [-L mode]
> > [-T time] [-u address] -l linkn ... link
>
> "-l linkn ..." notation here needs to be updated to match add-aggr et al.
Fixed.
>
> > dladm create-vlan [-ft] [-R root-dir] -l plink -v vlan-tag [link]
> >
> > Create a tagged VLAN link with tag "vlan-tag" over physical
> > link "plink". The name of the VLAN link may be specified as
> > "link".
>
> I could be mistaken, but IIRC the VLAN tag includes the VLAN ID -- and all
> that we allow to be specified here is the VLAN ID. So I think "vlan-tag"
> should be "vid" and "tag" should be replaced with "ID".
Yes, you're right. I tend to use "tag" and "ID" synonymously, but
they're in fact distinct since strictly speaking, the "tag" includes the
user priority and format indicator.
> > VID
> >
> > The VLAN tag (ID) associated with the VLAN.
> >
>
> Likewise, I think my earlier suggestion should be revised to just be "The
> ID associated with the VLAN".
Yes, will fix.
>
> > General Link Property
> >
> > The following general link property is supported:
> >
>
> With the advent of "autopush", the above bit of text needs to be made
> plural.
Good catch.
>
> > autopush
> >
> > Specifies the set of STREAMS modules to push on the
> > stream associated with a link when its DLPI device is
> > opened. It is a space delimited list of modules.
>
> [anchor] should probably also be mentioned.
I could copy the description verbatim from autopush(1M):
The optional special character
sequence [anchor] indicates that a STREAMS
anchor should be placed on the stream at the
module previously specified in the list; it
is an error to specify more than one anchor
or to have an anchor first in the list.
Will that do?
>
> > Example 7 Renaming a Link
> >
> > To rename the bge0 link to mgmt0, enter the following command:
> >
> > # dladm rename-link bge0 mgmt0
>
> Should we mention that the link needs to be unused and that any persistent
> configuration outside of the datalink layer will need to be adjusted?
The link needing to be unused is mentioned in the documentation for
rename-link, but adding a caveat regarding modifying configuration
external to dladm would be good. I'll send an update when I've done that.
Thanks,
-Seb
