usr/src/man/man1m/ipdadm.1m

   1 '\" te
   2 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IPDADM 1M "Mar 1, 2012"
   7 .SH NAME
   8 ipdadm \- administer the Internet packet disturber
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBipdadm\fR [\fB-z\fR \fIzonename\fR] \fIsubcommand\fR [\fIsubcommand-options\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The ipdadm utility is used to administer the illumos facility for simulating
  19 pathological networks by induce packet drops, delays, and corruption.
  20
  21 This functionality is only able to the global zone and zones with exclusive
  22 networking stacks. If this is enabled for the global zone, any zone with a
  23 shared networking stack will be affected.
  24
  25 .SH OPTIONS
  26 .sp
  27 .LP
  28 The following options are supported:
  29 .sp
  30 .ne 2
  31 .na
  32 \fB-z\fR
  33 .ad
  34 .sp .6
  35 .RS 4n
  36 The string of the zonename to control. If this is not specified, the current
  37 zone is used. For the list subcommand, this option is not supported.
  38 .RE
  39
  40 .SH SUBCOMMANDS
  41 .sp
  42 .LP
  43 The following subcommands are supported:
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fBcorrupt\fR \fIpercent\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 Sets the chance for packets to be corrupted to \fIpercent\fR which must be an
  53 integer between 0 and 100. Setting \fIpercent\fR to 0 disables packet corruption
  54 and is equivalent to calling \fBremove\fR \fIcorrupt\fR. When enabled, a random
  55 byte will have a single bit flipped.
  56 .sp
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fBdelay\fR \fImicroseconds\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 Inserts \fImicroseconds\fR of delay between both the transmit and receive of
  67 each packet. Setting \fImicroseconds\fR to zero is equivalent to calling
  68 \fBremove\fR \fIdelay\fR.
  69 .sp
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fBdrop\fR \fIpercent\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Sets the chance for packets to be dropped to \fIpercent\fR. \fIpercent\fR must
  80 be an integer between 0 and 100. Setting \fIpercent\fR to zero is equivalent to
  81 calling \fBremove\fR \fIdrop\fR.
  82 .sp
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fBinfo\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 Prints the current values for packet corruption, packet dropping, and packet
  93 delay for the zone.
  94 .sp
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fBlist\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 Prints out the zonename of each zone that has active (non-zero) packet
 105 corruption, packet delay, and packet drop.
 106 .sp
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fBremove\fR \fIcorrupt\fR,\fIdelay\fI,\fIdrop\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 Disables the requested forms of packet perturbation for the zone. This is
 117 functionally equivalent to setting the value to zero. One or more of
 118 \fIcorrupt\fR, \fIdelay\fR, and \fIdrop\fR can be specified as a comma separated
 119 list.
 120 .sp
 121 .RE
 122
 123 .SH EXAMPLES
 124 .LP
 125 \fBExample 1 \fRViewing zone information
 126 .sp
 127 .LP
 128 The following command illustrates how to obtain information about a specific
 129 zone while in the global zone.
 130
 131 .sp
 132 .in +2
 133 .nf
 134 # \fBipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 info\fR
 135 ipd information for zone 949860c5-52e2-4f32-965d-02e60e116b72:
 136         corrupt:        0% chance of packet corruption
 137         drop:           0% chance of packet drop
 138         delay:          0 microsecond delay per packet
 139 .fi
 140 .in -2
 141 .sp
 142
 143 .LP
 144 \fBExample 2 \fRRemoving multiple perturbations
 145 .sp
 146 .LP
 147 The following command illustrates the use of the \fBremove\fR subcommand from
 148 inside of a zone.
 149
 150 .sp
 151 .in +2
 152 .nf
 153 # \fBipdadm remove corrupt,drop\fR
 154 .fi
 155 .in -2
 156 .sp
 157
 158 .LP
 159 \fBExample 3 \fREnabling packet drops
 160 .sp
 161 .LP
 162 The following command illustrates the use of the \fBdrop\fR subcommand from the
 163 global zone.
 164
 165 .sp
 166 .in +2
 167 .nf
 168 # \fBipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 drop 25\fR
 169 .fi
 170 .in -2
 171 .sp
 172
 173
 174 .SH EXIT STATUS
 175 .sp
 176 .LP
 177 The following exit values are returned:
 178 .sp
 179 .ne 2
 180 .na
 181 \fB0\fR
 182 .ad
 183 .RS 5n
 184 Successful completion.
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fB1\fR\fR
 191 .ad
 192 .RS 5n
 193 An error occurred.
 194 .sp
 195 .sp
 196 .ne 2
 197 .na
 198 \fB\fB2\fR\fR
 199 .ad
 200 .RS 5n
 201 Invalid command line options or arguments were specified.
 202 .RE
 203
 204 .SH ATTRIBUTES
 205 .sp
 206 .LP
 207 See \fBattributes\fR(5) for descriptions of the following attributes:
 208 .sp
 209
 210 .sp
 211 .TS
 212 box;
 213 c | c
 214 l | l .
 215 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 216 _
 217 Interface Stability     Evolving
 218 .TE
 219
 220 .SH SEE ALSO
 221 .sp
 222 .LP
 223 \fBzonename\fR(1),\fBzoneadm\fR(1M), \fBattributes\fR(5), \fBzones(5)\fR