xref: /illumos-gate/usr/src/man/man8/ipdadm.8 (revision bbf21555)
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]
IPDADM 8 "Mar 1, 2012"
NAME
ipdadm - administer the Internet packet disturber
SYNOPSIS

ipdadm [-z zonename] subcommand [subcommand-options]
DESCRIPTION

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.

OPTIONS

The following options are supported: -z

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.

SUBCOMMANDS

The following subcommands are supported: corrupt percent

Sets the chance for packets to be corrupted to percent which must be an integer between 0 and 100. Setting percent to 0 disables packet corruption and is equivalent to calling remove corrupt. When enabled, a random byte will have a single bit flipped.

delay microseconds

Inserts microseconds of delay between both the transmit and receive of each packet. Setting microseconds to zero is equivalent to calling remove delay.

drop percent

Sets the chance for packets to be dropped to percent. percent must be an integer between 0 and 100. Setting percent to zero is equivalent to calling remove drop.

info

Prints the current values for packet corruption, packet dropping, and packet delay for the zone.

list

Prints out the zonename of each zone that has active (non-zero) packet corruption, packet delay, and packet drop.

remove corrupt,delay,drop

Disables the requested forms of packet perturbation for the zone. This is functionally equivalent to setting the value to zero. One or more of corrupt, delay, and drop can be specified as a comma separated list.

EXAMPLES

Example 1 Viewing zone information

The following command illustrates how to obtain information about a specific zone while in the global zone.

# ipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 info
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

Example 2 Removing multiple perturbations

The following command illustrates the use of the remove subcommand from inside of a zone.

# ipdadm remove corrupt,drop

Example 3 Enabling packet drops

The following command illustrates the use of the drop subcommand from the global zone.

# ipdadm -z 949860c5-52e2-4f32-965d-02e60e116b72 drop 25
EXIT STATUS

The following exit values are returned: 0

Successful completion.

1

An error occurred. 2

Invalid command line options or arguments were specified.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO

zonename (1), attributes (7), zones (7), zoneadm (8)