Programmatic Interface - Internet Commands

These commands allow control over Internet related functions, such as FTP, NTP, and Ethernet setup.


List of all commands
Programmatic Overview


Show Ethernet

This command returns a complete description of the current Ethernet Setup parameters. When the Ethernet port is using a Static IP setup, then the parameters shown are those that the user has configured. If the Ethernet port is using a DHCP setup, then the values returned will be the configuration values handed out by the DHCP server.

Note that the response is a single-line listing containing numerous parameters. The sample response below is broken into several lines for clarity.


Parameters:

No parameters are available.


Response:
Ethernet ipmode=static ip=192.168.142.174 netmask=255.255.255.0
         gateway=NotSet nameServers=192.168.142.7 
         dnsDomain=NotSet dnsSearch=NotSet mac=00:60:35:00:C3:1A

Set Ethernet

This command modifies the Ethernet Setup parameters. The main choice is whether to use DHCP mode or Static mode. If DHCP is specified then all other Ethernet parameters will be obtained from a DHCP server on the network. If the user specifies Static mode, then several other parameters can be specified to customize the Ethernet setup.

This command responds with a single line indicating that the setup is about to change. Five seconds later, the changes are put into effect. Since this can change the Ethernet address, Ethernet communications to the NetRS on the old address may stop working. Note that the response does NOT show the changed state of the controls.

For symmetry with the Show Ethernet command, a parameter "mac=" will be accepted but will be ignored.


Parameters:

ipmode=NewMode Either 'static' or 'dhcp' is used to select the new IP configuration mode.
If DHCP mode is selected, then the remaining parameters are not used.
ip=192.168.142.7 The new Ethernet IP address. Must be of the form xxx.xxx.xxx.xxx.
Ignored if DHCP mode is set.
netmask=255.255.255.0 The new Ethernet Netmask value. Must be of the form xxx.xxx.xxx.xxx.
Ignored if DHCP mode is set.
gateway=192.168.142.1 The new Ethernet Gateway value. Must be of the form xxx.xxx.xxx.xxx.
Ignored if DHCP mode is set.
NameServers=192.168.142.1 This is a comma separated list of IP addresses that specify one or more DNS Name Servers. Each of these must be of the form xxx.xxx.xxx.xxx.
Ignored if DHCP mode is set.
DnsDomain=eng.xyz.com This is the default DNS domain in which this NetRS belongs. The full name of the system would be the DnsDomain appended to the SystemName. Thus, If the SystemName was "Sysname" and the DnsDomain was eng.company.com, then the fully qualified name of the NetRS would be "Sysname.eng.company.com".
Ignored if DHCP mode is set.
DnsSearch=xyz.com,eng.xyz.com DnsSearch is the desired DNS search path. This is a comma-separated list of DNS domains which the NetRS will search when trying to expand a partially-qualified System name into a fully-qualified one.
If no search path is desired then 'DnsSearch=NotSet' or 'DnsSearch=' can be used.
Ignored if DHCP mode is set.
mac=00:60:35:00:C3:1A The Ethernet hardware's unique low-level address cannot be changed. This parameter is accepted in order to be symetrical with the Show Ethernet command. It will be ignored.

All numeric IP addresses are expressed as four, period-separated, decimal values, like 192.168.142.2. Each value has a range between 0 and 255.


Response:
OK: Installing new ethernet configurations.  Wait five seconds for that to take effect.

Show FTPSetup

This command returns the current settings of the FTP function. There are different FTP accounts and they each have an enable control.

The accounts netrsFTP and adminFTP both require a previously created password to have been entered on the system. These passwords are sent as part of the response to Show FtpSetup. The values are sent as encrypted strings, which cannot easily be decrypted back to their original values. The purpose of sending these encrypted values is to allow the same passwords to be re-installed at some later time, or to be transfered to another NetRS system.

Note that response to Show FtpSetup is a single line of text. The sample response sent below is divided into several lines for clarity.


Parameters:

No parameters are available.


Response:
FtpSetup anon=disabled named=disabled admin=disabled
         namedPassword=Ea1kyhBsdj9uk 
         adminPassword=LAj2CgNKpTzPw

Set FtpSetup

This command modifies the settings of the FTP function. It allows adjustment of one or more of the parameters. See the description of Show FtpSetup for details on the FTP controls.

One or more of the possible parameters must be specified. When this command is received, the current settings are preserved except for those parameters that are explicitly given. Thus, it is possible to modify only a single setting without affecting the others.

Passwords can be set using either encrypted or unencrypted parameters. Parameters 'adminClearPW' and 'namedClearPW' both accept clear-text passwords, which are encrypted and used inside the NetRS. The alternate parameters, 'namedPassword' and 'adminPassword', accept only encrypted passwords, as produced by command Show FtpSetup. These are designed to allow transfering the encrypted values between systems in a secure manner.


Parameters:

anon=enabled Used to control the anonymous FTP mode.
Set to either 'enabled' or 'disabled' or 'enabledWithDelete'.
named=enabledWithDelete Used to control named FTP account (user netrsFTP).
Set to either 'enabled' or 'disabled' or 'enabledWithDelete'.
admin=disabled Used to control the anonymous FTP mode (user adminFTP).
Set to either 'enabled' or 'disabled'.
namedPassword=EncryptedPW Sets the password for the named FTP (user netrsFTP) account to match the encrypted parameter value.
adminPassword=EncryptedPW Sets the password for the admin FTP (user adminFTP) account to match the encrypted parameter value.
namedClearPW=password Sets the password for the named FTP (user netrsFTP) account to match the unencrypted parameter value.
adminClearPW=password Sets the password for the admin FTP (user adminFTP) account to match the unencrypted parameter value.


Response:
OK: FtpSetup anon=enabled named=enabledWithDelete admin=disabled
             namedPassword=Ea1kyhBsdj9uk 
             adminPassword=LAj2CgNKpTzPw

Show NtpClient

This command returns the current control settings of the NTP (Network Time Protocol) Client function. The NTP client is used to obtain time from an external server at system startup. Note that once GPS tracking begins, precise time is always available from the satellites.

The response will indicate if the NTP Client function is enabled or disabled. If enabled, then a list of one or more NTP servers is also returned.


Parameters:

No parameters are available.


Response:
NTPclient enable=yes servers=192.168.142.1,ntp.xyz.com

Set NtpClient

Modifies the control settings for the NTP client function. The NTP client is used to obtain time from an external server at system startup. Note that once GPS tracking begins, precise time is always available from the satellites.

The parameters allow you to enable or disable this feature, and to specify up to three external time servers.


Parameters:

enable=yes Can be 'yes' or 'no'. If 'yes', then one or more servers must be specified in the other parameter. If 'no', then no servers can be specified.
servers=192.168.142.1,ntp.xyz.com A comma-separated list of NTP servers. Servers can be specified using numeric IP addresses. If a DNS server has been configured, then DNS-style names can also be used.


Response:
OK: NTPclient enable=yes servers=192.168.142.1,ntp.xyz.com