Tripp Lite PDU3VSR6L2130 Owner's Manual for SNMPWEBCARD 9332CE - Page 94

5. Command Line Interface continued 5.2 Manual Pages Each program has its own man page (short for 'manual page') built right into the software. You will not have to remember long lists of directives. The information you need is available any time by typing 'man' followed by the program name. The program synopsis in each program manual page describes the format of the directive and the valid modes and options for the program. The synopsis uses a familiar format to indicate when you should enter your own data and when you should type exactly what you see. The typical synopsis format interpretation is show in the next table. Synopsis Format word> [--word ] --word Interpretation of the Format Angle brackets mean the argument is required. Square brackets mean the argument is optional. The vertical bar is used to separate mutually exclusive choices. A list of space-separated parameters can be entered here. You must enter a value. The value is chosen by you. The 'word' loosely describes what the value is supposed to mean. You must enter a value. The value is exactly either 'a' or 'b'. The '--word' option is optional, but if used then 'value' is required. The '--word' option supports a list of parameters separated by spaces. The values are chosen by you. You do not append a '1' or 'N' onto your input. Usually the values in a list are data identifiers, but they are sometimes preceded by a '+' or '-' indicating your choice to add or remove the identifier within the directive's context. 5.3 Output Conventions Additions, updates and deletions usually result in simple output messages prefixed with either an error code or a data identifier return code followed by a colon and a short result string. The prefixes are described in the next table. Result Prefix X00: 00: YN: QQ: ..: Interpretation of the Result Prefix The 'X' indicates that program is responding with an error. If available, the error code will follow the 'X', and the result string will contain an error message. The program is indicating a success message if no 'X' is preceding the return value. If the number is non-zero, the return value is the data identifier of the last piece of data used. For example, in add mode, the return value will be the data identifier of the new data. To update this data later, provide the same identifier to the update mode. The program is requesting a Yes or No confirmation before taking action. The program is requesting additional input that is not a simple Yes or No. The program has dispatched your request and it should happen in a few moments. 5.4 Getting Started with the PowerAlert CLI Remember, most of your configuration changes will take effect immediately so you can try out your configuration before committing to it. However, the changes are not saved permanently until you 'reboot' the SNMPWEBCARD. You should reboot when your configuration is complete and prior to testing configurations that simulate a power outage. Refer to Section 2 for additional information. When you first log in to the CLI, you can type 'help' to invoke the 'help' program and see a list of all programs. Each program does only a small amount of the work, and programs can be used in succession to accomplish a task. The next paragraphs describe example goals and which programs can be used together to accomplish them. Note: Most programs are available only after the system has fully booted. 94