/[dynamips]/upstream/dynamips-0.2.5/hypervisor_mode.7
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Annotation of /upstream/dynamips-0.2.5/hypervisor_mode.7

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (hide annotations)
Sat Oct 6 16:01:44 2007 UTC (12 years, 2 months ago) by dpavlin
File size: 13327 byte(s)
import 0.2.5 from upstream

1 dpavlin 1 .TH HYPERVISOR_MODE 7 "Sep 10, 2006"
2     .SH NAME
3     hypervisor mode \- allows you to run simultaneously
4     many virtual router instances, and to simulate ATM, Ethernet
5     or Frame-Relay networks.
6     .SH SYNOPSIS
7     .B dynamips -H
8     \fItcp_port\fP
9    
10     .SH DESCRIPTION
11     You can connect directly to the TCP control port with telnet, or use
12     dynagen/dynagui that will pass commands transparently. The second method
13     is highly recommended.
14     .br
15     The command syntax is simple: <module> <function> [arguments...]
16     For example: "c7200 start R1" starts virtual instance named "R1".
17     .br
18     .TP
19     .B The modules that are currently defined are given below:
20     .br
21     .RS
22     .B hypervisor
23     General hypervisor management
24     .TP
25     .B vm
26     General virtual machine (VM) management
27     .TP
28     .B c7200
29     Virtual instances of Cisco 7200
30     .TP
31     .B c3600
32     Virtual instances of Cisco 3600
33     .TP
34     .B nio
35     Network Input/Output (NIO) descriptors
36     .TP
37     .B nio_bridge
38     NIO bridges (shared media)
39     .TP
40     .B atmsw
41     ATM switches
42     .TP
43     .B frsw
44     Frame-Relay switches
45     .TP
46     .B ethsw
47     Ethernet switches
48     .RE
49     .TP
50     .B Hypervisor management module
51     .RS
52     .TP
53     .B hypervisor module_list
54     Display the module list.
55     .TP
56     .B hypervisor cmd_list <module>
57     Display commands recognized by the specified module.
58     .TP
59     .B hypervisor close
60     Close the current session.
61     .TP
62     .BI hypervisor stop
63     Destroy all objects and stop hypervisor.
64     .TP
65     .B hypervisor reset
66     Destroy all objects (used to get an empty configuration)
67     .TP
68     .B hypervisor working_dir <directory>
69     Set the directory to use to store files.
70     .TP
71     .B hypervisor save_config <filename>
72     Save the configuration of all objects into the specified file.
73     .RE
74     .TP
75     .B Virtual Machine module ("vm")
76     .RS
77     .TP
78     .B vm list
79     List all VM instances (c7200, c3600).
80     .TP
81     .B vm set_debug_level <instance_name> <level>
82     Set the debug level (which is a number) for a VM. By default, no specific debug
83     is enabled (level = 0).
84     .TP
85     .B vm set_ios <instance_name> <ios_file>
86     Set the IOS image file to use. There is no default.
87     .TP
88     .B vm set_config <instance_name> <config_reg>
89     Set the config register value.
90     .TP
91     .B vm set_ram <instance_name> <ram_size>
92     Set the RAM size, specified in Mbytes.
93     .TP
94     .B vm set_nvram <instance_name> <nvram_size>
95     Set the NVRAM size, specified in Kbytes.
96     .TP
97     .B vm set_ram_mmap <instance_name> <0|1>
98     Enable/Disable use of a mapped file to simulate router memory. By default, a
99     mapped file is used. This is a bit slower, but requires less memory.
100     .TP
101     .B vm suspend <instance_name>
102     Suspend execution of the instance.
103     .TP
104     .B vm resume <instance_name>
105     Resume execution of the instance.
106     .TP
107     .B vm set_clock_divisor <instance_name> <clock_div>
108     Set the clock divisor value. The higher is the value, the faster is the clock
109     in the virtual machine. The default is 4, but it is often required to adjust
110     it.
111     .TP
112     .B vm set_idle_pc <instance_name> <pc_value>
113     Set the idle Pointer Counter (PC). You must determine it through the method
114     explained in the main README file.
115     .TP
116     .B vm set_exec_area <instance_name> <area_size>
117     Set the exec area size. The exec area is a pool of host memory used to store
118     pages translated by the JIT (they contain the native code corresponding to MIPS
119     code pages).
120     .TP
121     .B vm set_disk0 <instance_name> <value>
122     Set size of PCMCIA ATA disk0.
123     .TP
124     .B vm set_disk1 <instance_name> <value>
125     Set size of PCMCIA ATA disk1.
126     .TP
127     .B vm set_conf_reg <instance_name> <value>
128     Set the config register value. The default is 0x2102.
129     .TP
130     .B vm set_con_tcp_port <instance_name> <tcp_port>
131     Set the TCP port to use for console. By default, no TCP port is chosen, meaning
132     that you cannot get access to the console.
133     .TP
134     .B vm set_aux_tcp_port <instance_name> <tcp_port>
135     Set the TCP port to use for AUX port. By default, no TCP port is chosen,
136     meaning that you cannot get access to the AUX port.
137     .TP
138     .B vm cpu_info <instance_name> <cpu_id>
139     Show info about the CPU identified by "cpu_id". The boot CPU (which is
140     typically the only CPU) has ID 0.
141     .RE
142     .TP
143     .B Virtual Cisco 7200 instances module ("c7200")
144     .RS
145     .TP
146     .B c7200 list
147     List all existing Cisco 7200 instances.
148     .TP
149     .B c7200 create <instance_name> <instance_id>
150     Create a new router instance. The ID must be unique and is used to name files
151     on disk.
152     .TP
153     .B c7200 delete <instance_name>
154     Delete the specified instance.
155     .TP
156     .B c7200 start <instance_name>
157     Start the instance. At least the IOS image must be set.
158     .TP
159     .B c7200 stop <instance_name>
160     Stop the instance. The settings are kept.
161     .TP
162     .B c7200 set_npe <instance_name> <npe_name>
163     Set the NPE model. For example: npe-100, npe-400, ... The default is
164     "npe-200".
165     .TP
166     .B c7200 set_midplane <instance_name> <midplane_name>
167     Set the midplane model, it can be either "std" or "vxr". The default is "vxr".
168     .TP
169     .B c7200 set_mac_addr <instance_name> <mac_addr>
170     Set the base MAC address of the router. By default, the address is
171     automatically generated with this pattern : ca<instance_id>.<process_pid>.0000
172     (Cisco format).
173     .TP
174     .B c7200 add_pa_binding <instance_name> <slot> <pa_type>
175     Add a Port Adapter binding for the specified slot. For example: "c7200
176     add_pa_binding R1 1 PA-A1" adds a PA-A1 card into slot 1.
177     .TP
178     .B c7200 remove_pa_binding <instance_name> <slot>
179     Remove a Port Adapter binding (if it exists) for the specified slot.
180     .TP
181     .B c7200 pa_bindings <instance_name>
182     Display all PA bindings for the router instance.
183     .TP
184     .B c7200 add_nio_binding <instance_name> <slot> <port> <nio_name>
185     Add a NIO binding for the interface designated by "slot/port". For example:
186     "c7200 add_nio_binding R1 1 0 nio1" (with PA-A1 bound to slot 1) binds the NIO
187     called "nio1" to the interface ATM1/0.
188     .TP
189     .B c7200 remove_nio_binding <instance_name> <slot> <port>
190     Removes the NIO binding for the interface designated by "slot/port".
191     .TP
192     .B c7200 pa_nio_bindings <instance_name> <slot>
193     Display NIO bindings for all ports of the specified slot.
194     .TP
195     .B c7200 pa_enable_nio <instance_name> <slot> <port>
196     Enable NIO for the interface "slot/port" (used when NIO has to be changed while
197     the virtual router is online).
198     .TP
199     .B c7200 pa_disable_nio <instance_name> <slot> <port>
200     Disable NIO for the interface "slot/port" (used when NIO has to be changed
201     while the virtual router is online).
202     .TP
203     .B c7200 pa_init_online <instance_name> <slot>
204     Initialize a Port Adapter while the router is online (this triggers an OIR
205     event).
206     .TP
207     .B c7200 pa_stop_online <instance_name> <slot>
208     Stop a Port Adapter while the router is online (this triggers an OIR event).
209     .TP
210     .B c7200 show_hardware <instance_name>
211     Display virtual hardware info about the instance.
212     .RE
213     .TP
214     .B Virtual Cisco 3600 instances module ("c3600")
215     .RS
216     .TP
217     .B c3600 list
218     List all existing Cisco 3600 instances.
219     .TP
220     .B c3600 create <instance_name> <instance_id>
221     Create a new router instance. The ID must be unique and is used to name files
222     on disk.
223     .TP
224     .B c3600 delete <instance_name>
225     Delete the specified instance.
226     .TP
227     .B c3600 start <instance_name>
228     Start the instance. At least the IOS image must be set.
229     .TP
230     .B c3600 stop <instance_name>
231     Stop the instance. The settings are kept.
232     .TP
233     .B c3600 set_chassis <instance_name> <chassis_name>
234     Set the chassis model. Possible values: 3620, 3640, 3660. The default is
235     "3640".
236     .TP
237     .B c3600 set_mac_addr <instance_name> <mac_addr>
238     Set the base MAC address of the router. By default, the address is
239     automatically generated with this pattern : cc<instance_id>.<process_pid>.0000
240     (Cisco format).
241     .TP
242     .B c3600 add_nm_binding <instance_name> <slot> <pa_type>
243     Add a Network Module binding for the specified slot. For example: "c3600
244     add_nm_binding R1 1 NM-1FE-TX" adds a NM-1FE-TX card into slot 1.
245     .TP
246     .B c3600 remove_pa_binding <instance_name> <slot>
247     Remove a Network Module binding (if it exists) for the specified slot.
248     .TP
249     .B c3600 nm_bindings <instance_name>
250     Display all NM bindings for the router instance.
251     .TP
252     .B c3600 add_nio_binding <instance_name> <slot> <port> <nio_name>
253     Add a NIO binding for the interface designated by "slot/port". For example:
254     "c3600 add_nio_binding R1 1 0 nio1" (with NM-1FE-TX bound to slot 1) binds the
255     NIO called "nio1" to the interface FastEthernet1/0.
256     .TP
257     .B c3600 remove_nio_binding <instance_name> <slot> <port>
258     Removes the NIO binding for the interface designated by "slot/port".
259     .TP
260     .B c3600 nm_nio_bindings <instance_name> <slot>
261     Display NIO bindings for all ports of the specified slot.
262     .TP
263     .B c3600 nm_enable_nio <instance_name> <slot> <port>
264     Enable NIO for the interface "slot/port" (used when NIO has to be changed while
265     the virtual router is online).
266     .TP
267     .B c3600 nm_disable_nio <instance_name> <slot> <port>
268     Disable NIO for the interface "slot/port" (used when NIO has to be changed
269     while the virtual router is online).
270     .TP
271     .B c3600 show_hardware <instance_name>
272     Display virtual hardware info about the instance.
273     .RE
274     .TP
275     .B Network Input/Output (NIO) module ("nio")
276     .RS
277     .TP
278     .B nio list
279     List all exiting NIOs.
280     .TP
281     .B nio create_udp <nio_name> <local_port> <remote_host> <remote_port>
282     Create an UDP NIO with the specified parameters.
283     .TP
284     .B nio create_unix <nio_name> <local_file> <remote_file>
285     Create an UNIX NIO with the specified parameters.
286     .TP
287     .B nio create_vde <nio_name> <control_file> <local_file>
288     Create a VDE NIO with the specified parameters. VDE stands for "Virtual
289     Distributed Ethernet" and is compatible with UML (User-Mode-Linux) switch.
290     .TP
291     .B nio create_tap <nio_name> <tap_device>
292     Create a TAP NIO. TAP devices are supported only on Linux and FreeBSD and
293     require root access.
294     .TP
295     .B nio create_gen_eth <nio_name> <eth_device>
296     Create a generic ethernet NIO, using PCAP (0.9.4 and greater). It requires root
297     access.
298     .TP
299     .B nio create_linux_eth <nio_name> <eth_device>
300     Create a Linux ethernet NIO. It requires root access and is supported only on
301     Linux platforms.
302     .TP
303     .B nio delete <nio_name>
304     Delete the specified NIO. The NIO can be deleted only when it is not anymore in
305     use by another object.
306     .TP
307     .B nio set_debug <nio_name> <debug>
308     Enable/Disable debugging for the specified NIO. When debugging is enabled,
309     received and emitted packets are displayed at screen. It is mainly used to
310     debug interface drivers.
311     .RE
312     .TP
313     .B NIO bridge mdoule ("nio_bridge")
314     .RS
315     .TP
316     .B nio_bridge list
317     List all NIO bridges.
318     .TP
319     .B nio_bridge create <bridge_name>
320     Create a NIO bridge. A NIO bridge acts as a shared media (a kind of hub).
321     .TP
322     .B nio_bridge delete <bridge_name>
323     Delete a NIO bridge.
324     .TP
325     .B nio_bridge add_nio <bridge_name> <nio_name>
326     Add a NIO as new port in a NIO bridge. The NIO must be created through the
327     "nio" module.
328     .TP
329     .B nio_bridge remove_nio <bridge_name> <nio_name>
330     Remove the specified NIO as member of the NIO bridge.
331     .RE
332     .TP
333     .B Virtual Ethernet switch ("ethsw")
334     .RS
335     .TP
336     .B ethsw list
337     List all Ethernet switches.
338     .TP
339     .B ethsw create <switch_name>
340     Create a new Ethernet switch.
341     .TP
342     .B ethsw delete <switch_name>
343     Delete the specified Ethernet switch.
344     .TP
345     .B ethsw add_nio <switch_name> <nio_name>
346     Add a NIO as new port in an Ethernet switch. The NIO must be created through
347     the "nio" module.
348     .TP
349     .B ethsw remove_nio <switch_name> <nio_name>
350     Remove the specified NIO as member of the Ethernet switch.
351     .TP
352     .B ethsw set_access_port <switch_name> <nio_name> <vlan_id>
353     Set the specified port as an ACCESS port in VLAN <vlan_id>.
354     .TP
355     .B ethsw set_dot1q_port <switch_name> <nio_name> <native_vlan>
356     Set the specified port as a 802.1Q trunk port, with native VLAN <native_vlan>.
357     .TP
358     .B ethsw clear_mac_addr_table <switch_name>
359     Clear the MAC address table.
360     .TP
361     .B ethsw show_mac_addr_table <switch_name>
362     Show the MAC address table (output format: Ethernet address, VLAN, NIO)
363     .RE
364     .TP
365     .B Virtual ATM switch ("atmsw")
366     .RS
367     .TP
368     .B atmsw list
369     List all ATM switches.
370     .TP
371     .B atmsw create <switch_name>
372     Create a new ATM switch.
373     .TP
374     .B atmsw delete <switch_name>
375     Delete the specified ATM switch.
376     .TP
377     .B atmsw create_vpc <switch_name> <input_nio> <input_vpi> <output_nio> <output_vpi>
378     Create a new Virtual Path connection (unidirectional).
379     .TP
380     .B atmsw delete_vpc <switch_name> <input_nio> <input_vpi> <output_nio> <output_vpi>
381     Delete a Virtual Path connection (unidirectional).
382     .TP
383     .B atmsw create_vcc <switch_name> <input_nio> <input_vpi> <input_vci> <output_nio> <output_vpi> <output_vci>
384     Create a new Virtual Channel connection (unidirectional).
385     .TP
386     .B atmsw delete_vcc <switch_name> <input_nio> <input_vpi> <input_vci> <output_nio> <output_vpi> <output_vci>
387     Delete a Virtual Channel connection (unidirectional).
388     .RE
389     .TP
390     .B Virtual Frame-Relay switch ("frsw")
391     .RS
392     .TP
393     .B frsw list
394     List all Frame-Relay switches.
395     .TP
396     .B frsw create <switch_name>
397     Create a new Frame-Relay switch.
398     .TP
399     .B frsw delete <switch_name>
400     Delete the specified Frame-Relay switch.
401     frsw create_vc <switch_name> <input_nio> <input_dlci> <output_nio> <output_dlci>
402     Create a new Virtual Circuit connection (unidirectional).
403     .TP
404     .B frsw delete_vc <switch_name> <input_nio> <input_dlci> <output_nio> <output_dlci>
405     Delete a Virtual Circuit connection (unidirectional).
406     .RE
407     .SH REPORTING BUGS
408     .br
409     Please send bug reports to http://www.ipflow.utc.fr/bts/
410     .SH SEE ALSO
411     .br
412     \fBdynamips\fP(1), \fBnvram_export\fP(1), \fBdynagen\fP(1), \fBdynagui\fP(1)
413     .br
414     .UR
415     http://www.ipflow.utc.fr/index.php/
416     .UE
417     .br
418     .UR
419     http://www.ipflow.utc.fr/blog/
420     .UE
421     .br
422     .UR
423     http://hacki.at/7200emu/index.php
424     .UE
425     .SH AUTHOR
426     \fBdynamips\fP was written by Fabien Devaux, Christophe Fillot (cf@utc.fr)
427     and MtvE. This manual page was written by Erik Wenzel <erik@debian.org>
428     for the Debian GNU/Linux system (but may be used by others).
429    

  ViewVC Help
Powered by ViewVC 1.1.26