1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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/.
   4 .\" 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
   5 .\" 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
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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
  10 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH DLADM 1M "Sep 23, 2009"
  12 .SH NAME
  13 dladm \- administer data links
  14 .SH SYNOPSIS
  15 .LP
  16 .nf





  17 \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]
  18 \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR
  19 .fi
  20 
  21 .LP
  22 .nf
  23 \fBdladm delete-phys\fR \fIphys-link\fR
  24 \fBdladm show-phys\fR [\fB-P\fR] [\fB-m\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-H\fR] [\fIphys-link\fR]
  25 .fi
  26 
  27 .LP
  28 .nf
  29 \fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  30      [\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
  31 \fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  32      [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fIaggr-link\fR
  33 \fBdladm delete-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIaggr-link\fR
  34 \fBdladm add-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]
  35      \fIaggr-link\fR
  36 \fBdladm remove-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]

 125 \fBdladm create-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
 126 \fBdladm delete-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
 127 \fBdladm show-etherstub\fR [\fIetherstub\fR]
 128 .fi
 129 
 130 .LP
 131 .nf
 132 \fBdladm create-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-T\fR \fItype\fR [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR]
 133      \fIiptun-link\fR
 134 \fBdladm modify-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR] \fIiptun-link\fR
 135 \fBdladm delete-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIiptun-link\fR
 136 \fBdladm show-iptun\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIiptun-link\fR]
 137 .fi
 138 
 139 .LP
 140 .nf
 141 \fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR]
 142      [\fB-e\fR \fItime\fR] [\fIlink\fR]
 143 .fi
 144 





 145 .SH DESCRIPTION
 146 .sp
 147 .LP
 148 The \fBdladm\fR command is used to administer data-links. A data-link is
 149 represented in the system as a \fBSTREAMS DLPI\fR (v2) interface which can be
 150 plumbed under protocol stacks such as \fBTCP/IP\fR. Each data-link relies on
 151 either a single network device or an aggregation of devices to send packets to
 152 or receive packets from a network.
 153 .sp
 154 .LP
 155 Each \fBdladm\fR subcommand operates on one of the following objects:
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBlink\fR\fR
 160 .ad
 161 .sp .6
 162 .RS 4n
 163 A datalink, identified by a name. In general, the name can use any alphanumeric
 164 characters (or the underscore, \fB_\fR), but must start with an alphabetic

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

4328 .ad
4329 .sp .6
4330 .RS 4n
4331 Start and stop times for data display. Time is in the format
4332 \fIMM\fR/\fIDD\fR/\fIYYYY\fR,\fIhh\fR:\fImm\fR:\fIss\fR.
4333 .RE
4334 
4335 .sp
4336 .ne 2
4337 .na
4338 \fB\fIlink\fR\fR
4339 .ad
4340 .sp .6
4341 .RS 4n
4342 If specified, display the network usage only for the named link. Otherwise,
4343 display network usage for all links.
4344 .RE
4345 
4346 .RE
4347 










4348 .SS "Parseable Output Format"
4349 .sp
4350 .LP
4351 Many \fBdladm\fR subcommands have an option that displays output in a
4352 machine-parseable format. The output format is one or more lines of colon
4353 (\fB:\fR) delimited fields. The fields displayed are specific to the subcommand
4354 used and are listed under the entry for the \fB-o\fR option for a given
4355 subcommand. Output includes only those fields requested by means of the
4356 \fB-o\fR option, in the order requested.
4357 .sp
4358 .LP
4359 When you request multiple fields, any literal colon characters are escaped by a
4360 backslash (\fB\e\fR) before being output. Similarly, literal backslash
4361 characters will also be escaped (\fB\e\e\fR). This escape format is parseable
4362 by using shell \fBread\fR(1) functions with the environment variable
4363 \fBIFS=:\fR (see \fBEXAMPLES\fR, below). Note that escaping is not done when
4364 you request only a single field.
4365 .SS "General Link Properties"
4366 .sp
4367 .LP

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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/.
   4 .\" 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
   5 .\" 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
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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
  10 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH DLADM 1M "Feb 10, 2014"
  12 .SH NAME
  13 dladm \- administer data links
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 \fBdladm\fR
  18 .fi
  19 
  20 .LP
  21 .nf
  22 \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]
  23 \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR
  24 .fi
  25 
  26 .LP
  27 .nf
  28 \fBdladm delete-phys\fR \fIphys-link\fR
  29 \fBdladm show-phys\fR [\fB-P\fR] [\fB-m\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-H\fR] [\fIphys-link\fR]
  30 .fi
  31 
  32 .LP
  33 .nf
  34 \fBdladm create-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  35      [\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
  36 \fBdladm modify-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-P\fR \fIpolicy\fR] [\fB-L\fR \fImode\fR]
  37      [\fB-T\fR \fItime\fR] [\fB-u\fR \fIaddress\fR] \fIaggr-link\fR
  38 \fBdladm delete-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIaggr-link\fR
  39 \fBdladm add-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]
  40      \fIaggr-link\fR
  41 \fBdladm remove-aggr\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIether-link1\fR [\fB-l\fR \fIether-link2\fR...]

 130 \fBdladm create-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
 131 \fBdladm delete-etherstub\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIetherstub\fR
 132 \fBdladm show-etherstub\fR [\fIetherstub\fR]
 133 .fi
 134 
 135 .LP
 136 .nf
 137 \fBdladm create-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-T\fR \fItype\fR [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR]
 138      \fIiptun-link\fR
 139 \fBdladm modify-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-s\fR \fItsrc\fR] [\fB-d\fR \fItdst\fR] \fIiptun-link\fR
 140 \fBdladm delete-iptun\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIiptun-link\fR
 141 \fBdladm show-iptun\fR [\fB-P\fR] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIiptun-link\fR]
 142 .fi
 143 
 144 .LP
 145 .nf
 146 \fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR]
 147      [\fB-e\fR \fItime\fR] [\fIlink\fR]
 148 .fi
 149 
 150 .LP
 151 .nf
 152 \fBdladm help\fR [\fIsubcommand\fR]
 153 .fi
 154 
 155 .SH DESCRIPTION
 156 .sp
 157 .LP
 158 The \fBdladm\fR command is used to administer data-links. A data-link is
 159 represented in the system as a \fBSTREAMS DLPI\fR (v2) interface which can be
 160 plumbed under protocol stacks such as \fBTCP/IP\fR. Each data-link relies on
 161 either a single network device or an aggregation of devices to send packets to
 162 or receive packets from a network.
 163 .sp
 164 .LP
 165 Each \fBdladm\fR subcommand operates on one of the following objects:
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fBlink\fR\fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 A datalink, identified by a name. In general, the name can use any alphanumeric
 174 characters (or the underscore, \fB_\fR), but must start with an alphabetic

 500 Number of input errors.
 501 .RE
 502 
 503 .sp
 504 .ne 2
 505 .na
 506 \fB\fBOPACKETS\fR\fR
 507 .ad
 508 .sp .6
 509 .RS 4n
 510 Number of packets sent on this link.
 511 .RE
 512 
 513 .sp
 514 .ne 2
 515 .na
 516 \fB\fBOBYTES\fR\fR
 517 .ad
 518 .sp .6
 519 .RS 4n
 520 Number of bytes sent on this link.
 521 .RE
 522 
 523 .sp
 524 .ne 2
 525 .na
 526 \fB\fBOERRORS\fR\fR
 527 .ad
 528 .sp .6
 529 .RS 4n
 530 Number of output errors.
 531 .RE
 532 
 533 .RE
 534 
 535 .sp
 536 .ne 2
 537 .na
 538 \fB\fB-p\fR, \fB--parseable\fR\fR
 539 .ad
 540 .sp .6

4338 .ad
4339 .sp .6
4340 .RS 4n
4341 Start and stop times for data display. Time is in the format
4342 \fIMM\fR/\fIDD\fR/\fIYYYY\fR,\fIhh\fR:\fImm\fR:\fIss\fR.
4343 .RE
4344 
4345 .sp
4346 .ne 2
4347 .na
4348 \fB\fIlink\fR\fR
4349 .ad
4350 .sp .6
4351 .RS 4n
4352 If specified, display the network usage only for the named link. Otherwise,
4353 display network usage for all links.
4354 .RE
4355 
4356 .RE
4357 
4358 .sp
4359 .ne 2
4360 .na
4361 \fB\fBdladm help\fR [\fIsubcommand\fR]\fR
4362 .ad
4363 .sp .6
4364 .RS 4n
4365 Displays all subcommands or help on a single subcommand.
4366 .RE
4367 
4368 .SS "Parseable Output Format"
4369 .sp
4370 .LP
4371 Many \fBdladm\fR subcommands have an option that displays output in a
4372 machine-parseable format. The output format is one or more lines of colon
4373 (\fB:\fR) delimited fields. The fields displayed are specific to the subcommand
4374 used and are listed under the entry for the \fB-o\fR option for a given
4375 subcommand. Output includes only those fields requested by means of the
4376 \fB-o\fR option, in the order requested.
4377 .sp
4378 .LP
4379 When you request multiple fields, any literal colon characters are escaped by a
4380 backslash (\fB\e\fR) before being output. Similarly, literal backslash
4381 characters will also be escaped (\fB\e\e\fR). This escape format is parseable
4382 by using shell \fBread\fR(1) functions with the environment variable
4383 \fBIFS=:\fR (see \fBEXAMPLES\fR, below). Note that escaping is not done when
4384 you request only a single field.
4385 .SS "General Link Properties"
4386 .sp
4387 .LP