APC Command Line Interface - Manual (Page 3)

Contents
Command Line Interface (CLI) User’s Guide i
Product Capabilities..........................1
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . 1
PDU features not supported by the CLI . . . 1
Integration with APC Rack KVM products . . 1
System Requirements . . . . . . . . . . . . . . . . . . 2
Firmware version required . . . . . . . . . . . . . 2
Rack PDUs required . . . . . . . . . . . . . . . . . . 2
Exporting an .ini File . . . . . . . . . . . . . . . . . . 2
Using the Commands .......................3
How to Enter CLI Commands . . . . . . . . . . . . 3
Capitalization in commands and arguments 3
Editing in the CLI . . . . . . . . . . . . . . . . . . . . 3
The Space character as command delimiter 3
Quotation marks and the reverse slant . . . 3
Command Error Codes . . . . . . . . . . . . . . . . . 4
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
CLI Online Help . . . . . . . . . . . . . . . . . . . . . . 4
Logging On and Off .........................5
Logging On . . . . . . . . . . . . . . . . . . . . . . . . . 5
User Name and Password . . . . . . . . . . . . . 5
Log-on procedure . . . . . . . . . . . . . . . . . . . 5
Responses to successful and failed log-on . 5
Logging Off . . . . . . . . . . . . . . . . . . . . . . . . . 6
Log-off procedure . . . . . . . . . . . . . . . . . . . 6
Automatic log-off . . . . . . . . . . . . . . . . . . . . 6
Command Syntax .............................7
Characters and Fonts . . . . . . . . . . . . . . . . . . 7
Syntax Examples . . . . . . . . . . . . . . . . . . . . . 8
Italic text with no brackets or braces. . . . . . 8
Braces and vertical line . . . . . . . . . . . . . . . 8
Brackets and ellipses . . . . . . . . . . . . . . . . . 8
Large braces . . . . . . . . . . . . . . . . . . . . . . . 8