11.   Command Reference Guide

11.1.   Command Conventions

The commands described in this section conform to the following conventions:

• Slash Character:  Most APS commands begin with the Slash Character (/).



• Apply Command to All Ports:  When the asterisk character is entered as the argument of the /D command (Disconnect Port), or the /E command (Erase Buffer) the command will be applied to all ports. For example, to erase all port buffers, type /E *  [Enter].



• Port Name Wild Card:  It is not always necessary to enter the entire port name. Port names can be abbreviated in command lines by entering the first character(s) of the name followed by an asterisk (*). For example, a port named "SERVER" can be specified as "S*". Note however, that this command would also be applied to any other port name that begins with the letter "S".



• Suppress "Sure?" Prompt:  When the /D (Disconnect Port), /E (Erase Buffer), or /I (Default and Test Unit) commands are invoked, the /Y option can be included in the command line to override the "Are you Sure (y/n)?" prompt.  For example, to disconnect Port 8 without displaying the "Sure?" prompt, type /D/Y 8  [Enter].



• Enter Key:  All commands are invoked by pressing [Enter].



• Command Mode:  APS-8M Ports will only recognize commands when the Command Mode has been activated. The Command Mode can be accessed from a free Any-to-Any or Modem Mode Port. To access the Command Mode, proceed as described in Section 5.1.



• Connected Ports:  When two ports are connected, most APS-8M commands will not be recognized by either of the connected ports. The only exception is the Resident Disconnect Sequence (Default = ^X ([Ctrl] plus [X])).



• Configuration Menus: To exit from a configuration menu, you must press [Esc].

11.2.   Command Response

When commands are sent to the APS-8M, the unit can respond with either verbose (English Text) or terse messages (numeric / abbreviated). The default message type for all ports can be set to either terse or verbose using SetUp Switch Six.

After the unit is installed and configured, the port configuration command (/P) can specify an individual response format for each port. In addition to the Terse and Verbose response modes, the port configuration commands can also select the Quiet Mode. When the Quiet Mode is selected, the port will not send messages in response to commands.

The table below summarizes the various response messages for both the Terse and Verbose modes.

* These verbose Response Messages include additional information not provided by terse Response Messages.

11.3.   Command Summary

1. Supervisor Mode displays parameters for all ports; User Mode only displays parameters for ports allowed by Port Password.



2. To display Port Passwords, include the "P" Option. (Supervisor Mode Only).



3. A port with "User" command capability can only view its own parameters. A User Port cannot view parameters for other ports.



4. A User Port cannot perform a Third Party Connect.



5. Resident Disconnect:  Disconnects your resident port from another port. Note that the Resident Disconnect Sequence can be redefined via the Port Configuration Menus.



6. Third Party Disconnect:  Disconnects two or more nonresident ports. Must be issued from a third port with Supervisor command capability.

11.4.   Command Set

This Section provides more detailed information on all APS-8M commands, sorted alphabetically by name.

[Enter]      Enter Command Mode
In order to set parameters or connect ports, you must first access the command mode as described in Section 5.1. When the Command Mode is inactive (port asleep), the port will only respond when the [Enter] key is pressed without any characters preceding it. If the Supervisor Password has been defined, the unit will require a password before allowing access to Command Mode.

Availability:  Supervisor / User

Format:  [Enter] (Press [Enter] twice if other characters have already been typed).

Response:  The Port Status Screen will be displayed, followed by the "APS>" command prompt.

^X      Resident Disconnect Sequence
The Resident Disconnect Sequence is issued to disconnect your resident port from another port. For example, if you are communicating via Port 3, and Port 3 is connected to Port 4, the Resident Disconnect Sequence would be used to disconnect Port 3 from Port 4. Although the default Resident Disconnect Sequence is ^X ([Ctrl] plus [X]), the command format and Logoff Character can also be redefined via the Port Configuration Menus as described in Section 5.5.3. Note that a three character disconnect command can also be selected.

Availability:  Supervisor / User

Format:  ^X

Response:

• Verbose:  The APS will send the "Disconnected" message, followed by the Port Status Screen.
• Terse:  3

/C      Connect
Establishes a bi-directional connection between two ports. For more information and command line examples, please refer to Section 8.1. There are two different types of port connections:

• Resident Connect:  If the /C command specifies one port name or number, your resident port will be connected to the specified port.



• Third Party Connect:  If the /C command specifies two port names or numbers, the unit will connect the two ports indicated. A Third Party Connect command must be issued from a third port with "Supervisor" command capability.  "User" ports cannot initiate a Third Party Connect.

Notes:

• Ports with "User" command capability can only connect to ports that share the same Port Password.
• Ports with "Supervisor" command capability are allowed to connect to all other ports.

Availability:  Supervisor / User

Format:  /C <x> [x]  [Enter]

Where x is the number or name of the port(s) to be connected.

Response:

• Verbose:  Connected xx, when a Resident Connection is initiated, the APS will also display the currently selected Resident Disconnect Sequence for your port.
• Terse:  1

/CP      Copy RS232 Port Parameters
Allows quick set-up when all APS RS232 ports will be configured with the same or similar parameters. When the /CP command is invoked, the APS will display a menu that is used to select common port parameters, which can then be copied to all APS RS232 ports. Note that the Copy Command will not change restricted parameters at Ports 1, 2, and 8. For more information, please refer to Section 5.6.

Availability:  Supervisor Only

Format:  /CP [Enter]

Response:  Displays Copy Parameters Menu

/D      Third Party Disconnect
Invoke the /D command at your resident port to disconnect two other ports. The /D command cannot be used to disconnect your resident port. To disconnect your resident port, issue the Resident Disconnect Sequence or wait for the Timeout Period to elapse (if enabled).

Availability:  Supervisor Only

Format:  /D[/Y] <x> [x]  [Enter]

Response:

• Verbose:  "Are you Sure (y/n)?", if Y, unit will respond with "Disconnected".
• Terse:  5, if Y, unit will respond with 3.

Example:  To disconnect Port 2 from Port 3 without the "Sure?" prompt, access the Command Mode from a third port with "All" command capability and type one of the following commands:

/E      Erase Buffer
Erases data from the buffer for a specified port or several ports. Note that erased data cannot be recovered.

Availability:  Supervisor Only

Format:  /E[/Y] <x> [x] [Enter]

Response:

• Verbose:  "Are You Sure (y/n)?", if Y, the unit will respond with "OK".
• Terse:  5, if Y, the unit will respond with 0.

Example:  To clear the buffer for Port 3, access the Command Mode from a port with "All" command capability, and type /E 3  [Enter].

/F      Set System Parameters
Displays a menu which is used to define the Site ID message and Supervisor Password. When the Supervisor Password is defined, the APS-8M will display a password prompt before allowing access to command mode. For more information, refer to Section 5.4.

Note:  Make certain to record your Supervisor Password for future reference. If the Supervisor Password is lost or forgotten, you will not be able to access Supervisor Level commands.

Availability:  Supervisor Only

Format:  /F  [Enter]

Response:  Displays System Parameters Menu.

/H      Help
Displays a Help Screen, which lists all APS-8M commands along with a brief description of each command.

Availability:  Supervisor / User

Format:  /H  [Enter]

Response:  Displays Help Screen. Note that the User Level Help Screen does not include Supervisor Level Commands.

/I      Default and Test
Tests internal memory and initializes the unit with the default parameters specified by the SetUp Switches.

CAUTION:  When /I is invoked, the APS will revert to the parameters specified by the SetUp Switches. Command selected parameters will be lost.

Availability:  Supervisor Only

Format:  /I[/Y]  [Enter]

Where /Y is a command option used to suppress the
"Sure?" prompt.

Response:

• Verbose:  "Are You Sure (y/n)?", if Y, memory test and initialization begins.
• Terse:  5, if Y, memory test and initialization begins.

/J      Display Site ID
Displays the user-defined Site I.D. message.

Availability:  Supervisor / User

Format:  /J  [Enter]

Response:  Displays Site I.D. Message

/P      Set RS232 Port Parameters
Displays a menu which allows the user to select options and parameters for the selected port. Section 5.5.3 describes the procedure for defining port parameters.

Availability:  Supervisor Only

Format:  /P [x]  [Enter]

Where x is the number or name of the port to be configured. If the port number or name is not specified, the APS-8M will display the configuration menu for your resident port.

Response:  The Port Parameters Menu is displayed.

/S      Display Port Status
Displays the Port Status Screen, which lists current conditions and parameters for all ports. Normally, the Port Status Screen will not display Port Passwords; the Password column will read either "defined" or "undefined", depending upon whether or not the password for each port has been specified. When the Supervisor Mode is active, the /SP command offers the option to either display or suppress Port Passwords. In User Mode, the /S command will only display information for the ports that share the same password entered at login. For more information on the Port Status Screen, please refer to Section 7.1.

Availability:  Supervisor / User

Format:  /S[P]  [Enter]

When the "P" option is included (e.g. /SP), the Port Status Screen will lists the password for each port, if defined. (Supervisor Mode Only).

Response:  Displays Port Status Screen

/SD      Display Port Diagnostics
Provides more detailed information regarding the operational status of each port. Note that in User Mode, this screen will only display parameters for the ports that are allowed by the Port Password that was entered at log in. For More information on the Port Diagnostics Screen, please refer to Section 7.2.

Availability:  Supervisor / User

Format:  /SD  [Enter]

Response:  Displays Port Diagnostics Screen

/U      Save Parameters
Sends APS configuration parameters to an ASCII text file as described in Section 9.

Availability:  Supervisor Only

Format:  /U  [Enter]

Response:  The APS will send a series of command lines.

/UF      Upgrade Firmware
When new versions of the APS operating firmware become available, this command is used to update the existing firmware as described in Section 10. Note that this command will only function at the internal modem port (Port 8) and at Setup Ports One and Two.

Availability:  Supervisor Only

Format:  /UF  [Enter]

Response:  The APS will display a menu which offers the options to retain existing APS parameters, default parameters or abort the upgrade procedure.

/W      Display Port Parameters (Who)
Displays configuration of an individual port, but does not allow the user to change parameters. Ports with User Level command capability cannot display parameters for other ports. Normally, the Port Parameters screen will not include the Port Password. Note however, that when the Supervisor Mode is active, the /WP option can be used to display the password for the target port. For more information, please refer to Section 7.3.

Availability:  Supervisor / User

Format:  /W[P] [x]  [Enter]

Where:
	P	When the "P" option is included (e.g. /WP 5), the Port Parameters screen will list the password for the port, if defined. (Supervisor Mode Only).
	x	Port number or name. If the "x" argument is omitted, parameters for your resident port will be displayed.

Response: Displays port parameters.

Example:  To display parameters for a port named "SERVER", access the Command Mode from a port with Supervisor Level command capability, and type /W SERVER  [Enter].

/X      Exit Command Mode
Exits Command Mode. When issued at the Net Port, also ends the telnet session. Note that exiting from Command Mode will not terminate port connections.

• Any-to-Any Mode:  Exits Command Mode.
• Modem Mode:  Disconnects and resets modem, hang-up message is sent, hardware line to modem drops for 500 ms, and modem reset string is sent.

Availability:  Supervisor / User

Format:  /X  [Enter]

Response:  Disconnected