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