APC Command Line Interface - Manuals

Page 3 - Contents

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 R...

Page 5 - Product Capabilities; Features; Scripting; ) Switched Rack PDUs; PDU features not supported by the CLI; • Event logging, event actions, and other; Integration with APC Rack KVM products

Command Line Interface (CLI) User’s Guide 1 Product Capabilities Features Scripting The Command Line Interface (CLI) for American Power Conversion (APC ® ) Switched Rack PDUs enables you to create scripts for automated operation. The existing text-based control console interface to Switched Rack PDU...

Page 6 - System Requirements; Firmware version required; Exporting an .ini File; See “uploadini” on page 31.

2 Command Line Interface (CLI) User’s Guide System Requirements Firmware version required To 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 You can use the com...

Page 7 - Using the Commands; How to Enter CLI Commands; Capitalization in commands and arguments; The Space character as command delimiter

Command Line Interface (CLI) User’s Guide 3 Using the Commands How to Enter CLI Commands Capitalization in commands and arguments Commands are valid in lowercase, uppercase, or mixed case, but arguments are case-sensitive unless specified otherwise. Editing in the CLI The B ACK S PACE key deletes th...

Page 8 - Command Error Codes; Format; OK; Codes; CLI Online Help; Command does

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

Page 9 - Logging On and Off; Logging On; User Name and Password; Responses to successful and failed log-on

Command Line Interface (CLI) User’s Guide 5 Logging On and Off Logging On User Name and Password If you are not using a KVM, configure the administrator user name and password through the Web or control console interface of the PDU. If you are using a KVM, configure the administrator user name and p...

Page 10 - Logging Off; exit; inactivity logout

6 Command Line Interface (CLI) User’s Guide Logging Off Log-off procedure To log off from the CLI, use one of the following commands: exit , logout , logoff , quit , or bye . Automatic log-off You will be logged off automatically in the following circumstances: • If the inactivity logout time of the...

Page 11 - Command Syntax; Characters and Fonts; Item

Command Line Interface (CLI) User’s Guide 7 Command Syntax Characters and Fonts Item Explanation Italic Variables, such as outlet_number , are italicized. | A vertical line between items enclosed in brackets [ ] or braces {}indicates that the items are mutually exclusive; you cannot use more than on...

Page 12 - Syntax Examples; Italic text with no brackets or braces.; never; Brackets and ellipses

8 Command Line Interface (CLI) User’s Guide Syntax Examples Italic text with no brackets or braces. adduser user_name For the adduser command, you must specify the name of the user to add (indicated in the syntax by the variable user_name . Braces and vertical line pducoldstartdelay { time |never} F...

Page 13 - Command Reference; User Management Overview; Types of users who can access the CLI; • An outlet user can control and configure only; Authentication of users; When a user attempts to log on to

Command Line Interface (CLI) User’s Guide 9 Command Reference User Management Overview Types 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) c...

Page 14 - User Management Commands; adduser

10 Command Line Interface (CLI) User’s Guide User Management Commands adduser Syntax: adduser user_name Description: Add an outlet user to the local database. Until an outlet user is explicitly assigned access to specific outlets, that user, by default, has no outlet access. Access: Administrator on...

Page 15 - assign; deluser

Command Reference: User Management Command Line Interface (CLI) User’s Guide 11 assign Syntax: assign outlet|range [, outlet | range ...] user_name Description: Grant access to specified outlets to a user configured in the local database. (Outlet permissions for RADIUS-defined users can be configure...

Page 16 - passwd; To be prompted to change your

Command Reference: User Management Commands 12 Command Line Interface (CLI) User’s Guide passwd Syntax: passwd|password [ user_name ] Description: To be prompted to change your password, omit user_name . As an administrator, specify a user name to be prompted to change that user’s password. A passwo...

Page 17 - unassign; whoami

Command Reference: User Management Command Line Interface (CLI) User’s Guide 13 unassign Syntax: 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-defined users can be ...

Page 18 - Outlet Overview; Access to outlets; Switched Rack PDU

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

Page 19 - Outlet Commands; off

Command Line Interface (CLI) User’s Guide 15 Outlet Commands off Syntax: alloff outlet | range [, outlet | range ...] Description: Turn 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 ...

Page 20 - on

Command Reference: Outlet Commands 16 Command Line Interface (CLI) User’s Guide on Syntax: allon outlet | range [, outlet | range ...] Description: Turn on one or more outlets. If you specify more than one outlet, the outlets will turn on approximately at the same time. However, for close synchroniz...

Page 21 - outletgroups

Command Reference: Outlet Commands Command Line Interface (CLI) User’s Guide 17 outletgroups Syntax: outletgroups Description: List the outlet synchronization groups defined on the Switched Rack PDU. If synchronization of outlets among PDUs is enabled, command output also includes information on tho...

Page 22 - poweroffdelay

Command Reference: Outlet Commands 18 Command Line Interface (CLI) User’s Guide poweroffdelay Syntax (to read the power-off delay): poweroffdelay [ outlet | range ][, outlet | range ...] Syntax (to set the power-off delay): poweroffdelay outlet | range [, outlet | range ...] time| never Description:...

Page 23 - powerondelay

Command Reference: Outlet Commands Command Line Interface (CLI) User’s Guide 19 powerondelay Syntax (to display the power-on delay): powerondelay [ outlet | range ][, outlet | range ...] Syntax (to set the power-on delay): powerondelay outlet | range [, outlet | range ...] time| never Description: S...

Page 24 - reboot; command to complete before providing

Command Reference: Outlet Commands 20 Command Line Interface (CLI) User’s Guide reboot Syntax: allreboot outlet | range [, outlet | range ...] Description: Remove and then restore power to one or more outlets. The CLI does not wait for the reboot command to complete before providing output and re-di...

Page 25 - rebootduration

Command Reference: Outlet Commands Command Line Interface (CLI) User’s Guide 21 rebootduration Syntax (to read the reboot duration): rebootduration [ outlet | range ][, outlet | range ...] Syntax (to set the reboot duration): rebootduration outlet | range [, outlet | range ...]: time Description: Se...

Page 26 - status

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 (*) after the status in the output ind...

Page 27 - Switched Rack PDU Commands; current

Command Line Interface (CLI) User’s Guide 23 Switched Rack PDU Commands current Syntax: current Description: Displays the total current draw in amps. Parameters: None. Access: All three account types with access to the CLI. Output format, single-phase and banked PDUs: OK current A Output format, 3-p...

Page 28 - list

Command Reference: Switched Rack PDU Commands 24 Command Line Interface (CLI) User’s Guide list Syntax: list Description: When the administrator or device manager (device-only user) uses the command: • If the current user was authenticated by RADIUS, the output lists all RADIUS-defined users, all us...

Page 29 - lowloadwarning; name; master

Command Reference: Switched Rack PDU Command Line Interface (CLI) User’s Guide 25 lowloadwarning Syntax (to read the low-load warning threshold): lowloadwarning [ phase_number ] Syntax (to set the low-load warning threshold): lowloadwarning phase_number current Description: Set or read the low-load ...

Page 30 - nearoverloadwarning; Syntax (to read the nearoverload alarm

Command Reference: Switched Rack PDU Commands 26 Command Line Interface (CLI) User’s Guide nearoverloadwarning Syntax (to read the nearoverload alarm threshold): nearoverloadwarning [ phase_number ] Syntax (to set the nearoverload warning threshold): nearoverloadwarning phase_number current Descript...

Page 31 - overloadalarm

Command Reference: Switched Rack PDU Command Line Interface (CLI) User’s Guide 27 overloadalarm Syntax (to read the overload alarm threshold): overloadalarm [ phase_number ] Syntax (to set the overload alarm threshold): overloadalarm phase_number current Description: Set or read the overload alarm t...

Page 32 - overloadrestriction; Syntax to read the overload restriction:; Output Format when reading the setting:

Command Reference: Switched Rack PDU Commands 28 Command Line Interface (CLI) User’s Guide overloadrestriction Syntax to read the overload restriction: overloadrestriction [ phase_number ] Syntax to set the overload restriction: overloadrestriction phase_number setting Description: When the overload...

Page 33 - pducoldstartdelay; power

Command Reference: Switched Rack PDU Command Line Interface (CLI) User’s Guide 29 pducoldstartdelay Syntax (to read the cold-start delay): pducoldstartdelay Syntax (to set the cold-start delay): pducoldstartdelay { time |never} Description: Set or read the PDU cold-start delay (the time that the Swi...

Page 34 - General Management Commands

30 Command Line Interface (CLI) User’s Guide General Management Commands exit Syntax: {exit|logout|logoff|quit|bye} Description: Exit from the CLI interface. Parameters: None. Output Format: OKBye. Error Message: E101 help Syntax: help|? [ command ] Description: Obtain help on CLI commands Parameter...

Page 35 - uploadini; YES; Press

Command Reference: General Management Command Line Interface (CLI) User’s Guide 31 uploadini Syntax: uploadini Description: Upload an INI file, using 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...

Page 36 - ver

Command Reference: General Management Commands 32 Command Line Interface (CLI) User’s Guide ver Syntax: ver Description: Displays information about the Switched Rack PDU and its configuration. Access: All three user types with access to the CLI. Parameters: None. Output Format: OKAPC OS AOS_firmware...

Page 37 - Index

Command Line Interface (CLI) 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 ...

Page 39 - Contact the

*990-2766* APC Worldwide Customer Support Customer support for this or any other APC product is available at no charge in any of the following ways: • Visit the APC Web site to access documents in the APC Knowledge Base and to submit customer support requests.– www.apc.com (Corporate Headquarters) C...