Print this page
4641 dladm.1m misidentifies OBYTES
7669 several typos in dladm.1m
   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright 2016 Joyent, Inc.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
   6 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
   7 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
  11 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH DLADM 1M "Oct 01, 2016"
  13 .SH NAME
  14 dladm \- administer data links
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR]
  19 \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR
  20 .fi
  21 
  22 .LP
  23 .nf
  24 \fBdladm delete-phys\fR \fIphys-link\fR
  25 \fBdladm show-phys\fR [\fB-m\fR | \fB-H\fR | \fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIphys-link\fR]
  26 .fi
  27 
  28 .LP
  29 .nf
  30 \fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  31      [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...] \fIaggr-link\fR
  32 \fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]


 489 Number of input errors.
 490 .RE
 491 
 492 .sp
 493 .ne 2
 494 .na
 495 \fB\fBOPACKETS\fR\fR
 496 .ad
 497 .sp .6
 498 .RS 4n
 499 Number of packets sent on this link.
 500 .RE
 501 
 502 .sp
 503 .ne 2
 504 .na
 505 \fB\fBOBYTES\fR\fR
 506 .ad
 507 .sp .6
 508 .RS 4n
 509 Number of bytes received on this link.
 510 .RE
 511 
 512 .sp
 513 .ne 2
 514 .na
 515 \fB\fBOERRORS\fR\fR
 516 .ad
 517 .sp .6
 518 .RS 4n
 519 Number of output errors.
 520 .RE
 521 
 522 .RE
 523 
 524 .sp
 525 .ne 2
 526 .na
 527 \fB\fB-p\fR, \fB--parsable\fR\fR
 528 .ad
 529 .sp .6


 974 \fB\fB-L\fR \fImode\fR, \fB--lacp-mode\fR=\fImode\fR\fR
 975 .ad
 976 .sp .6
 977 .RS 4n
 978 Specifies whether \fBLACP\fR should be used and, if used, the mode in which it
 979 should operate. Supported values are \fBoff\fR, \fBactive\fR or \fBpassive\fR.
 980 .RE
 981 
 982 .sp
 983 .ne 2
 984 .na
 985 \fB\fB-T\fR \fItime\fR, \fB--lacp-timer\fR=\fItime\fR\fR
 986 .ad
 987 .br
 988 .na
 989 \fB\fR
 990 .ad
 991 .sp .6
 992 .RS 4n
 993 Specifies the \fBLACP\fR timer value. The supported values are \fBshort\fR or
 994 \fBlong\fRjjj.
 995 .RE
 996 
 997 .sp
 998 .ne 2
 999 .na
1000 \fB\fB-u\fR \fIaddress\fR, \fB--unicast\fR=\fIaddress\fR\fR
1001 .ad
1002 .sp .6
1003 .RS 4n
1004 Specifies a fixed unicast hardware address to be used for the aggregation. If
1005 this option is not specified, then an address is automatically chosen from the
1006 set of addresses of the component devices.
1007 .RE
1008 
1009 .RE
1010 
1011 .sp
1012 .ne 2
1013 .na
1014 \fB\fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR


2508 .na
2509 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
2510 .ad
2511 .sp .6
2512 .RS 4n
2513 See "Options," above.
2514 .RE
2515 
2516 .RE
2517 
2518 .sp
2519 .ne 2
2520 .na
2521 \fB\fBdladm show-vlan\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
2522 [\fIvlan-link\fR]\fR
2523 .ad
2524 .sp .6
2525 .RS 4n
2526 Display VLAN configuration for all VLAN links or for the specified VLAN link.
2527 .sp
2528 The \fBshow-vlan\fRsubcommand accepts the following options:
2529 .sp
2530 .ne 2
2531 .na
2532 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
2533 .ad
2534 .sp .6
2535 .RS 4n
2536 A case-insensitive, comma-separated list of output fields to display. The field
2537 name must be one of the fields listed below, or the special value \fBall\fR, to
2538 display all fields. For each VLAN link, the following fields can be displayed:
2539 .sp
2540 .ne 2
2541 .na
2542 \fB\fBLINK\fR\fR
2543 .ad
2544 .sp .6
2545 .RS 4n
2546 The name of the VLAN link.
2547 .RE
2548 


4805 .ie t \(bu
4806 .el o
4807 \fBadv_10hdx_cap\fR
4808 .RE
4809 .sp
4810 .LP
4811 Each \fBadv_\fR property (for example, \fBadv_10fdx_cap\fR) also has a
4812 read/write counterpart \fBen_\fR property (for example, \fBen_10fdx_cap\fR)
4813 controlling parameters used at auto-negotiation. In the absence of Power
4814 Management, the \fBadv\fR* speed/duplex parameters provide the values that are
4815 both negotiated and currently effective in hardware. However, with Power
4816 Management enabled, the speed/duplex capabilities currently exposed in hardware
4817 might be a subset of the set of bits that were used in initial link parameter
4818 negotiation. Thus the MII \fBadv_\fR* parameters are marked read-only, with an
4819 additional set of \fBen_\fR* parameters for configuring speed and duplex
4820 properties at initial negotiation.
4821 .sp
4822 .LP
4823 Note that the \fBadv_autoneg_cap\fR does not have an \fBen_autoneg_cap\fR
4824 counterpart: the \fBadv_autoneg_cap\fR is a 0/1 switch that turns off/on
4825 autonegotiation itself, and therefore cannot be impacted by Power Management.
4826 .sp
4827 .LP
4828 In addition, the following Ethernet properties are reported:
4829 .sp
4830 .ne 2
4831 .na
4832 \fB\fBspeed\fR\fR
4833 .ad
4834 .sp .6
4835 .RS 4n
4836 (read-only) The operating speed of the device, in Mbps.
4837 .RE
4838 
4839 .sp
4840 .ne 2
4841 .na
4842 \fB\fBmtu\fR\fR
4843 .ad
4844 .sp .6
4845 .RS 4n


   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright 2016 Joyent, Inc.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
   6 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
   7 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
  11 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH DLADM 1M "Dec 16, 2016"
  13 .SH NAME
  14 dladm \- administer data links
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR]
  19 \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR
  20 .fi
  21 
  22 .LP
  23 .nf
  24 \fBdladm delete-phys\fR \fIphys-link\fR
  25 \fBdladm show-phys\fR [\fB-m\fR | \fB-H\fR | \fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIphys-link\fR]
  26 .fi
  27 
  28 .LP
  29 .nf
  30 \fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  31      [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...] \fIaggr-link\fR
  32 \fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]


 489 Number of input errors.
 490 .RE
 491 
 492 .sp
 493 .ne 2
 494 .na
 495 \fB\fBOPACKETS\fR\fR
 496 .ad
 497 .sp .6
 498 .RS 4n
 499 Number of packets sent on this link.
 500 .RE
 501 
 502 .sp
 503 .ne 2
 504 .na
 505 \fB\fBOBYTES\fR\fR
 506 .ad
 507 .sp .6
 508 .RS 4n
 509 Number of bytes sent on this link.
 510 .RE
 511 
 512 .sp
 513 .ne 2
 514 .na
 515 \fB\fBOERRORS\fR\fR
 516 .ad
 517 .sp .6
 518 .RS 4n
 519 Number of output errors.
 520 .RE
 521 
 522 .RE
 523 
 524 .sp
 525 .ne 2
 526 .na
 527 \fB\fB-p\fR, \fB--parsable\fR\fR
 528 .ad
 529 .sp .6


 974 \fB\fB-L\fR \fImode\fR, \fB--lacp-mode\fR=\fImode\fR\fR
 975 .ad
 976 .sp .6
 977 .RS 4n
 978 Specifies whether \fBLACP\fR should be used and, if used, the mode in which it
 979 should operate. Supported values are \fBoff\fR, \fBactive\fR or \fBpassive\fR.
 980 .RE
 981 
 982 .sp
 983 .ne 2
 984 .na
 985 \fB\fB-T\fR \fItime\fR, \fB--lacp-timer\fR=\fItime\fR\fR
 986 .ad
 987 .br
 988 .na
 989 \fB\fR
 990 .ad
 991 .sp .6
 992 .RS 4n
 993 Specifies the \fBLACP\fR timer value. The supported values are \fBshort\fR or
 994 \fBlong\fR.
 995 .RE
 996 
 997 .sp
 998 .ne 2
 999 .na
1000 \fB\fB-u\fR \fIaddress\fR, \fB--unicast\fR=\fIaddress\fR\fR
1001 .ad
1002 .sp .6
1003 .RS 4n
1004 Specifies a fixed unicast hardware address to be used for the aggregation. If
1005 this option is not specified, then an address is automatically chosen from the
1006 set of addresses of the component devices.
1007 .RE
1008 
1009 .RE
1010 
1011 .sp
1012 .ne 2
1013 .na
1014 \fB\fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR


2508 .na
2509 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
2510 .ad
2511 .sp .6
2512 .RS 4n
2513 See "Options," above.
2514 .RE
2515 
2516 .RE
2517 
2518 .sp
2519 .ne 2
2520 .na
2521 \fB\fBdladm show-vlan\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]]
2522 [\fIvlan-link\fR]\fR
2523 .ad
2524 .sp .6
2525 .RS 4n
2526 Display VLAN configuration for all VLAN links or for the specified VLAN link.
2527 .sp
2528 The \fBshow-vlan\fR subcommand accepts the following options:
2529 .sp
2530 .ne 2
2531 .na
2532 \fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR[,...]\fR
2533 .ad
2534 .sp .6
2535 .RS 4n
2536 A case-insensitive, comma-separated list of output fields to display. The field
2537 name must be one of the fields listed below, or the special value \fBall\fR, to
2538 display all fields. For each VLAN link, the following fields can be displayed:
2539 .sp
2540 .ne 2
2541 .na
2542 \fB\fBLINK\fR\fR
2543 .ad
2544 .sp .6
2545 .RS 4n
2546 The name of the VLAN link.
2547 .RE
2548 


4805 .ie t \(bu
4806 .el o
4807 \fBadv_10hdx_cap\fR
4808 .RE
4809 .sp
4810 .LP
4811 Each \fBadv_\fR property (for example, \fBadv_10fdx_cap\fR) also has a
4812 read/write counterpart \fBen_\fR property (for example, \fBen_10fdx_cap\fR)
4813 controlling parameters used at auto-negotiation. In the absence of Power
4814 Management, the \fBadv\fR* speed/duplex parameters provide the values that are
4815 both negotiated and currently effective in hardware. However, with Power
4816 Management enabled, the speed/duplex capabilities currently exposed in hardware
4817 might be a subset of the set of bits that were used in initial link parameter
4818 negotiation. Thus the MII \fBadv_\fR* parameters are marked read-only, with an
4819 additional set of \fBen_\fR* parameters for configuring speed and duplex
4820 properties at initial negotiation.
4821 .sp
4822 .LP
4823 Note that the \fBadv_autoneg_cap\fR does not have an \fBen_autoneg_cap\fR
4824 counterpart: the \fBadv_autoneg_cap\fR is a 0/1 switch that turns off/on
4825 auto-negotiation itself, and therefore cannot be impacted by Power Management.
4826 .sp
4827 .LP
4828 In addition, the following Ethernet properties are reported:
4829 .sp
4830 .ne 2
4831 .na
4832 \fB\fBspeed\fR\fR
4833 .ad
4834 .sp .6
4835 .RS 4n
4836 (read-only) The operating speed of the device, in Mbps.
4837 .RE
4838 
4839 .sp
4840 .ne 2
4841 .na
4842 \fB\fBmtu\fR\fR
4843 .ad
4844 .sp .6
4845 .RS 4n