Line Editing

Commands

A Command Line Interface (CLI) is provided for administrators and is available to authorised users who make telnet or serial port connections to the device.

Line Editing

This interactive interface supports prompting, input echoing and line edit.

CLI Prompt

The CLI will prompt for each line of input with a prompt consisting of the assigned host name followed by the character '>' if the user is unprivileged, and '#' if the user has administrative permissions, and finally a single space.

Note: If no host name is entered on the DNS page, the host name will default to iocomm.

Line Edit

Character echo is provided and the backspace and delete characters can be used to delete the last character entered.

Use ^U to abandon the current input buffer.

^C can be used to force early termination of commands.

The maximum input line length is 120 characters.

Commands

The use of commands is limited by the access options set on the port from which they are to be invoked. Until a port is reset all access options are available. Access options are described in Changing Serial Line Configuration.

The following commands are provided:

admin

Enable administration permission

Syntax:	admin
Description:	Verifies the user's administration permission by asking for and verifying the unit administration password. Until this command has been run successfully no other commands requiring the administration permission can be run. Exit cancels the effect of this command.
See also:	exit
Permission:	admin

arp	Address Resolution Protocol

Syntax:	arp hostname arp -a arp -d hostname arp -s hostname ether_addr [temp] [pub]
Description:	Displays and manipulates information stored in the ARP table, to correlate hardware and IP addresses. When hostname is the only argument the command displays the current ARP entry for hostname. The host may be specified using name or number.

	-a	display all the current ARP entries
	-d	delete the entry specified by hostname
	-s	create a new entry for the network address hostname with ethernet address ether_addr
	temp	the table entry shall be permanent unless keyword temp supplied
	pub	the entry shall be 'published'. I.e. this system shall act as an ARP; server, responding to requests for hostname even though the host address does not belong to this system.

See also:	ifconfig
Permission:	admin

except

Display last exception information

Syntax:	except
Permission:	admin

exit	Leave administration mode or exit CLI

Syntax:	exit
Description:	Terminates administration permissions following a successful admin command, otherwise terminate CLI. The command shall also have the aliases of quit and logout
See also:	admin
Permission:	nas or admin

hangup

Drop serial port connection

Syntax:	hangup [port] .. [port]
Description:	Force a serial port to perform hangup actions as if a loss of carrier was detected. Calling this command with no argument causes the port running the current CLI to hangup. port is an integer port number from 1 to the number of standard ports, A (for the first advanced port) or B (for the second advanced port). Alternatively, these simple port identification can be preceded by the text 'port' (e.g. port1, portA).
Permission:	admin

help	Provide helpful information to user

Syntax:	help
Description:	Display a list of commands that are currently available to the user. This command has the alias of ?
Permission:	nas or admin

ifconfig

Configure a network interface

Syntax:

ifconfig interface address_family [address [dest_addr]] [up|down] [netmask mask] [broadcast broad_addr] [arp|-arp]

Description:

Assign an address to a network interface and/or configure network interface paramaters. The interface parameter is the network interface name (see netstat command) and does not correspond to the physical port numbering. The name used will be quicc0 for the ethernet interface, sl0-sl20 for configured SLIP connections and ppp0-ppp20 for configured PPP connections or lo0 for IPloopback. address_family is the address family, only inet (Internet address family) is supported. address is the IP address of this interface, this can be a host name or an address specified in Internet standard dot notation. dest_addr is the IP address of the entity at the other end of a point-to-point link. The following parameters can be used

	up	Mark an interface up. This may be used to enable an interface after an ifconfig down command. It happens automatically when setting the first address on an interface. If the interface was reset when previously marked down, the hardware shall be re-initialised.
	down	Mark an interface down. When an interface is marked down, the system does not attempt to transmit messages through that interface. If possible, the interface will be reset to disable reception as well. This action does not automatically disable routes using the interface.
	netmask	Specify how much of the address to reserve for subdividing networks into sub-networks. The mask includes the network part of the local address and the subnet part, which is taken from the host field of the address. The mask can be specified as a single hexadecimal number with a leading 0x or with a dot-notation Internet address. The mask contains 1's for the bit positions in the 32-bit address which are to be used for the network and subnet parts, and 0's for the host part.
	broadcast	Specify the address to use to represent broadcasts to the network. The default broadcast address is the address with a host part of all 1's.
	arp	Enable the use of the Address Resolution Protocol in mapping between network level addresses and link level addresses (default).

See also:	netstat, arp
Permission:	admin
Note:	Settings changed by this command are not saved.

 

lookmem

Display access server memory usage

Syntax:	lookmem
Description:	Display information on the operating system memory usage.
Permission:	nas or admin

lookstream

Display access server streams resource usage

Syntax:	lookstream
Description:	Displays the current streams sub-system buffer usage statistics. For each buffer the following is displayed:

	1	Buffer size
	2	Total number of pre-allocated buffers
	3	Number of free buffers
	4	Highest number of buffers ever available
	5	Total number of buffers allocated so far
	6	Buffer allocation overflows so far

	A memory usage summary is provided at the end of the list
Permission:	admin, nas

netstat

Display network statistics

Syntax:	netstat [-A ainrs] [-f address_family] [-I interface] [-p protocol] [interval]
Description:	Present network statistics

	-a	Display state of all active connections (including servers).
	-A	Show the address of any protocol control blocks associated with sockets.A memory usage Summary is provided at the end of the list.
	-i	Show the state of interfaces.
	-n	Show network addresses as numbers.
	-r	Display routing information.
	-s	Show per protocol statistics.
	-I interface	Display network information for quoted interface only (see ifconfig for a definition of interfaces).
	-f address_family	Limit statistics and control block displays to address_family. The only family supported is inet..
	-p protocol	Show statistics for that protocol (either IP, ICMP, UDP, TCP).
	interval	Interval in seconds between redisplay of statistics.

	Calling the command with no argument displays the state of all of the active network connections.
Permission:	admin, nas

ping	Send ICMP echo request

Syntax:	ping [-fnqrvR] [-c count] [-i wait] [-l preload] [-p pattern] [-s packetsize] hostname
Description:	Send an ICMP echo request message to a host on the network, display round trip times and packet loss. This command is intended for use in network testing, measurement and management. The default number of packets sent is 10.

	-R	Record the route, display route buffer on returned packets.
	-f	Flood ping the host.
	-n	Numeric output only for hosts.
	-q	Quiet output.
	-r	Bypass normal routing tables.
	-v	Verbose output.
	-c count	Send count number of packets.
	-i wait	Wait wait seconds between each packet.
	-l preload	Send preload number of packets as fast as possible before returning to normal mode of operation.
	-p pattern	Specify pad bytes to fill out packet to be sent.
	-s packetsize	Specify size of packet to be sent.
	hostname	The IP address or hostname of the host to which the packets shall be sent.

See also:	netstat, ifconfig
Permission:	admin

ppp	Configure Point to Point Protocol

Syntax:	ppp [-i] [-V] [-f rtscts|xonxoff|noflow] [-d debug_level] [-m mru] [-a acc_map] [-p pap| chap|both] [-k key] [-x noproxy|proxy] [-P] [-R remote] [-L local] [-M mask]
Description:	This command shall attach serial lines as network interfaces using the Point-to-Point Protocol.

	-i	Disable IP address negotiation (default: negotiate).
	-V	Disable Van Jacobson TCP/IP header compression (default: compress).
	-f	Set the flow control method, rtscts specifies hardware flow control (default), xonxoff specifies software flow control and noflow specifies no flow control.
	-d	Set the debug level, 0 for no debugging (default), 1 for logging PAP/CHAP, LCP and IPCP messages and 2 for logging all PPP messages.
	-m	Specifies the MRU in decimal (default 1500 bytes).
	-a	Sets the asynchronous control character map in hexadecimal format (default 0 unless software flow control enabled in which case software flow control characters are flagged out ).
	-p	Sets the authentication protocol. Possible values are PAP, CHAP or both. If both is selected CHAP will be tried first. Default: no authentication.
	-k	Specifies the authentication password key.
	-x	Specifies whether the unit shall act as an ARP proxy for the PPP link.
	-P	Uses the remote address obtained from the PPP address pool.
	-R remote	Specifies the address of the remote end of a PPP connection. Must be a valid hostname or IP address. If this is set to zero IOCOMM will accept IPCP negotiation of the address. Negotiation is not accepted for non-zero addresses.
	-L local	Specifies the address of the local (IOCOMM) end of the PPP link. local must be a valid hostname or IP address. If unspecified the local address will match that of the Ethernet interface.
	-M mask	Specifies the netmask in IP address format (default: 255.255.255.255).

Permission:

admin, framed

pppstats

Display PPP statistics

Syntax:	pppstats
Description:	Print out PPP statistics for the IOCOMM. Includes:

		The number of connection requests, those established and closed,
		The number of authentication failures,
		Number of received packets with errors,
		A breakdown of errors.

Permission:

admin

ps	Display processes

Syntax:	ps
Description:	Display the service components, their status and resource usage.
Permission:	admin, nas

pstatus

Display port status

Syntax:	pstatus [-alhqv] [<portnumber>]
Description:	Display the logical status of a serial port (default to showing status of all active ports).

	-a	Show all ports, even inactive ones.
	-l	Show reason for last disconnect.
	-h	Show hardware status.
	-q	Quiet mode, don't show auxillary information.
	-v	Verbose mode, show everything.
	port number	The serial port number, syntax of port numbers shall be as per the hangup command supporting the following; [port1] [portA] [1 2 3] [A B].

Permission:

admin, nas

rlogin

Remote login

Syntax:

rlogin [-l <username>] [-T <term>] <hostname>

Description:

Connect to a host on the network using the Rlogin protocol. Once established the connection to the remote host can be terminated from the IOCOMM end by starting an input line with the sequence ~. (tilde-dot). If it is required to send a line to the remote machine that begins with ~. then it needs to be entered as ~~. (tilde-tilde-dot). Tilde anywhere else on the line or followed by any other character has no special meaning.

	-l	Pass the username to be used for the login on the remote host.
	-T	Pass the terminal type.
	~.	Terminates session,

Permission:

admin, login, nas

route

Configure IP routing information

Syntax:	route [-n] add [-net|-host] <destination> <gateway> [-netmask <mask>] route [-n] delete [-net|-host] <destination> <gateway> [-netmask <mask>] route [-n] flush
Description:	Manage IP routing available from the IOCOMM.

	-n	Bypass attempts to print host and network names symbolically when reporting actions.
	flush	Flush the routing tables of all gateway entries.
	add	Add a new route to the routing table.
	delete	Remove a route from the routing table.
	-net	Forces the destination to be a network address.
	-host	Forces the destination to be a host address.
	-netmask	Forces the mask to applied to the route.
	destination	IP address of the destination.
	gateway	IP address of the gateway to be used when accessing the destination.

Permission:

admin

slip	Configure a Serial Line IP connection

Syntax:	slip [+c|-c] [+e|-e] [+i|-i] [+m <mtu>|-m <mtu>] [+v|-v] [+p|-p] <src_name> <dst_name>
Description:	Set up a SLIP connection.

	+c or -c	Turns the TCP/IP header compression mode on (+c) or off (default).
	+e or -e	Turns the automatic detection and the use of TCP/IP header compression on (+e) or off (default). If the flag +c is supplied then this flag has no effect. When the +e flag is supplied, the SLIP module does not send any compressed TCP/IP headers until it has received and successfully decompressed a TCP/IP packet. Note: if both ends of the connection use the +e flag and neither end uses +c, the TCP/IP header compression mode will never be turned on because neither end will take the initiative to send a compressed packet.
	+p or -p	Proxy arp flag. Default is to insert destination address into the ARP cache. The -p flag indicates that no entries shall be added and the +p flag specifies that entries shall always be added regardless of the remote network.
	+i or -i	Turns the suppression of ICMP packets on (+I) or off (default).
	+m or -m	Either of these flags set the maximum transmission unit (mtu) of the network interface to mtu (default 296 bytes). mtu is specified in decimal and the recommended mtu value for the TCP/IP packet header is 40 plus some power of 2 (e.g. 296 = 40 + 2**8).
	+v or -v	Specifies whether or not to turn on verbose mode (default off). This prints various messages about the interface when it is being brought up, if it is turned on.
	src_name	Specifies the local IP address of the link (IOCOMM).
	dst_name	Specifies the remote IP address of the link.

Permission:

admin, framed

syslog

Send or display a syslog message

Syntax:	syslog msg [-l <warning_level>] [-f <facility_id>] <text> syslog display [<lines>|cont]
Description:	Manually send or display a syslog message.

	-l	Set warning level of the message being logged. Logging levels are defined in the Event Logging (syslog) section.
	-f	Set the facility identifier of the message being logged. Facility identifiers are defined in the Event Logging (syslog) section.
	msg	Send the message text to the system log.
	display	Display the current messages in the circular syslog buffer held by the IOCOMM. The oldest message is displayed first.
	lines	The number of messages to display from the buffer, if this parameter is not specified the 10 most recent messages are displayed (oldest first).
	cont	Display messages continually.

Permission:

admin

telnet

Connect to host

Syntax:	telnet [-E] [-e <char>] [-T <term>] <hostname> [<port>]
Description:	Connect to a host on the network using the telnet protocol.

	-E	Stops any character being recognised as an escape character.
	-e char	Sets the initial telnet escape character to char (default ^]).
	-T term	Set the terminal type to that defined by term.
	hostname	Indicates the hostname, an alias or an IP address.
	port	The network port number, default 23.

Permission:

admin, login, nas

tftp	Download and upload configuration files

Syntax:	tftp put|get <host> <filename>
Description:	Transfer IOCOMM configuration information to or from a host on the network.

	put	Transfer the file from the IOCOMM to the host.
	get	Transfer the file from the host to the IOCOMM.
	host	TFTP server on the network, an IP address or a host name.
	filename	Name of file. This may or may not be the full path of the file on the server depending on whether the server is running secure TFTP and how this is implemented.

Permission:

admin

traceroute

Display the route IP packets are taking

Syntax:	traceroute [-nrv] [-w wait] [-m max_ttl] [-p port] [-q nqueries] [-t tos] [-s src_addr] [-g gateway] host [datasize]
Description:	Display the route taken by IP packets from the IOCOMM to the host.

	-n	Print the hop addresses numerically.
	-r	Bypass the normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned
	-v	Verbose output. Received ICMP packets other than TIME_EXCEEDED and PORT_UNREACHABLE shall be listed.
	-w wait	Set the time for a response to an outgoing probe packet to wait seconds (default 3).
	-m max_ttl	Set the maximum time-to-live (in hops) used in outgoing probe packets (default 30).
	-p port	Set the base UDP port number used for probe packets to port (default 33434).
	-q nqueries	Set the number of probe packets for each time-to-live setting to the value nqueries (default 3).
	-s src_addr	Use src_addr as the IP address which serves as the source address for outgoing packets. If the address is not one of the IOCOMM's addresses then an error is returned.
	-g gateway	Enable the IP LSRR (Loose Source Record Route) option in addition to the Time To Live tests. This is useful for asking how somebody else at IP address gateway can reach a particular target.
	-t tos	Set the type-of-service in probe packets to the value defined by tos, default value shall be 0.
	host	The destination name or IP address.
	datasize	The data size in bytes of the probe datagram (default 38).

Permission:

admin

000127