Programmatic Interface - Security Commands

These commands allow control over Input and Output streams over Serial ports, TCP or UDP connections.



List of all commands
Programmatic Overview


Show GuiSecurity

This command returns a response that shows which levels of security are in effect for the HTTP/HTTPS system interface. This interface is used by the Browser and programmatic interfaces to obtain information from the NetRS, and to modify the control settings of the system.

There are four levels of security, each corresponding to a set of commands or actions that are covered by that security level.

The response to Show GuiSecurity lists the three access levels, and indicates which levels are restricted or unrestricted.


Parameters:

No parameters are available.


Response:
GuiSecurity system=restricted gps=restricted files=unrestricted

Set GuiSecurity

This command modifies the access permissions for the three HTTP/HTTPS security levels. See command Show GuiSecurity for the details on the access levels.

One or all of the access levels can be set to the desired states.


Parameters:

system=restricted Can be 'restricted' or 'unrestricted'.
gps=restricted Can be 'restricted' or 'unrestricted'.
files=unrestricted Can be 'restricted' or 'unrestricted'.


Response:
OK: GuiSecurity system=restricted gps=restricted files=unrestricted

Show GuiAccounts

This command lists all previously setup Gui Accounts.

Gui Accounts are set up to allow individuals to have password controlled access to the restricted features through the HTTP/HTTPS system interface. If a user attempts to access restricted information using a browser, the browser will query the user for an account name and that account's password. Those must be supplied before access will be granted.

Each account listed by Show GuiAccounts has a Name, a password, and an enable-state for each of the three access levels. Passwords are sent in encrypted form so that they can be securely transfered to another system.


Parameters:

No parameters are available.


Response:
<Show GuiAccounts>

GuiAccount name=Tom      password=SpTr7T.ggicTE 
           system=no  gps=no files=yes

GuiAccount name=Kathy    password=qC/Imqoa30YEE 
           system=no  gps=yes files=yes 

GuiAccount name=sysadmin password=KiaM2uw6aQFcA 
           system=yes gps=yes files=yes

GuiAccount name=Brian    password=98ohpTXq1/OgE 
           system=yes gps=yes files=yes

<end of Show GuiAccounts>

Show GuiAccount

This command lists the settings on a specified Gui Account. See the description in Show GuiAccounts for the details on these accounts. The format used in the single-line response to this command is identical to the individual account lines from Show GuiAccounts.


Parameters:

name=AccountName Specifies the account to display.


Response:
GuiAccount name=AccountName password=KiaM2uw6aQFcA 
           system=no gps=yes files=yes

Set GuiAccount

This command creates or modifies a Gui Account. See the description in Show GuiAccounts for the details on these accounts.

If the named account does not exist, it will be created. An error response will be generated if a new account is created without a password. On new accounts, unspecified access permissions default to "no".

On existing accounts, only the parameters explicitly given are updated. The remainder stay at their current values.

You can specify a password using an Encrypted value (as shown by Show GuiAccount) or with clear-text strings. The encrypted values are intended to allow secure transfers of control settings to a different system.


Parameters:

Name=AccountName The name of the account.
Password=KiaM2uw6aQFcA The encrypted password to use on the account.
clearPassword=My!NetRS The ClearText, unencrypted password on the account.
System=no Set 'yes' to grant the account Sysadmin Access privileges. Set 'no' to restrict this account from those controls.
Gps=yes Set 'yes' to grant the account Gpsadmin Access privileges. Set 'no' to restrict this account from those controls.
files=yes Set 'yes' to grant the account Fileaccess privileges. Set 'no' to restrict this account from those features.


Response:
OK: GuiAccount name=AccountName password=KiaM2uw6aQFcA 
           system=no gps=yes files=yes

Delete GuiAccount

This command removes the definition for a previously defined GuiAccount. See the description in Show GuiAccounts for the details on these accounts.


Parameters:

name=AccountName Specifies the account to delete.


Response:
OK: GuiAccount AccountName is deleted.