Summary of the content on the page No. 1
User’s Guide
Command Line Interface
for Switched Rack PDUs
Summary of the content on the page No. 2
Summary of the content on the page No. 3
Contents 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
Summary of the content on the page No. 4
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 . . . . . . . . . . . . . . . . . . . . . . . . . 10 assign . . . . . . . . . . . . . . . . . . . . . . . . . . 11 deluser . . . . . . . . . . . . . . . . . . . . . . . . . . 11 passwd . . . . . . . . . . . . . . . . . . . . . . . . . 12 unassi
Summary of the content on the page No. 5
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 PDUs is difficult to use for scripting because it is menu-driven. APC will support both interfaces. The CLI is not supported by APC Metered Rack PDUs PDU features not supported by the CLI The Web, control console, and SNMP interfaces for S
Summary of the content on the page No. 6
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 command line interface only with APC Switched Rack PDUs. Exporting an .ini File You can configure all parameters of a Switched Rack PDU (including those for which there are not specific CLI commands) by using the CLI to transfer an .ini fil
Summary of the content on the page No. 7
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 BACK SPACE key deletes the most recently entered character of the current command string. No other editing function is available during command entry. The CLI does not retain a command history. You cannot retrieve previously entered commands. The Space character as
Summary of the content on the page No. 8
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 scripted operations to detect error conditions reliably without having to match error message text. Codes Code Message Text Notes E100 Command does not exist. E101 Invalid command The arguments supplied arguments. are too few, too many,
Summary of the content on the page No. 9
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 password in the KVM configuration file /etc/pm.APCPDU. The default for both is apc. The pm.APCPDU file is saved to non-volatile memory when you save your configuration. The -c option is then appended to the configured password automatica
Summary of the content on the page No. 10
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 Switched Rack PDU (3 minutes by default, or a configured time of 1 to 10 minutes) expires without keyboard input or input through the mouse within the CLI interface. Movement of the mouse pointer or clicking the mouse without actual input
Summary of the content on the page No. 11
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 one of the items. [ ] Brackets enclosing an item or series of items indicates that the item or series is optional. Any item not enclosed in brackets or braces is required. {} Braces enclosing two or more items, separated by the vertical lin
Summary of the content on the page No. 12
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} For the pducoldstartdelay command, you must enter either a time in seconds (time) that the PDU waits to apply power to its outlets or enter never to specify that the outlets will never turn on automatically when power is applied to the PDU. B
Summary of the content on the page No. 13
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) can view status and configure most settings, including all settings of all outlets. • An outlet user can control and configure only those outlets assigned to that user The read-only user has no access to the CLI. Authentication of users Di
Summary of the content on the page No. 14
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 only. Parameter: user_name One to ten printable ASCII characters. Output Format: OK Password: password Re-enter password: password User name and password set for user user_name. Error Messages: E101, E102, E104 10 Command Line Interface
Summary of the content on the page No. 15
Command Reference: User Management 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 configured only at the RADIUS server.) Access: Administrator only Parameters: outlet An outlet number. range A range of outlet numbers, with a hyphen separating the starting number from the ending number. user_name A user configured in the local dat
Summary of the content on the page No. 16
Command Reference: User Management Commands 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 password must be one to ten printable ASCII characters. You must change RADIUS-authenticated passwords at the RADIUS server. Access: All three account types, to change the logged-on user’s password. Administrator only, to change another user’s
Summary of the content on the page No. 17
Command Reference: User Management 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 removed only at the RADIUS server.) Access: Administrator only Parameters: outlet An outlet number. range A range of outlet numbers, with a hyphen separating the starting number from the ending number. user_name A user configured in the local
Summary of the content on the page No. 18
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 grants access through the CLI assign command or through the Web or control console interfaces of the Switched Rack PDU.) Synchronized outlet groups You can use the outletgroups command to list synchronized outlet groups that are defined
Summary of the content on the page No. 19
Outlet Commands off Syntax: all off 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 must be configured as part of a synchronized outlet group. Parameters: all The value all turns off all outlets of the Switched Rack PDU. This value is not case- sensit
Summary of the content on the page No. 20
Command Reference: Outlet Commands on Syntax: all on 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 synchronization, outlets must be configured as part of a synchronized outlet group. Parameters: all The value all turns on all outlets of the Switched Rack PDU. This value is not c
