File dynagen.1 of Package dynagen
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH DYNAGEN 1 "Aug 29, 2006"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
dynagen \- command line interface to dynamips Cisco 7200 Emulator
.SH SYNOPSIS
.B dynagen
.RI [ options ]
\fIconfiguration file\fP
.br
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
.SH DESCRIPTION
\fBDynagen\fP is a text-based front end for \fIDynamips\fP, that uses the
\fIhypervisor\fP mode for communication with \fIDynamips\fP. \fBDynagen\fP
simplifies building and working with virtual networks. \fBDynagen\fP uses a
simple and easy to understand configuration file for specifying virtual router
hardware configurations. Configuration file has a simple syntax for
interconnecting routers, bridges, frame-relay and ATM switches. No need to deal
with NetIO's. \fBDynagen\fP provides a management CLI for listing devices,
starting, stopping, reloading, suspending and resuming virtual routers.
.br
\fBDynagen\fP can work in a client server mode, with \fBdynagen\fP running on
your Workstation communicating to \fIdynamips\fP servers running ona back-end
server. \fBDynagen\fP can also control multiple \fIdynamips\fP servers
simultaneously for distributing large virtual networks across several machines.
.PP
Before running \fBdynagen\fP you need to start \fIdynamips\fP:
.PP
nice dynamips \-H 7200 &
.PP
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
options starting with two dashes (`-'). A summary of options is included below.
.TP
.B \-n, \-\-nosend
Do not send any command to dynamips.
.TP
.B \-d, \-\-debug
Show debugging information.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-\-version
Show version.
.SH CONFIGURATION FILE OPTIONS
Empty lines or lines starting with a hash ('#') are ignored.
.br
Configuration file, in other documentation also called \fInetwork\fP file,
knows three sections: global section, server section which starts with [...]
and device section which start with [[...]]. Server section and device section
can have multiple occurrencies.
.br
.B Server Section:
[<ip-address|hostname>]
.br
.B Device Section:
[[7200|ROUTER|FRSW|ATMSW|ETHSW <name>]]
The 7200 section specifies defaults for all 7200 routers on this Dynamips
server. Everything in this section is optional, and defaults to whatever the default is in Dynamips
.br
.TP
.B Global Configuration variable
.B autostart <true/false> (Default: True)
.br
By default, all routers are automatically started when a lab is launched. The
autostart keyword overrides this behavior, and the lab must manually be started
(start /all).
.TP
.B Server Configuration variables
.B port <1-65535> (Default: 7200)
.br
Hypervision port to connect to.
.br
.B workingdir <path> (Default: None)
.br
Set the directory where \fIDynamips\fP will store all the device files for this
network. This is the fully qualified path relative to the system running
\fIdynamips\fP.
.br
.B console <1-65535> (Default: 2000)
.br
Base console port. New instances that do not specify a console port will
default to this + the instance number.
.br
.B udp <1-65535> (Default: 10000)
.br
Set the base UDP port for NIOs.
.br
.TP
.B Device Configuration variables
.TP
.B [[7200]]
The 7200 section specifies defaults for all 7200 routers on this Dynamips
server. Everything in this section is optional, and defaults to whatever the
default is in Dynamips.
.B image <path/file> (Default: None)
.br
Full path to 7200 IOS image file. This is the fully qualified path relative to the system running dynamips.
.br
.B ram <integer> (Default: None)
Amount of Virtual RAM to allocate to each router instance.
.br
.B rom <integer> (Default: None)
.br
Size of ROM.
.br
.B nvram <integer> (Default: None)
.br
Size of NVRAM.
.br
.B disk0 <integer> (Default: None)
.br
Set size of PCMCIA ATA disk0
.br
.B disk1 <integer> (Default: None)
.br
Set size of PCMCIA ATA disk1
.br
.B cnfg <path/file> (Default: None)
.br
Configuration file to import. This is the fully qualified path relative to the
system running dynamips.
.br
.B confreg <hex> (Default: 0x2102) 0x210X where X=0,1,2
.br
Set the configuration register
.br
.B idlepc <string> (Default: None)
.br
Set the Idle PC value.
Include a description here.
.br
.B exec_area <string> (Default: None)
.br
Set the exec area size.
.br
.B clock <integer> (Default: None)
.br
Clock divisor (should no longer been needed as of dynamips 0.2.5 RC1)
.br
.B npe <npe-100|150|175|200|225|300|400> (Default: None)
.br
NPE type.
.br
.B midplane <std|vxr> (Default: None)
.br
Midplane, either "std" or "vxr"
.br
.B mmap <binary> (Default: True)
.br
Set to false to use real memory rather than a disk file for router vitural
memory. Conserves RAM at the expense of performance.
.TP
.B [[ROUTER <name>]]
All options from the 7200 section are options here as well, including
"autostart". <name> must be unique in network file.
.br
.B model 7200 (Default: 7200)
.br
.B console <1-65535> (Default: None)
.br
Console port. Defaults to the server's base console port (specified in the server section) + instance number.
.br
.B aux <1-65535> (Default: None)
.br
Aux port.
.br
.B slotX <0-X> <PA-C7200-IO-FE|PA-FE-TX|PA-4T|PA-4E|PA-POS-OC3> (Default: None)
.br
Manual PA specification. This is optional, and if not done \fBdynagen\fP will
make sane decisions based on the interface specifications.
.RI
slot0 = PA-C7200-IO-FE # Ethernet in slot 0
slot1 = PA-FE-TX # Ethernet in slot 1
slot3 = PA-4T # PA-4T+ in slot 2
slot6 = PA-4E # PA-4E in slot 6
#slotx = PA-POS-OC3 # PA-POS-OC3 in slot x
.br
.B <local interface> = <remote interface>
.br
Interface specification. Can take the following forms:
.RI
f1/0 = R2 f1/0 # Connect to f1/0 on device R2
f2/0 = LAN 1 # Connect to bridged LAN 1
s3/0 = R2 s3/0 # Connect to s3/0 on device R2
s3/1 = F1 1 # Connect to port 1 on device "F1" (a frame relay switch)
s3/2 = F2 1
a4/0 = A1 1 # Connect to port 1 on device "A1" (an ATM switch)
f5/0 = NIO_linux_eth:eth0 # manually specify an NIO
[[ROUTER R2]]
# Interface f1/0 will automatically be created because the interface was referenced in R1's config
f2/0 = LAN 1 # Connect to bridged LAN 1
s4/0 = F1 2
s4/1 = F2 2
s4/2 = F1 3
a5/0 = A1 2
[[router R3]] # Case is not significant
# Examples of other manually specified NIOs
f1/0 = NIO_gen_eth:\\Device\\NPF_{B00A38DD-F10B-43B4-99F4-B4A078484487}
f2/0 = NIO_udp:10000:172.0.0.1:10001
f3/0 = NIO_tap:tap0
f4/0 = NIO_unix:/tmp/local:/tmp/remote
f5/0 = NIO_vde:foo:bar
.br
.TP
.B [[ETHSW <name>]]
Define an Ethernet Switch
.br
.RI
[[ETHSW S1]]
1 = access 1 # Port 1 is an access port in vlan 1
2 = access 20 # Port 2 is an access port in vlan 20
3 = dot1q 1 # Port 3 is a trunk port (dot1q encapsulation) with native vlan 1
4 = dot1q 1 NIO_gen_eth:eth0 # Port 4 is trunk port (naitive vlan 1) that
is connected to the host eth0 via the gen_eth NIO
#4 = dot1q 1 NIO_gen_eth:\\Device\\NPF_{B00A38DD-F10B-43B4-99F4-B4A078484487}
# Same as above, Windows example
.br
.TP
.B [[FRSW <name>]]
Each FRSW section defines a frame relay switch. All keywords are optional
.br
.RI
1:102 = 2:201 # Tell the FRSW to switch from port 1, DLCI 102 to port 2, DLCI 201.
1:103 = 3:301 # and from port 1, DLCI 103 to port 3, DLCI 301
[[FRSW F2]]
1:102 = 2:201
.br
.TP
.B [[ATMSW <name>]]
Define an ATM Switch
.br
.RI
1:10 = 2:20 # Port 1, vpi 10 to port 2, vpi 20
#1:10:200 = 2:20:100 # Port 1, vpi 10, vci 200 to port 2, vpi 20, vci 100
.SH EXAMPLES
.br
See /usr/share/doc/dynagen/examples directory
.SH BUGS
.br
Take a look at the Bug tracking system.
.SH REPORTING BUGS
.br
Please send bug reports to http://www.ipflow.utc.fr/bts/
.SH SEE ALSO
.br
.UR
http://www.ipflow.utc.fr/index.php/
.UE
.br
.UR
http://www.ipflow.utc.fr/blog/
.UE
.br
.UR
http://dyna-gen.sourceforge.net/
.UE
.br
.UR
http://hacki.at/7200emu/index.php
.UE
.br
.SH AUTHOR
\fBdynagen\fP was written by Greg Anuzelli (dynagen@gmail.com)
.br
This manual page was written by Erik Wenzel <erik@debian.org>
for the Debian GNU/Linux system (but may be used by others).
