nslinkadmin - IP admin utility for the DeviceMaster

NAME SYNOPSIS DESCRIPTION Booting the DeviceMaster Batch Options OPTIONS ENVIRONMENT SEE ALSO BUGS FTP LOCATION

NAME

nslinkadmin − IP admin utility for the DeviceMaster

nslinkadmin is a command-line utility used to query, erase, or set the IP address information stored in non-volatile memory in a Comtrol DeviceMaster. It communicates with the DeviceMaster using raw Ethernet packets. Therefore, the DeviceMaster being administered must be on the same Ethernet segment as the host running nslinkadmin, and the Linux kernel must have support for the raw packet interface.

nslinkadmin has the ability to query the network and allow the user to choose from a list of DeviceMasters found. Alternatively, the user may specify the Ethernet address of the DeviceMaster on the command line.

The user may use the program via an interactive menu, or specify operations to be performed on the command line using the options explained below.

Booting the DeviceMaster

The DeviceMaster must have an application binary (see FILES) downloaded to it before any operations may be performed.

If the selected DeviceMaster is idle and not owned by another host, then the application binary will be automatically downloaded by nslinkadmin unless the -n option has been specified. If the DeviceMaster is automatically loaded by nslinkadmin, then it will be reset when nslinkadmin exits. If the DeviceMaster is loaded manually, either with the -l option or via a menu selection, then it will not be reset on exit.

Batch Options

Note that some options will place nslinkadmin into a non-interactive batch mode, which requires that the DeviceMaster Ethernet address be specified on the command line with the -e option.

OPTIONS

-d ether-device

Specifies the Ethernet device to be used. Defaults to the interface name that’s alphabetically "first" (ignoring lo, sitN, tunN, tapN).

-x debug-lvl

Specifies a debugging level from 0 (least verbose) to 9 (most verbose).

-e Eth-addr

Specifies the Ethernet address of the DeviceMaster to be accessed. The address should be in the form xx:xx:xx:xx:xx:xx where xx is a 2-digit hex number. This options is required if any of the batch mode options are specified. If this option is not specified, nslinkadmin will query the network and ask the user to choose from a list of DeviceMasters found.

	-r		Tell the DeviceMaster to perform a reset operation. [batch option: see note above]
	-q		Query the DeviceMaster for its current IP configuration data and write the data to stdout. [batch option: see note above]
	-E		Tell the DeviceMaster to erase its IP configuration data. If no new IP configuration data is written to the DeviceMaster, it attempts to use DHCP after it is next reset. [batch option: see note above]
	-L		List the DeviceMasters found on the network and then exit.

-a ip-addr

Configure the DeviceMaster to use ip-addr as its IP address. ip-addr must be in decimal dotted quad notation: ddd.ddd.ddd.ddd where ddd is a decimal number from 0 to 255. If -a is specified, the -m and -g options must also be specified. [batch option: see note above]

-m ip-mask

Configure the DeviceMaster to use ip-mask as its IP network mask. ip-mask must be in decimal dotted quad notation: ddd.ddd.ddd.ddd where ddd is a decimal number from 0 to 255. If -m is specified, the -a and -g options must also be specified. [batch option: see note above]

-g ip-gateway

Configure the DeviceMaster to use ip-gateway as the address of the default gateway. ip-gateway must be in decimal dotted quad notation: ddd.ddd.ddd.ddd where ddd is a decimal number from 0 to 255. If -g is specified, the -a and -m options must also be specified. [batch option: see note above]

-h -?

Print a short usage summary.