Hercules V4.00.0 - User Reference Guide

Diagram

ÊÊ¬¬¬ ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-n ¬¬¬¬§¬¬¬ name

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-s ¬¬¬¬¬¬§¬¬¬ mask

--netmask

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-m ¬
¬¬¬§¬¬¬§¬¬¬¬¬¬¬¬¬¬ mac ¬¬¬¬¬¬¬¬¬¬«

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-t ¬
¬¬¬§¬¬¬ mtu

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-i ¬¬¬¬¬§¬¬¬§¬¬¬ ibuff ¬¬¬«

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

-k ¬¬¬¬¬§¬¬¬§¬¬¬ kbuff ¬¬¬«

Ê¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬ guestip ¬¬¬ hostip ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬ÊÍ

-d ¬¬¬¬¬¬«

--debug

6.9.2.3 Parameter

devaddr

This is the device address.

CTCI

This specifies the CTCI device/protocol type.

-n name

For Linux: Specifies the name of the tunnel device to use. The default name is
“/dev/net/tun”, which is correct for version 2.4 and above of the Linux kernel.

For Windows: Identifies the host network adapter. If your network adapter does
not have a permanent (static) IP address assigned to it (e.g. you use DHCP and
have a dynamic IP assigned) then instead of specifying an IP address as the
second parameter in the device statement, you must specify the MAC address of
the adapter. In this case the second argument (hostip) must be coded as “0.0.0.0”.
This is simply a placeholder because two IP addresses are expected to satisfy the
device definition syntax.

--dev name

This is the same as “-n name”.

-s mask

This is the netmask to be configured on the link. Note: Since this is a point-to-point
link netmask is meaningless from the perspective of the actual network device.

--netmask mask

This is the same as “-s mask”.

--m mac

This is the optional hardware address of the interface in the format of either
“xx:xx:xx:xx:xx:xx” or “xx-xx-xx-xx-xx-xx”. The default is 00:00:5E:nn:nn:nn where
the “nn:nn:nn” part is constructed from the last three octets of the specified
guestip.

--macaddr mac

This is the same as “-m mac”.

-t mtu

Linux only: Specifies the maximum transmission unit size (default 1500 bytes).

--mtu mtu

This is the same as “-t mtu”.

-i ibuff

Windows only: This specifies the TunTap32 I/O buffer size in KB. nnnn hast to be
between 16 and 1024 (1 MB). The default value is 64 KB.

--ibuff ibuff

This is the same as “-i ibuff”.

-k kbuff

Windows only: This specifies the WinPcap device driver capture buffer size in KB.
nnnn hast to be between 64 and 16384 (16 MB). The default value is 1024 (1 MB).

--kbuff kbuff

This is the same as “-k kbuff”.

-d

Specifies that debugging output has to be produced on the Hercules control panel.
This should normally be left unspecified.

--debug

This is the same as “-d”.

guestip

Specifies the IP address of the guest operating system running under Hercules.

hostip

Identifies the host network adapter to use. If the host system is configured with
DHCP this should instead be the MAC address of the ethernet adapter you wish to
have Hercules use to connect to the outside world. If this parameter is specified
using the -m or --dev option, then the value here must be specified as "0.0.0.0" to
satisfy the statement syntax.

6.9.2.4 Examples

Example 1:

Define 3088 CTC adapters on device addresses 0E20 and 0E21. The device/protocol type is CTCI
(Channel-to-Channel link to Linux TCP/IP stack). The IP address of the guest operating system running
under Hercules is 192.168.1.99, the host IP address (the network adapter) to use is 192.168.1.100.