Vertiv LIEBERT RPC2 Operating manual

RPC2™ Communications Module
Command Reference Guide

Technical Support Site
If you encounter any installation or operational issues with your product, check the pertinent section of this manual to see if
the issue can be resolved by following outlined procedures. For additional assistance, visit https://www.VertivCo.com/en-
us/support/.

TABLE OF CONTENTS
1 Command Line Interface 1
1.1 Accessing the CLI 1
1.2 Navigation 1
1.2.1 Auto-completion 1
1.3 Predefined Groups 2
1.4 User-defined Groups 2
1.5 Default Users 2
2 Commands 3
2.1 Values 3
2.2 help 4
2.3 auth 6
2.4 backup_restore 6
2.5 breakerstate 7
2.6 buzzer 8
2.7 crestfactor 8
2.8 current 9
2.9 datalog 13
2.10 delay 14
2.11 devicechange 14
2.12 energy 15
2.13 exit 16
2.14 factorydefaults 16
2.15 fwupdate 16
2.16 group 18
2.17 label 20
2.18 meminfo 20
2.19 message 20
2.20 nandinfo 22
2.21 network 22
2.22 notification 24
2.23 password 26
2.24 power 26
2.25 powerfactor 27
2.26 reboot 28
2.27 receptaclegroup 28
2.28 receptaclestate 30
2.29 sensor 31
2.30 snmp 32
2.31 status 35
2.32 swocp 36
2.33 swotp 37
2.34 sysinfo 37
2.35 syslog 38
2.36 system 39
2.37 tag 40
2.38 time 41
2.39 unbalancedload 42
Vertiv | RPC2™ Communications Module Command Reference Guide | 3

2.40 user 43
2.41 voltage 43
2.42 whoami 44
3 Appendices 45
Appendix A: Serial Port Configuration for Appliance Integration 45
Appendix B: Input Power Cord Wiring Type 45
Vertiv | RPC2™ Communications Module Command Reference Guide | 4

1 COMMAND LINE INTERFACE
The RPC2™ Communications Module can be administered and accessed with the Command Line Interface (CLI)utility.
The CLIuses text-based commands in place of the Web User Interface (UI)to perform module tasks more quickly and offer
more control. In some instances, the CLIcan be used to configure multiple module settings at once.
As a supplement to the RPC2™ Communications Module User Manual, this guide describes how to access and navigate the
CLI utility and how to use it after the module has been installed and assigned an IP address. For information to install or
operate your module using the appliance web user interface (UI), see the RPC2™ Communications Module User Manual.
1.1 Accessing the CLI
The CLI can be accessed through a local terminal or a computer that has a terminal emulation program connected to the
network port of the module.
-or-
After the module is connected to the network and has an IP address, it can be accessed by one of the following methods:
•With the web UI
•With an SSH or Telnet client on a remote computer (if the SSH or Telnet protocol is enabled in the
selected security profile)
To access the CLI from the module web UI:
1. Log in to the web UI of the module.
2. From the sidebar of the System tab, click Settings.
3. Click the Open CLIicon at the top of the screen.
1.2 Navigation
The following table lists the keys used to navigate the CLI.
KEY DESCRIPTION
Tab Completes the current command
Delete Removes one character to the right of the cursor
Backspace Removes one character to the left of the cursor
Ctrl-A Moves the cursor to the beginning of the current line
Ctrl-U Deletes a line
Ctrl-W Deletes a word
Up Arrow Scrolls through recent CLIhistory
Down Arrow Scrolls through older CLIhistory
Left Arrow Moves the cursor to the left of the current command line
Right Arrow Moves the cursor to the right of the current command line
Table 1.1 CLI Key Descriptions
1.2.1 Auto-completion
The following table describes the keys used to perform auto-completion.
KEY DESCRIPTION
Enter Auto completes, checks syntax and then executes the command. If there is a syntax error, the offending part of the command is highlighted
Table 1.2 Auto-completion Key Descriptions
Vertiv | RPC2™ Communications Module Command Reference Guide | 1

KEY DESCRIPTION
and explained.
Space Auto completes or, if the command has been resolved, inserts a space.
Tab Auto completes or shows available commands or user parameters.
1.3 Predefined Groups
The RPC2™ Communications Module has four predefined groups with capabilities associated with each group. Predefined
groups cannot be deleted, and only users can be added to or deleted from a predefined group. The following table
describes each predefined group with its capabilities.
GROUP
NAME ROLE CAPABILITIES NOTES
admin
An admin has the following capabilities:
•Manage all the system settings related to the
device, for example updating the device firmware
on a rack PDU.
•Add or delete a user.
•Configure the user role (for example, user,
poweruser, device-admin or appliance).
•Configure the permissions and access.
•Provides the same capabilities as a poweruser or
user.
The admin user is not a Linux®root.
poweruser
Capability to configure the power management settings at the
bank/strip level. For example, set thresholds, view event, data
logs and so on.
This group typically consists of personnel responsible for data center
management operations.
appliance Capabilities similar to those of a poweruser. This group is dedicated for integration with appliances connected via
serial port.
user Capability to manage receptacles assigned to them.
This group typically consists of system administrators who support
the ITequipment in a rack and need the ability to turn those devices
off and on.
Table 1.3 Predefined Groups Descriptions
1.4 User-defined Groups
The communications module supports user-defined groups. These groups have the same capabilities as the predefined user
group.
1.5 Default Users
The default users are listed in the following table.
NOTE: Default members cannot be deleted.
GROUP TYPE DEFAULT LOGIN DEFAULT PASSWORD
admin Protected admin admin
appliance Protected appliance rpc2k
poweruser Protected pwrusr pwrusr
user Protected NA NA
<custom user> User-defined NA NA
Table 1.4 Default Users
Vertiv | RPC2™ Communications Module Command Reference Guide | 2

2 COMMANDS
This section lists and describes the commands available in the CLIfor the RPC2™ Communications Module.
Each command in this guide has a table. Each level of the table represents an argument level in the CLI. Arguments
contained within angle brackets (< >) are user-defined arguments. For example, the following table defines the user
command.
user
help
add
<user>
<password>
<confirm password>
del
<user>
<user>
Table 2.1 Syntax
The first argument in the command is always user.
cli->user
From there, you can access the context-sensitive help.
cli->user help
To add a user, you must define the username and password and confirm the password.
cli->user add <user><password><confirm password>
The add and delete arguments are on the same level as the help argument. The <user>, <password> and <confirm
password>arguments follow on separate levels.
2.1 Values
For some of the commands, you can set the values for a PDU, branch, receptacle or phase. The following are acceptable
values.
PDU:1-4
Branch:A-G
NOTE: When setting the value for a branch, you must use uppercase letters.
Receptacle:1-48
Phase:L1-L3, L12, L23, L31 or N for neutral phase
NOTE: Type @for either a branch or receptacle to set the values for all branches and receptacles.
Vertiv | RPC2™ Communications Module Command Reference Guide | 3

2.2 help
Type a question mark (?)or help to display the context-sensitive help. The context-sensitive help displays a list of possible
commands with summaries or the full syntax with all options for the current command. The context-sensitive help is
available for each command of the CLI.
NOTE: For user-defined parameters, a space is required between the parameter and the question mark for help about
the next parameter. If the space is not provided, the context remains with the current parameter.
Example
cli-> current help
Synopsis
-Displays the metered reading of the AC Current at a PDU / Branch / Receptacle / Phase level in a Rack
PDU / Rack PDU Array
-Display / Configure the Threshold Values for current at PDU / Branch / Receptacle / Phase level in a
Rack PDU / Rack PDU Array
-Displays the amount of current increase allowed before the over current alarm occurs at a PDU / Branch /
Receptacle / Phase level in a Rack PDU / Rack PDU Array
-Displays the % of receptacle electrical current utilization relative to the receptacle's current rating at a
PDU / Branch / Receptacle / Phase level in a Rack PDU / Rack PDU Array
Syntax
current [{PDU}[.{BRN}[.{RECP}]]]
current {PDU} {PHASE}
current {cmd_option} [{PDU}[.{BRN}[.{RECP}]]]
Vertiv | RPC2™ Communications Module Command Reference Guide | 4

current {cmd_option} {PDU} {PHASE}
current threshold {PDU}.{BRN}[.{RECP}] {threshold_values}
current threshold {PDU} {PHASE} {threshold_values}
...{cmd_option= threshold, untilalarm, utilization}
...{PDU= 1..4} {PHASE= L1, L2, L3, N, @} {BRN= A..G, @} {RECP= 1..48, @}
...For L1, L2, L3 : {threshold_values = (high_critical=0..100):(high_warn=0..100):(low_critical=0..100)}
...For N : {threshold_values = (high_critical=0..100):(high_warn=0..100)}
Vertiv | RPC2™ Communications Module Command Reference Guide | 5

2.3 auth
Type auth to display the authentication configuration information of a rack PDU or Rack PDU Array™. An admin can
configure the authentication parameters.
auth
help
type
kerberos, kerberos_local, kerberos_down_local, ldap, ldap_local, ldap_down_local, local, local_radius, local_tacacs+, dsview, dsview_
local, radius, radius_local, radius_down_local, tacacs+, tacacs+_local, tacacs+_down_local
webmode
Form-base, Digest
remoteserver
dsview
<ipaddr1>, <ipaddr2>, <ipaddr3>, <ipaddr4>
radius
<firstauthadd>, <firstaccountaddr>, <secondauthaddr>, <secondaccountaddr>, <secret>, <confirmsecret>, <timeout>, <retries>
tacacs+
<firstauthaddr>, <firstaccountaddr>, <secondauthaddr>, <secondaccountaddr>, <service>, <secret>, <confirmsecret>,
<timeout>, <retries>, <version>
ldap_ad
<server>, <base>, <secure>, <username>, <password>, <cofirmpassword>, <loginattr>
kerberos
<realmserver>, <realmname>, <domainname>
Table 2.2 Syntax
Examples
To set the authentication type as DSView, enter the following command.
cli->auth type dsview
To configure the DSView remote server, enter the following command.
cli-> auth remoteserver dsview <IPAddress1> <IPAddress2> <IPAddress3><IPAddress4>
2.4 backup_restore
Type backup_restore to display the backup and restore settings for the module. An admin can configure the settings.
backup_restore
help
restore
Table 2.3 Syntax
Vertiv | RPC2™ Communications Module Command Reference Guide | 6

backup
source
<type>
ftp
<ipaddr>
<username>
<passwd>
<filedir>
<filename>
Examples
To restore all configurations, enter the following command.
cli->backup_restore restore
To back up all configurations, enter the following command.
cli->backup_restore backup
To configure the file name to be used for the backup and restore file, enter the following command.
cli-> backup_restore ftp filename <file name>
2.5 breakerstate
Type breakerstate to display the status (Open or Close)of the branch overcurrent protection in a rack PDUor Rack
PDUArray™. This command is available for an admin, appliance or poweruser.
breakerstate
help
<pdu>
<pdu.branch>
Table 2.4 Syntax
Examples
To view the status of PDU2, enter the following command.
cli->breakerstate 2
[2] --- (A) Close (B) Close (C) Close
To view the status of branch Bon PDU2, enter the following command.
Vertiv | RPC2™ Communications Module Command Reference Guide | 7

cli->breakerstate 2.B
[2] --- (B) Close
2.6 buzzer
Type buzzer to facilitate enabling and disabling of the buzzer. This command is available for an admin, appliance or
poweruser.
NOTE: This command is supported for the rack PDU array level, but not for an individual rack PDU.
buzzer
help
enable
disable
Table 2.5 Syntax
Example
To enable the buzzer, enter the following command.
cli->buzzer enable
2.7 crestfactor
Type crestfactor to display the AC current crest factor of the receptacles in a rack PDU or Rack PDU Array™. This
command is available for an admin, appliance or poweruser.
crestfactor
help
<pdu>
<pdu.branch>
<pdu.branch.receptacle>
Table 2.6 Syntax
Examples
To view the crest factor for PDU2, enter the following command.
cli->crestfactor 2
[2.A] --- (1) 1.38 (2) 1.40 (3) 1.41 (4) 1.41 (5) 1.39 (6) 1.39
Vertiv | RPC2™ Communications Module Command Reference Guide | 8

[2.B] --- (1) 1.39 (2) 1.40 (3) 0.00 (4) 0.00 (5) 1.39 (6) 1.40
[2.C] --- (1) 1.41 (2) 1.40 (3) 1.39 (4) 0.00 (5) 0.00 (6) 0.00
To view the crest factor of branch Aof PDU2, enter the following command.
cli->crestfactor 2.A
[2.A] --- (1) 1.38 (2) 1.40 (3) 1.41 (4) 1.41 (5) 1.39 (6) 1.39
To view the crest factor of the sixth receptacle of branch Cof PDU2, enter the following command.
cli->crestfactor 2.C.6
[2.C] --- (6) 1.41
2.8 current
Type current to display the following at the input phase, branch and receptacle levels in a rack PDU or Rack PDUArray™.
•The metered reading of the AC current (RMS).
•The configurable threshold values for current.
•The amount of current increase allowed before the overcurrent alarm occurs.
•The percentage of receptacle current utilization relative to the receptacle’s current rating.
This command is available for an admin, appliance or poweruser.
Neutral current measurement and threshold settings are possible only at the PDU level for models having a neutral
connection. Except for neutral current, threshold values are colon-separated values in the following order: {high_critical}:
{high_warn}:{low_critical}.
NOTE: There is no {low_warn} threshold in a Vertiv MPH or MPX™ rack PDU.
If any threshold is not provided, the same has to be denoted with a hyphen “-” for example, {high_critical}:-:{low_critical}. For
neutral current, threshold values are colon-separated values in the following order: {high_critical}:{high_warn}. The {low_
critical} threshold does not exist for neutral current. Threshold current values are also expressed as a percentage of the
rated current value.
NOTE: Threshold values (high critical, high warning and low critical)have ranges of 0-100.
current
help
<pdu>
<phase>
Table 2.7 Syntax
Vertiv | RPC2™ Communications Module Command Reference Guide | 9

<pdu.branch>
<pdu.branch.receptacle>
threshold
<pdu>
<phase>
<pdu.branch>
<pdu.branch.receptacle>
current threshold
<pdu>
<phase> <threshold_values>
<pdu.branch>
<pdu.branch.receptacle> <threshold_values>
untilalarm
<pdu>
<phase>
utilization
<pdu>
<phase>
<pdu.branch>
<pdu.branch.receptacle>
Examples
To view the current for PDU 2, enter the following command.
cli->current 2
[2] --- (L1) 1.70 A (L2) 1.60 A (L3) 0.00 A (N) 0.10 A
[2] --- (A) 1.50 A (B) 1.10 A (C) 0.00 A
[2.A] --- (1) 0.10 A (2) 0.10 A (3) 0.00 A (4) 0.00 A (5) 0.00 A (6) 0.00 A
[2.B] --- (1) 0.00 A (2) 0.00 A (3) 0.10 A (4) 0.10 A (5) 0.00 A (6) 0.10 A
[2.C] --- (1) 0.10 A (2) 0.00 A (3) 0.00 A (4) 0.00 A (5) 0.00 A (6) 0.00 A
To view the current for the first phase of PDU2, enter the following command.
Vertiv | RPC2™ Communications Module Command Reference Guide | 10

cli->current 2 L1
[2] --- (L1) 1.70 A
To view the neutral current for PDU2, enter the following command.
cli->current 2 N
[2] --- (N) 0.10 A
To view the current for all lines of PDU2, enter the following command.
cli->current 2 @
[2] --- (L1) 1.70 A (L2) 1.60 A (L3) 0.00 A (N) 0.10 A
To view the current for branch B of PDU2, enter the following command.
cli->current 2.B
[2] --- (B) 1.10 A
To view the current for receptacle 6 of branch Cof PDU2, enter the following command.
cli->current 2.C.6
[2.C] --- (6) 0.00 A
To view the current threshold for PDU2, enter the following command.
cli->current threshold 2
[2] --- (L1) 85 : 80 : 5 (L2) 85 : 80 : 5 (L3) 85 : 80 : 5 (N) 85 : 80: -
Vertiv | RPC2™ Communications Module Command Reference Guide | 11

[2] --- (A) 80 : 75 : 5 (B) 80 : 75 : 5 (C) 80 : 75 : 5
[2.A] --- (1) 75 : 70 : 5 (2) 75 : 70 : 5 (3) 75 : 70 : 5 (4) 75 : 70 : 5 (5) 75 : 70 : 5 (6) 75 : 70 : 5
[2.B] --- (1) 75 : 70 : 5 (2) 75 : 70 : 5 (3) 75 : 70 : 5 (4) 75 : 70 : 5 (5) 75 : 70 : 5 (6) 75 : 70 : 5
[2.C] --- (1) 75 : 70 : 5 (2) 75 : 70 : 5 (3) 75 : 70 : 5 (4) 75 : 70 : 5 (5) 75 : 70 : 5 (6) 75 : 70 : 5
To configure the threshold value for branch Aof PDU2, enter the following command.
cli->current threshold 2.A 80:75:5
To view the current untilalarm for branch Bof PDU2, enter the following command:
cli->current untilalarm 2.B
[2] --- (B) 6.00 A
To view the current utilization for PDU2, enter the following command.
cli->current utilization 2
[2] --- (L1) 79.17% (L2) 79.1 % (L3) 75.00%
[2] --- (A) 77.77% (B) 68.42% (C) 77.77%
[2.A] --- (1) 85.71% (2) 85.71% (3) 68.00% (4) 71.50% (5) 71.50% (6) 85.71%
[2.B] --- (1) 85.71% (2) 85.71% (3) 85.71 % (4) 71.50% (5) 68.00% (6) 68.00%
[2.C] --- (1) 68.00% (2) 71.50% (3) 71.50 % (4) 71.50% (5) 85.71% (6) 85.71%
Vertiv | RPC2™ Communications Module Command Reference Guide | 12

2.9 datalog
Type datalog to enable an admin to log all levels of PDUdata to a log file.
datalog
help
export_ftp
ipaddr <value>
username <value>
passwd <value>
filedir <value>
filename <value>
export_type
<type> (ftp)
flush
interval
<value> (5, 15, 30, 60 minutes)
perform_export
<level> (datalog, pdu, branch, receptacle)
enable
disable
Table 2.8 Syntax
Examples
To enable data logging at the PDUlevel, enter the following command.
cli->datalog pdu enable
To configure the data log polling interval for 30 minutes, enter the following command.
cli->datalog interval 30
To configure an FTPserver for data logging, enter the following commands.
cli->datalog export_ftp ipaddr <ip address>
cli->datalog export_ftp username <username>
cli->datalog export_ftp passwd <password>
Vertiv | RPC2™ Communications Module Command Reference Guide | 13

cli->datalog export_ftp filedir <file directory>
cli->datalog export_ftp filename <file name>
2.10 delay
Type delay to display values and facilitate configuration for poweron, post on and post off time delay at the receptacle
level. This command is available for an admin, appliance or poweruser.
delay
help
poweron
<pdu>
<pdu.branch>
<pdu.branch.receptacle>
post_on
<pdu>
<pdu.branch>
<pdu.branch.receptacle>
post_off
<pdu>
<pdu.branch>
<pdu.branch.receptacle>
Table 2.9 Syntax
Examples
To view the post-off delay for the sixth receptacle on branch Cof PDU2, enter the following command.
cli-> delay post_off 2.C.6
[2.C] --- (6) 1 s
To configure the poweron at 5 seconds and the post on and post off at 1 second each for all of PDU2, enter the following
command.
cli->delay 2 5:1:1
2.11 devicechange
Type devicechange to acknowledge and display the module change status information for an admin.
Vertiv | RPC2™ Communications Module Command Reference Guide | 14

devicechange
help
acknowledge
show
Table 2.10 Syntax
Example
To display a device change, enter the following command.
cli-> devicechange show
Module Serial Number Module Type Change
---------------------------------- ------------------------------ --------
4037-122 Rack PDU Card Added
DY2013OCT142575-B1 Branch Receptacle Module Added
DY2013OCT142575-B2 Branch Receptacle Module Added
DY2013OCT142575-B3 Branch Receptacle Module Added
2.12 energy
Type energy to display the values of the accumulated real power energy (kWatt-hr) reading from the energy counter and
facilitate resetting the energy counter to zero. This command is available for an admin, appliance or poweruser.
energy
help
pdu
<pdu>
<pdu.branch>
<pdu.branch.receptacle>
reset
<pdu>
Table 2.11 Syntax
Vertiv | RPC2™ Communications Module Command Reference Guide | 15

<pdu.branch>
<pdu.branch.receptacle>
Examples
To view the energy for receptacle 4 of branch Aof PDU1, enter the following command.
cli->energy 1.A.4
[1.A] --- (4) 3.70 kWH
To reset the energy for receptacle 4 of branch Aof PDU1, enter the following command.
cli->energy reset 1.A.4
2.13 exit
Type exit to log out of the current session.
2.14 factorydefaults
Type factorydefaults to reset all PDUs to their factory default settings. The admin and appliance users have access to this
command.
2.15 fwupdate
Type fwupdate to enable an admin to update the firmware for the module.
fwupdate
help
update
source
<source type> (tftp, ftp)
ftp
ipaddr <value>
username <value>
passwd <value>
filedir <value>
filename <value>
tftp
ipaddr <value>
port <value>
filedir <value>
filename <value>
Table 2.12 Syntax
Vertiv | RPC2™ Communications Module Command Reference Guide | 16