17. Command Reference Guide
17.1. Command Conventions
Most commands described in this section conform to the following conventions:
• TextInterface: Commands discussed in this section, can only be invoked via the
Text Interface. These commands cannot be invoked via the Web Browser Interface.
• SlashCharacter: Most RPC Text Interface commands begin with the Slash
Character (/).
• ApplyCommandtoAllCircuits: When an asterisk is entered as the argument of
the /ON (Switch Circuits On), /OFF (Switch Circuits Off) or /BOOT (Reboot Circuits)
commands, the command will be applied to all circuits. For example, to reboot all
allowed circuits, type /BOOT * [Enter].
• CommandQueues: If a switching or reboot command is directed to a circuit
that is already being switched or rebooted by a previous command, then the new
command will be placed into a queue until the circuit is ready to receive additional
• "Busy"Circuits: If the "Status" column in the Circuit Status Screen includes an
asterisk, this means that the circuit is currently busy, and is in the process of
completing a previously issued command. If a new command is issued to a busy
circuit, then the new command will placed into a queue to be executed later, when
the circuit is ready to receive additional commands.
• CircuitNameWildCard: It is not always necessary to enter the entire circuit
name. Circuit names can be abbreviated in command lines by entering the first
character(s) of the name followed by an asterisk (*). For example, a circuit named
"SERVER" can be specified as "S*". Note however, that this command would also
be applied to any other circuit name that begins with an "S".
• SuppressCommandConfirmationPrompt: When the /ON (Switch Circuit On),
/OFF (Switch Circuit Off), /BOOT (Reboot Circuit) or /DPL (Default All Circuits)
commands are invoked, the ",Y" option can be included to override the Command
Confirmation ("Sure?") prompt. For example, to reboot Circuit A4 without displaying
the Sure prompt, type /BOOT A4,Y [Enter].
• EnterKey: Most commands are invoked by pressing [Enter].
• ConfigurationMenus: To exit from a configuration menu, press [Esc].
Terms of Use | Privacy Policy | DMCA Policy
2006-2020 Rsmanuals.com