APC Command Line Interface manual

User ’ s Guide Command Line Interface for Switched Rack PDUs[...]

[...]

Contents Command Line Interface (CLI) User’s Gu ide i Product Capabili ties .......... ................ 1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . 1 PDU features not supported by the CLI . . . 1 Integration with APC Rack KVM products . . 1 System Requirements . [...]

ii Command Li ne Interf ace (CLI) User’s Gui de Command Reference ........................9 User Management Overview . . . . . . . . . . . . 9 Types of users who can access the CLI . . . 9 Authentication of users . . . . . . . . . . . . . . 9 User Management Commands . . . . . . . . . . 10 adduser . . . . . . . . . . . . . . . . . . . . . . . . .[...]

Command Line Interface (C LI) User’s Guide 1 Product Cap abilities Features Scripting The Command Line Interface (CLI) for American Power Conversion (A PC ® ) Switched Rack PDUs enables you to create scripts for automated operation. The existing text-based control console interface to Switched Rack PDUs is difficult to use for scripting because [...]

2 Command Line Interface (CLI) User’s Guide System Requirement s Firmware version require d T o use the Command Line Interface, your Switched Rack PDU must be running firmware version 2.7.0 for the AOS firmware module and 2.7.3 for the application firmware module. Rack PDUs required Y ou can use the command line interface only with APC Switched R[...]

Command Line Interface (C LI) User’s Guide 3 Using the Commands How to Enter CLI Commands Capit alization in commands and argument s Commands are valid in lo wercase, uppercase, or mixed case, but arguments are case-sensitive unless specified otherwise. Editing in the CLI The B ACK S PACE key deletes the most recently entered character of the cur[...]

4 Command Line Interface (CLI) User’s Guide Command Error Codes Format The CLI reports all errors in the following form at: E[0-9][0-9][0-9]: Error message The CLI reports all successful command operations with the m essage OK , followed by the output of the command. The CLI command error codes enable scripted operations to detect error co nditio[...]

Command Line Interface (C LI) User’s Guide 5 Logging On and Off Logging On User Name and Password If you are not using a KVM, configure the administrator u ser name and password through the W eb or control consol e interface of the PDU. If you are using a KVM, configure the administrator us er name and password in the KV M configuration file /etc[...]

6 Command Line Interface (CLI) User’s Guide Logging Off Log-off proce dure T o lo g of f from the CLI, use one of the fol lowing commands: exit , logout , logoff , quit , or bye . Automatic log- off Y ou will b e logged off automatically in th e following circumstances: •I f t h e inacti vity logout time o f the Switched Rack PDU (3 minutes by [...]

Command Line Interface (C LI) User’s Guide 7 Command Synt ax Characters and Font s Item Explanation Italic V ariables, such as outlet_number , are italici zed. | A vertical line betw een items encl osed in brackets [ ] or braces {}indic ates that th e items are mutually exclusive; you cannot use more than one of the items. [ ] Brackets enclos ing[...]

8 Command Line Interface (CLI) User’s Guide Synt ax Examples It alic text with no bracket s or braces. adduser user_name For the adduser command, you must specify the name of the user to add (indicated in the synt ax by the variable user_name . Braces and ve rtical line pducoldstartdelay { time |never} For the pducoldstartdelay command, you must [...]

Command Line Interface (C LI) User’s Guide 9 Command Reference User Management Overview T ype s of users who can access the CLI The CLI is accessible to three of the four user types supported by the Switched Rack PDU: • The administrator has unrestricted access. • The device manager (device-only user) can view status and configu re most setti[...]

10 Command Line Interface ( CLI) User’s Guide User Management Commands adduser Synt ax: adduser user_name Description: Add an outlet user to the local database. Until an outl et user is explicitly assigned access to specific outlets, that user , by default, has no outlet access. Access: Adm inistrator only . Parameter: Output Format: OK Password:[...]

Command Reference: User Management Command Line Interface (C LI) User’s Guide 11 assign Synt ax: assign outlet|range [, outlet | range ...] user_name Description: Grant access to specifi ed outlets to a user configured in the local dat abase. (Outlet permissions for RADIUS-d efined users can be configured only at the RADIUS server .) Access: Admi[...]

Command Reference: User Management Commands 12 Command Line Interface ( CLI) User’s Guide pa s s w d Synt ax: passwd|password [ user_na me ] Description: T o be prompted to change your password, omit u ser_name . As an ad ministrator , specify a user name to be prompted to change that user ’ s password. A password must be one to ten printable A[...]

Command Reference: User Management Command Line Interface (C LI) User’s Guide 13 unassign Synt ax: unassign outlet | range [, outlet | range ...] user_name Description: Remove access to specified outlets from a user configured in the local database. (Outlet permissions for RADIUS-def ined users can be removed only at the RADIUS server .) Access: [...]

14 Command Line Interface ( CLI) User’s Guide Outlet Overview Access to outlet s An administrator or an outlet user can use all the CLI outlet commands to manage outl ets, but an outlet user can use these commands to manage only the outlets to which he or she has been granted access. (An administrator grants access through the CLI assign command [...]

Command Line Interface (C LI) User’s Guide 15 Outlet Commands off Synt ax: all off outlet | range [, outlet | range .. .] Description: T urn off one or more outlets. If you specify more than one outlet, the outlets will turn off approximately at the same time. However , for close synchronization, outlets must be configured as part of a synchroniz[...]

Command Reference: Outlet Commands 16 Command Line Interface ( CLI) User’s Guide on Syntax: all on outlet | range [, outlet | range ...] Description: T urn on one or more outlets. If you specify more than one outlet, the outlets will turn on approximately at th e same time. However , for close synchronization, outlets must be configured as part o[...]

Command Reference: Outlet Commands Command Line Interface (C LI) User’s Guide 17 outletgroup s Synt ax: outletgroups Description: List the outlet synchroni zation groups defined on the Switched Rack PDU. If synchronization of outlets among PDUs is en abled, command output also includes information on those devices. Parameters: None. Output format[...]

Command Reference: Outlet Commands 18 Command Line Interface ( CLI) User’s Guide poweroffde lay Synt ax (to read the power-off delay): poweroffdelay [ outlet | range ][, outlet | range ...] Synt ax (to set the power-off delay): poweroffdelay outlet | range [, outlet | range ...] time| never Description: Set or read the power-of f delay (t he time[...]

Command Reference: Outlet Commands Command Line Interface (C LI) User’s Guide 19 powerondela y Synt ax (to display the power-on delay): powerondelay [ outlet | range ][, outlet | range ...] Synt ax (to set the power-on delay): powerondelay outlet | range [, outlet | range ... ] time| never Description: Set or read the power-on delay (the time in [...]

Command Reference: Outlet Commands 20 Command Line Interface ( CLI) User’s Guide reboot Synt ax: all reboot outlet | range [, outlet | range ...] Description: Remove and then restore power to one or more outlets. The CLI does not wait for the reb o ot command to comple te before pr oviding output and re-displayi ng the CLI prompt ( APC> ). If [...]

Command Reference: Outlet Commands Command Line Interface (C LI) User’s Guide 21 reboot duration Synt ax (to read the reboot duration): rebootduration [ outlet | range ][, outlet | range ...] Synt ax (to set the reboot duration): rebootduration outlet | range [, outlet | range ...]: time Description: Set or read the reboot duration (the time in s[...]

Command Reference: Outlet Commands 22 Command Line Interface ( CLI) User’s Guide status status outlet | range [, outlet | range ...] Description: Reads the status (ON or OFF) of outlets that you specify from among the outlets assigned to you. A trailing asterisk (*) aft er the status in the output indicat es that a control action is pending. Para[...]

Command Line Interface (C LI) User’s Guide 23 Switched Rack PDU Commands current Synt ax: current Description: Displays the total cur rent draw in amps. Parameters: None. Access: All three account ty pes with access to the CLI. Output format, single-phase and banked PDUs: OK curr ent A Output format, 3-phase PDUs: T OK 1: curr ent A 2: curr ent A[...]

Command Reference: Swit ched Rack PDU Commands 24 Command Line Interface ( CLI) User’s Guide list Synt ax: list Description: When the administrator or device manager (device-only user) uses the command: • If the current user was authenticated by RADIUS, the output list s all RADIUS-defined users, all users in the local database, and the outlets[...]

Command Reference: Switched Rack PDU Command Line Interface (C LI) User’s Guide 25 lowloadwarning Synt ax (to read the low -load warning thres hold): lowloadwarning [ phase_n umber ] Synt ax (to set the low-load warning threshold): lowloadwarning phase_nu mber current Description: Set or read the low-load warning threshold. Parameters: Access: Ad[...]

Command Reference: Swit ched Rack PDU Commands 26 Command Line Interface ( CLI) User’s Guide nearoverloadwa rning Syntax (to read the ne aroverload al arm threshol d): nearoverloadwarning [ phase_number ] Synt ax (to set the n earoverload warning threshold): nearoverloadwarning phase_number curr ent Description: Set or read the near-overload warn[...]

Command Reference: Switched Rack PDU Command Line Interface (C LI) User’s Guide 27 overloadalarm Syntax (to read the ov erload alar m thresh old): overloadalarm [ phase_number ] Synt ax (to set the over load alarm threshold): overloadalarm phase_numb er curr ent Description: Set or read the overload alarm threshold. Parameters: Access: Administ r[...]

Command Reference: Swit ched Rack PDU Commands 28 Command Line Interface ( CLI) User’s Guide overloadre striction Synt ax to read the o verload restriction: overloadrestriction [ phase_number ] Synt ax to set the overload restriction: overloadrestriction phase_num ber setting Description: When the overload restriction is set to on , the command p[...]

Command Reference: Switched Rack PDU Command Line Interface (C LI) User’s Guide 29 p ducoldst artdelay Synt ax (to read the cold-start delay): pducoldstartdelay Synt ax (to set the cold-start delay): pducoldstartdelay { time |never} Description: Set or read the PDU cold-start delay (the time that the Switched Rack PDU delays applying power to the[...]

30 Command Line Interface ( CLI) User’s Guide General Management Commands exit Synt ax: {exit|logout|logoff|quit|by e} Description: Exit from the CLI interface. Parameters: None. Output Format: OK Bye. Error Message: E101 help Synt ax: help|? [ command ] Description: Obtain help on CLI commands Parameter: Output format: command-specific help: OK [...]

Command Reference: General Management Command Line Interface (C LI) User’s Guide 31 uploadini Syntax: uploadini Description: Upload an INI file, usin g XMODEM, when you are accessing the CLI through a serial connection. After the upload completes: • If there are any system or network changes, the user interface of the Switched Rack PDU restarts[...]

Command Reference: Gene ral Management Commands 32 Command Line Interface ( CLI) User’s Guide ver Synt ax: ver Description: Displays informati on about the Switched Rack PDU and its configuratio n. Access: All three user types with access to the CLI. Parameters: None. Output Format: OK APC OS AOS_firmwar e_version Switched R ack PDU PDU_firmware_[...]

Command Line Interface (C LI) User’s Guide 33 A adduser , 10 assign , 11 Automatic log-off , 6 B bye , 30 C Commands adduser , 10 assign , 11 bye , 30 current , 23 deluser , 11 editing the command line , 3 exit , 30 help , 30 how to enter commands , 3 list , 24 logoff , 30 logout , 30 lowloadwarning , 25 name , 25 nearoverloadala rm , 26 off , 15[...]

Index 34 Command Line Interface ( CLI) User’s Guide on , 16 outletgroups , 17 Outlets commands , 15 overview , 14 overloadalarm , 27 overloadrestriction , 28 P passwd , 12 pducoldstart delay , 29 power , 29 poweroffdelay , 18 powerondelay , 19 Q quit , 30 Quotation marks , 3 R reboot , 20 reset_defaults_pdu , 30 Reverse slant, as es cape characte[...]

*990-2766* APC W orldwide Customer Support Customer support for this or any other APC product is available at no charge in any of the following ways: • V isit the APC W eb site to access documents in the APC Knowledge Base and to subm it customer support requests. – www .apc.com (Corporate Headquarters) Connect to loca lized APC W eb sites for [...]