VIRTUTECH CONFIDENTIAL    Previous - Up - Next

service-node

Provided by

service-node

Class Hierarchy

conf-object → log-object → service-node

Interfaces Implemented

log_object, event_poster

Description

This class provides services on an Ethernet network.

Attributes

Attributes inherited from class conf-object

attributes, classname, component, iface, name, object_id, queue

Attributes inherited from class log-object

access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask

Attribute List

allow_real_dns

Optional attribute; read/write access; type: b.

If TRUE, the service node's DNS server will forward queries for unknown hosts to a real DNS server.

bootparam_udp_port

Optional attribute; read/write access; type: Integer.

The UDP port currently used for the Sun RPC Bootparam protocol replies. For checkpointing only.

default_install_server_path

Optional attribute; read/write access; type: String.

Default install server path used by the BOOTP/DHCP and BOOTPARAMS server for clients booting over a network.

default_root_server

Optional attribute; read/write access; type: [s,s].

Default root server and path used by the DHCP and BOOTPARAMS server for clients booting over a network.

dhcp_leases

Optional attribute; read/write access; type: [[ssdii]*].

The active leases used by the DHCP service. The sub-entries for each lease are ip-address, mac-address, client-id, lease-time, timestamp. The lease time is given in seconds since the lease was issued.

dhcp_max_lease_time

Optional attribute; read/write access; type: i|n.

The maximum lease time handed out by the DHCP server. If the value is Nil, or 0xffffffff, infinite leases are allowed.

host_pools

Optional attribute; read/write access; type: [[i,s,s,s[[s,s,s,s]*]]*].

The host database used by the DHCP and DNS servers.

host_root_install_server

Optional attribute; read/write access; type: [[s,s,s,s]*].

Root and install server database used by the DHCP and BOOTPARAMS server for clients booting over a network.

hosts

Optional attribute; read/write access; type: [[s|n,s,s,s]*].

The host database used by the DHCP and DNS servers.

napt_enable

Optional attribute; read/write access; type: Integer.

When set to non-zero, the service node will provide network address port translation as specified by RFC 3022. The current implementation can only handle TCP NAPT.

routing_table

Optional attribute; read/write access; type: [[ssso]*].

The routing table used by this service node. The four sub-entries for each routing table entry are network, netmask, gateway and service-node. The first three are specified as IP addresses in dot notation. The service-node is the node connected to the network where the gateway resides. For a route where the destination is reachable on the other service-node's connected network, the gateway should be set to 0.0.0.0. To create a default route, both the network and netmask should be set to 0.0.0.0.

services

Optional attribute; read/write access; type: D.

The network services provided by the service-node, as a dictionary, and their enabled/disabled status.

tcp_iss

Optional attribute; read/write access; type: Integer.

TCP initial sequence number.

tcp_pcbs

Optional attribute; read/write access; type: [[o|niiiiisioiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii[d*][d*][d*]]*].

TCP PCBs. Do not attempt to setup connections yourself using this attribute, but use functionality in each separate TCP service to do so.

tcp_pcbs_all

Pseudo attribute; read-only access; type: [[o|niiiiisioiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii[d*][d*][d*]]*].

TCP PCBs. This attribute is identical to tcp_pcbs with the exception that it can only be read and that it also includes connections that will not be checkpointed.

tcp_ticks

Optional attribute; read/write access; type: Integer.

TCP ticks.

tcp_timer

Optional attribute; read/write access; type: Integer.

TCP timer.

tcp_timer_active

Optional attribute; read/write access; type: Integer.

TCP initial sequence number.

tftp_sessions

Optional attribute; read/write access; type: [[iissssi]*].

The active sessions in the TFTP service. The sub-entries for each session are server TID, client TID, read/write, server IP address, client IP address, file name, last read block.

udp_checksumming

Optional attribute; read/write access; type: b.

When set, an UDP checksum will be calculated and placed in the checksum field of outgoing UDP packets. Default is TRUE.

udp_pcbs

Optional attribute; read/write access; type: [[o|niiiiiiiiioi]*].

UDP PCBs. Do not attempt to setup connections yourself using this attribute, but use functionality in each separate UDP service to do so.

udp_pcbs_all

Pseudo attribute; read-only access; type: [[o|niiiiiiiiioi]*].

UDP PCBs. This attribute is identical to udp_pcbs with the exception that it can only be read and that it also includes connections that will not be checkpointed.

Command List

Commands defined by interface log_object

log, log-group, log-level, log-size, log-type

Commands

add-host	add host entry
arp	inspect and manipulate ARP table
connect	connect to an ethernet link
dhcp-add-pool	add DHCP pool
dhcp-leases	show DHCP leases
disable-real-dns	disable real DNS
disable-service	disable network service
enable-ftp-alg	enable FTP ALG
enable-real-dns	enable real DNS
enable-service	enable network service
info	print information about the device
list-host-info	print host info database
route	show the routing table
route-add	add an entry to the routing table
status	print status of the device
tcpip-info	show TCP/IP info

Command Descriptions

<service-node>.add-host

Synopsis

<service-node>.add-host "ip" "name" ["domain"] ["mac"]

Description

Add a host entry to the DHCP and DNS server tables.

See Also

<service-node>.list-host-info

<service-node>.arp

Synopsis

<service-node>.arp [-d] ["delete-ip"]

Description

Prints the ARP table for the service node if called with no arguments. An ARP entry can be deleted using the -d flag and the IP address.

<service-node>.connect

Synopsis

<service-node>.connect link "ip" ["netmask"]

Description

Connect this service node to an Ethernet link object.

The ip argument gives the IP address that the service node will use on the link, and the netmask argument the netmask. Optionally, the netmask may be given in the ip argument as a /bits suffix. The netmask may also left out entirely, in which case it will default to 255.255.255.0.

<service-node>.dhcp-add-pool

Synopsis

<service-node>.dhcp-add-pool pool-size "ip" ["name"] ["domain"]

Description

Add an IP address pool to the DHCP server. The pool-size parameter defines the number of available addresses in the pool, starting with address ip. The DNS server will map the addresses to a name that is the name parameter with a number appended, in the domain domain.

<service-node>.dhcp-leases

Synopsis

<service-node>.dhcp-leases

Description

Print the list of active DHCP leases.

<service-node>.disable-real-dns

Synopsis

<service-node>.disable-real-dns

Description

Disable forwarding of DNS queries for unknown hosts to the real DNS server.

<service-node>.disable-service

Synopsis

<service-node>.disable-service ["name"] [-all]

Description

Disable a named network service in the service-node, or all of the -all flag is used.

<service-node>.enable-ftp-alg

Synopsis

<service-node>.enable-ftp-alg

Description

Enable the FTP ALG. FTP ALG processing is needed to support port forwarded FTP from the outside network to simulated machines.

<service-node>.enable-real-dns

Synopsis

<service-node>.enable-real-dns

Description

Enable forwarding of DNS queries for unknown hosts to the real DNS server.

<service-node>.enable-service

Synopsis

<service-node>.enable-service ["name"] [-all]

Description

Enable a named network service in the service-node, or all of the -all flag is used.

<service-node>.info

Synopsis

<service-node>.info

Description

Print detailed information about the configuration of the device.

<service-node>.list-host-info

Synopsis

<service-node>.list-host-info

Description

Print the host information database, used by the DHCP and DNS server.

See Also

<service-node>.add-host

<service-node>.route

Synopsis

<service-node>.route [-port]

Description

Print the routing table.

By default, the name of the link on which traffic will be send is printed in the last column, but if the -port flag is use, the port device will be printed instead.

<service-node>.route-add

Synopsis

<service-node>.route-add "net" ["netmask"] ["gateway"] link

Description

Add to the routing table.

<service-node>.status

Synopsis

<service-node>.status

Description

Print detailed information about the current status of the device.

<service-node>.tcpip-info

Synopsis

<service-node>.tcpip-info

Description

Print all TCP/IP connections.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next