LEGRAND Server Technology PRO3X User manual

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
2 of 182

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
3 of 182
About Your User Guide
This user guide was designed for data center staff and administrators who monitor power, control outlet actions,
and direct equipment operations in the data center network using the Command Line Interface (CLI) on the
PRO3X product group.
This guide is a detailed resource for the PRO3X CLI commands, description, syntax, usage, parameters, variables,
as well as providing command examples and results to assist you with using the firmware’s interface.
2
•2

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
4 of 182
Contact Technical Support
Experience Server Technology's FREE Technical Support
Server Technology understands that there are often questions when installing and/or using a new product.
Free Technical Support is provided from 8 a.m. to 5 p.m. Pacific Time, Monday through Friday.
Server Technology, Inc. (a brand of Legrand)
1040 Sandhill Road Tel: [phone] Web: www.servertech.com
Reno, Nevada 89521 USA Fax: [phone] Email: [email protected]

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
5 of 182
Safety Precautions
This section contains important safety/regulatory information that must be reviewed before installing and using
the PRO3X PDU.
Only for installation and use in a
Restricted Access Location in
accordance with the following installation
and use instructions.
This equipment should only be
installed by trained personnel.
Destiné à l'installation et l'utilisation dans le
cadre de Restricted Access Location selon
les instructions d'installation et d'utilisation.
Cet équipement est uniquement destiné à
être installé par personnel qualifié.
Nur für Installation und Gebrauch in
eingeschränkten Betriebszonen gemäß der
folgenden Installations-und
Gebrauchsanweisungen.
Dieses Gerät ist nur für den Einbau durch
Personal vorgesehen.
This equipment is designed to be
installed on a dedicated circuit. The
power supply cord shall be a minimum of
1.5m (4.9ft) and a maximum of 4.5m
(15ft). If using an extension power cord,
the total length shall also be no more
than the maximum allowed. The plug is
considered the disconnect device and
must be easily accessible.
Cet équipement a été conçu pour être installé
que un circuit dédié. Le cordon d’alimentation
doit être d’au moins 1,5M et un maximum de
4,5m. Si vous utilisez un cordon de rallonge,
la longueur totale est également plus que le
maximum autorise. La prise est considérée
comme un dispositif de coupure et doit être
facilement accessible.
Die Geräte sind für eine Installation an einer
fest zugeordneten Leitung ausgelegt. Die
Stromzuleitung hat eine Mindestlänge von
1,5m, und hochstens 4,5m. Sollten Sie ein
Verlangerrungsnetzkabel, der Gesamtlange
auch nicht mehr als die maximal zulassige
sein. Der Stecker dient zur Trennung vom Netz
und muss einfach erreichbar sein.
The dedicated circuit must have circuit
breaker or fuse protection. PDUs have
been designed without a master circuit
breaker or fuse to avoid becoming a
single point of failure. It is the customer’s
responsibility to provide adequate
protection for the dedicated power
circuit. Protection of capacity equal to
the current rating of the PDU must be
provided and must meet all applicable
codes and regulations. In North America,
protection must have a 10,000A interrupt
capacity.
Le circuit spécialisé doit avoir un disjoncteur
ou une protection de fusible. PDUs ont été
conçus sans disjoncteur général ni fusible
pour éviter que cela devient un seul endroit
de panne. C’est la responsabilité du client de
fournir une protection adéquate pour le
circuit-alimentation spécialisé. Protection de
capacité équivalant à la puissance de
l'équipement, et respectant tous les codes et
normes applicables. Les disjoncteurs ou
fusibles destinés à l'installation en Amérique
du Nord doivent avoir une capacité
d'interruption de 10.000 A.
Der feste Stromkreis muss mit einem
Schutzschalter oder einem Sicherungsschutz
versehen sein. PDUs verfügt über keinen
Hauptschutzschalter bzw. über keine
Sicherung, damit kein einzelner Fehlerpunkt
entstehen kann. Der Kunde ist dafür
verantwortlich, den Stromkreis sachgemäß zu
schützen. Der Kapazitätsschutz entspricht der
aktuellen Stromstärke der Geräte und muss
alle relevanten Codes und Bestimmungen
erfüllen. Für Installation in Nordamerika
müssen Ausschalter bzw. Sicherung über
10.000 A Unterbrechungskapazität verfügen.
Models with unterminated power cords:
Input connector must be installed by
qualified service personnel. Input
connector rating must meet all applicable
codes and regulations.
Modèles avec cordons d'alimentation non
terminées: Le connecteur d’entrée doit être
installé par un personnel qualifié. Entrée cote
de raccordement doit respecter tous les
codes et règlements électriques applicables.
Modelle mit nicht abgeschlossenen Netzkabel:
Der Eingangsstecker darf nur von
qualifiziertem Wartungspersonal installiert
werden. Eingangsanschluss Bewertung
müssen alle geltenden und verbindlichen
Normen und Vorschriften entsprechen.
Do not block venting holes when
installing this product. Allow for
maximum airflow at all times.
Ne bloquez pas les orifices d'aération lors de
l'installation de ce produit. Permettre une
circulation d'air maximale à tout moment.
Achten Sie darauf, dass keine
Belüftungslöcher bei der Installation dieses
Produkts. Damit für maximalen Luftstrom zu
allen Zeiten.
Installation Orientation: Vertical units are
designed to be installed in vertical
orientation.
Installation Orientation: Les unités vertical
sont conçues pour être installées dans une
orientation verticale.
Installationsausrichtung: Vertical Einheiten sind
zur vertikalen Installation vorgesehen.
Always disconnect the power supply
cord before servicing to avoid electrical
shock. For products with two input power
cords, both must be disconnected before
servicing.
Toujours débrancher le cordon d'alimentation
avant de l'ouverture pour éviter un choc
électrique. Pour les produits avec deux
cordons d'alimentation d'entrée, les deux
doivent être déconnectés avant l'entretien.
Trennen Sie das Netzkabel, bevor Sie
Wartungsarbeiten Öffnung einen elektrischen
Schlag zu vermeiden. Für Produkte mit zwei
Eingangsstromkabel, sowohl, müssen vor der
Wartung abgeschaltet werden.
WARNING! High leakage current! Earth
connection is essential before
connecting supply!
ATTENTION! Haut fuite très possible! Une
connection de masse est essentielle avant de
connecter l’alimentation !
ACHTUNG! Hoher Ableitstrom! Ein
Erdungsanschluss ist vor dem Einschalten der
Stromzufuhr erforderlich!
WARNING! Cx-xxE-x units double
pole/neutral fusing
ATTENTION! Les unités Cx-xxE-x Double
Pôle/Fusible sur le Neutre
ACHTUNG!: Cx-xxE-x Zweipolige bzw.
Neutralleiter-Sicherung

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
6 of 182
ATTENTION! Observe precautions for
handling Electrostatic Sensitive Devices.
Attention ! Respecter les mesures de sécurité
en manipulant des dispositifs sensibles aux
décharges électrostatiques.
Achtung! Vorsichtshinweise zur Handhabung
elektrostatisch empfindlicher Geräte beachten.
Products rated for 240/415VAC may be
fitted with a plug that is rated for a higher
voltage. Caution must be taken to assure
that the rating of the unit and the supply
voltage match.
Les produits prévus pour 240/415VAC peut
être équipé d'un bouchon qui est conçu pour
une tension plus élevée. Des précautions
doivent être prises pour assurer que la cote
de l’unité et la tension d’alimentation
correspond.
Produkte die für 240/415VAC zugelassen sind
können mit einem Stecker der für eine höhere
Spannung ausgestattet sein. Vorsicht ist
geboten, um sicherzustellen, dass die
erlaubten Betriebswerte des Gerätes und der
Versorgungsspannung zueinander passen.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
7 of 182
Attaching Safety Earth Ground Connection
Server Technology PDUs are supplied with an external safety ground connection to provide an alternate ground
path for fault currents, and to maintain the same ground reference between it and the equipment rack.
Note:The auxiliary external ground location may vary. Most PDUs will have it located near the power cord entry
located near the symbol.
User-Supplied Materials:
•One 5 mm internal (or external) tooth star washer;
•One 4.0 mm2 (10 AWG) wire with 5 mm ring terminal;
•One metric M5 x 6 mm coarse pitch screw.
Instructions:
1. Connect one end of the ground wire to the equipment cabinet or local ground.
2. Locate the PDU external ground near the symbol.
3. Connect the other end with a ring terminal and a M5 screw to the PDU external ground.
To ensure proper grounding to chassis, use a star washer between ring terminal and PDU.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
8 of 182
Using the Command Line Interface
This user guide explains how to use the command line interface (CLI) to administer the PRO3X. Note that available CLI
commands are model dependent. CLI commands are case sensitive.
About the Interface
The PRO3X provides a command line interface that enables data center administrators to perform some basic management
tasks.
Using this interface, you can do the following:
•Reset the PRO3X
•Display the PRO3X and network information, such as the device name, firmware version, IP address, and so on
•Configure the PRO3X and network settings
•Troubleshoot network problems
You can access the interface over a local connection using a terminal emulation program such as HyperTerminal, or via a
Telnet or SSH client such as PuTTY.
Note: Telnet access is disabled by default because it communicates openly and is thus insecure.
Logging in to CLI
Logging in via HyperTerminal over a local connection is a little different than logging in using SSH or Telnet.
If a security login agreement has been enabled, you must accept the agreement in order to complete the login. Users are
authenticated first and the security banner is checked afterwards.
With HyperTerminal
You can use any terminal emulation programs for local access to the command line interface.
This section illustrates HyperTerminal, which is part of Windows operating systems prior to Windows Vista.
To log in using HyperTerminal:
1. Connect your computer to the product via a local (USB or RS-232) connection.
2. Launch HyperTerminal on your computer and open a console window. When the window first opens, it is blank.
Make sure the COM port settings use this configuration:
▪Bits per second = 115200 (115.2Kbps)
▪Data bits = 8
▪Stop bits = 1
▪Parity = None
▪Flow control = None
3. In the communications program, press Enter to send a carriage return to the PRO3X. The Username prompt appears.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
9 of 182
4. Type a name and press Enter. The name is case sensitive. Then you are prompted to enter a password.
5. Type a password and press Enter. The password is case sensitive.
After properly entering the password, the # or > system prompt appears.
Tip: The 'Last login' information, including the date and time, is also displayed if the same user account was used to log in
to this product's web interface or CLI.
6. You are now logged in to the command line interface and can begin administering this product.
With SSH or Telnet
You can remotely log in to the command line interface (CLI) using an SSH or Telnet client, such as PuTTY.
Note: PuTTY is a free program you can download from the Internet. Refer to PuTTY's documentation for details on
configuration.
To log in using SSH or Telnet:
1. Ensure SSH or Telnet has been enabled.
2. Launch an SSH or Telnet client and open a console window. A login prompt appears.
3. Type a name and press Enter. The name is case sensitive.
Note: If using the SSH client, the name must NOT exceed 25 characters. Otherwise, the login fails.
Then you are prompted to enter a password.
4. Type a password and press Enter. The password is case sensitive.
5. After properly entering the password, the # or > system prompt appears..
Tip: The 'Last login' information, including the date and time, is also displayed if the same user account was used to log in
to this product's web interface or CLI.
6. You are now logged in to the command line interface and can begin administering this product.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
10 of 182
With an Analog Modem
The PRO3X supports remote access to the CLI via a connected analog modem. This feature is especially useful when the LAN
access is not available.
To connect to the PRO3X via the modem:
1. Make sure the PRO3X has an analog modem connected.
2. Make sure the computer you are using has an appropriate modem connected.
3. Launch a terminal emulation program, and configure its baud rate settings according to the baud rate set for the
analog modem connected to the PRO3X.
4. Type the following AT command to make a connection with the PRO3X.
ATD<modem phone number>
5. The CLI login prompt appears after the connection is established successfully. Then type the user name and
password to log in to the CLI.
To disconnect from the PRO3X:
6. Return to the modem's command mode using the escape code +++.
7. After the OK prompt appears, type the following AT command to disconnect from the PRO3X.
ATH
Different CLI Modes and Prompts
Depending on the login name you use and the mode you enter, the system prompt in the CLI varies.
User Mode: When you log in as a normal user, who may not have full permissions to configure the PRO3X, the >prompt
appears.
Administrator Mode: When you log in as an administrator, who has full permissions to configure the PRO3X, the #prompt
appears.
Configuration Mode: You can enter the configuration mode from the administrator or user mode. In this mode, the prompt
changes to config:# or config:> and you can change PRO3X device and network configurations.
Diagnostic Mode: You can enter the diagnostic mode from the administrator or user mode. In this mode, the prompt changes
to diag:# or diag:> and you can perform the network troubleshooting commands, such as the ping command.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
11 of 182
Closing the Local Connection
Close the window or terminal emulation program when you finish accessing the PRO3X over the local connection.
When accessing or upgrading multiple PRO3X devices, do not transfer the local connection cable from one device to
another without closing the local connection window first.
The ? Command for Showing Available Commands
When you are not familiar with CLI commands, you can press the ? key at any time for one of the following purposes.
Show a list of main CLI commands available in the current mode.
Show a list of available commands or parameters for the command you type.
In the administrator mode:
#
?
In the configuration mode:
config:#
?
In the diagnostic mode:
diag:#
?
Press Enter after pressing the ? command, and a list of main commands for the current mode is displayed.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
12 of 182
Querying Available Parameters for a Command
If you are not sure what commands or parameters are available for a particular type of CLI command or its syntax, you can
have the CLI show them by adding a space and the help command (?) or list command (ls) to the end of that command. A list
of available parameters and their descriptions will be displayed.
The following shows a few query examples.
To query available parameters for the "show" command:
#
show ?
To query available parameters for the "show user" command:
#
show user ?
To query available role configuration parameters:
config:#
role ?
To query available parameters for the "role create" command:
config:#
role create ?
Showing Information
You can use the show commands to view current settings or the status of the PRO3X device or part of it, such as the IP
address, networking mode, firmware version, states or readings of internal or external sensors, user profiles, and so on.
Some "show" commands have two formats: one with the parameter "details" and the other without. The difference is that
the command without the parameter "details" displays a shortened version of information while the other displays in-depth
information.
After typing a "show" command, press Enter to execute it.
Note: Depending on your login name, the # prompt may be replaced by the > prompt.
Network Configuration
This command shows all network configuration and all network interfaces' information, such as the IP address, MAC address,
the Ethernet interfaces' duplex mode, and the wireless interface's status/settings.
#
show network

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
13 of 182
IP Configuration
This command shows the IP settings shared by all network interfaces, such as DNS and routes. Information shown
will include both IPv4 and IPv6 configuration.
#
show network ip common
To show the IP settings of a specific network interface, use the following command.
#
show network ip interface <ETH>
Variables:
<ETH> is one of the network interfaces: ETH1/ETH2, WIRELESS, or BRIDGE. Note that you must choose/configure the bridge
interface if your PRO3X is set to the bridging mode.
Note: In the bridging mode, only the IP parameters of the BRIDGE interface function. The IP parameters of ETH1/ETH2
and WIRELESS interfaces do NOT function.
Interface
Description
eth1
Show the IP-related configuration of the ETH1
interface.
eth2
Show the IP-related configuration of the ETH2
interface.
wireless
Show the IP-related configuration of the WIRELESS
interface.
bridge
Show the IP-related configuration of the BRIDGE
interface.
all
Show the IP-related configuration of all interfaces.
Tip: You can also type the command without adding
this option "all" to get the same data. That is, show
network ip interface.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
14 of 182
IPv4-Only or IPv6-Only Configuration
To show IPv4-only or IPv6-only configuration, use any of the following commands.
To show IPv4 settings shared by all network interfaces, such as DNS and routes:
#
show network ipv4 common
To show IPv6 settings shared by all network interfaces, such as DNS and routes:
#
show network ipv6 common
To show the IPv4 configuration of a specific network interface:
#
show network ipv4 interface <ETH>
To show the IPv6 configuration of a specific network interface:
#
show network ipv6 interface <ETH>
Variables:
<ETH> is one of the network interfaces: ETH1/ETH2, WIRELESS, or BRIDGE. Note that you must choose/configure the bridge
interface if your PRO3X is set to the bridging mode.
Note: In the bridging mode, only the IP parameters of the BRIDGE interface function. The IP parameters of ETH1/ETH2
and WIRELESS interfaces do NOT function.
Interface
Description
eth1
Show the IPv4 or IPv6 configuration of the ETH1
interface.
eth2
Show the IPv4 or IPv6 configuration of the ETH2
interface.
wireless
Show the IPv4 or IPv6 configuration of the WIRELESS
interface.
bridge
Show the IPv4 or IPv6 configuration of the BRIDGE
interface.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
15 of 182
Interface
Description
all
Show the IPv4 or IPv6 configuration of all interfaces.
Tip: You can also type the command without adding
this option "all" to get the same data. That is, show
network ipv4 interface.
Network Interface Settings
This command shows the specified network interface's information which is NOT related to IP configuration. For example, the
Ethernet port's LAN interface speed and duplex mode, or the wireless interface's SSID parameter and authentication
protocol.
#
show network interface <ETH>
Variables:
<ETH> is one of the network interfaces: ETH1/ETH2, WIRELESS, or BRIDGE. Note that you must choose/configure the bridge
interface if your PRO3X is set to the bridging mode.
Note: In the bridging mode, only the IP parameters of the BRIDGE interface function. The IP parameters of ETH1/ETH2
and WIRELESS interfaces do NOT function.
Interface
Description
eth1
Show the ETH1 interface's non-IP settings.
eth2
Show the ETH2 interface's non-IP settings.
wireless
Show the WIRELESS interface's non-IP settings.
bridge
Show the BRIDGE interface's non-IP settings.
all
Show the non-IP settings of all interfaces.
Tip: You can also type the command without adding
this option "all" to get the same data. That is, show
network interface.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
16 of 182
Network Service Settings
This command shows the network service settings only, including the Telnet setting, TCP ports for HTTP, HTTPS, SSH and
Modbus/TCP services, and SNMP settings.
#
show network services <option>
Variables:
<option> is one of the options: all, http, https, telnet, ssh, snmp, modbus and zeroconfig.
Option
Description
all
Displays the settings of all network services, including
HTTP, HTTPS, Telnet, SSH and SNMP.
Tip: You can also type the command without adding
this option "all" to get the same data.
http
Only displays the TCP port for the HTTP service.
https
Only displays the TCP port for the HTTPS service.
telnet
Only displays the settings of the Telnet service.
ssh
Only displays the settings of the SSH service.
snmp
Only displays the SNMP settings.
modbus
Only displays the settings of the Modbus/TCP service.
zeroconfig
Only displays the settings of the zero configuration
advertising.
PDU Configuration
This command shows the PDU configuration, such as the device name, firmware version, model type and upper limit of active
powered dry contact actuators.
#
show pdu
To show detailed information, add the parameter "details" to the end of the command.
#
show pdu details

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
17 of 182
Outlet Information
This command syntax shows the outlet information.
#
show outlets <n>
To show detailed information, add the parameter "details" to the end of the command.
#
show outlets <n> details
Variables:
<n> is one of the options: all, or a number.
Option
Description
all
Displays the information for all outlets.
Tip: You can also type the command without adding
this option "all" to get the same data.
A specific outlet
number
Displays the information for the specified outlet only.
Displayed information:
Without the parameter details only the outlet name is displayed.
With the parameter details more outlet information is displayed in addition to the outlet name, such as the outlet rating.
Inlet Information
This command syntax shows the inlet information.
#
show inlets <n>
To show detailed information, add the parameter "details" to the end of the command.
#
show inlets <n> details

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
18 of 182
Variables:
<n> is one of the options: all, or a number.
Option
Description
all
Displays the information for all inlets.
Tip: You can also type the command without adding
this option "all" to get the same data.
A specific inlet
number
Displays the information for the specified inlet only.
An inlet number needs to be specified only when there
are more than 1 inlet on your PDU.
Displayed information:
Without the parameter details only the inlet's name and RMS current are displayed.
With the parameter details more inlet information is displayed in addition to the inlet name and RMS current, such as the
inlet's RMS voltage, active power and active energy.
Overcurrent Protector Information
This command is only available for models with overcurrent protectors for protecting outlets.
This command syntax shows the overcurrent protector information, such as a circuit breaker or a fuse.
#
show ocp <n>
To show detailed information, add the parameter "details" to the end of the command.
#
show ocp <n> details
Variables:
<n> is one of the options: all, or a number.
Option
Description
all
Displays the information for all overcurrent protectors.
Tip: You can also type the command without adding
this option "all" to get the same data.
A specific
overcurrent
protector
number
Displays the information for the specified overcurrent
protector only.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
19 of 182
Displayed information:
Without the parameter details only the overcurrent protector status and name are displayed.
With the parameter details more overcurrent protector information is displayed in addition to status, such as the rating and
RMS current value.
Date and Time Settings
This command shows the current date and time settings on the PRO3X.
#
show time
To show detailed information, add the parameter "details" to the end of the command.
#
show time details
Default Measurement Units
This command shows the default measurement units applied to the PRO3X web and CLI interfaces across all users, especially
those users authenticated through remote authentication servers.
#
show user defaultPreferences
Note: If a user has set their own preferred measurement units or the administrator has changed any user's preferred units, the
web and CLI interfaces show the preferred measurement units for that user instead of the default ones.

Using the PRO3X Command Line Interface (CLI)
PRO3X User Guide –Command Line Interface (CLI)
20 of 182
Environmental Sensor Information
This command syntax shows the environmental sensor's information.
#
show externalsensors <n>
To show detailed information, add the parameter "details" to the end of the command.
#
show externalsensors <n> details
Variables:
<n> is one of the options: all, or a number.
Option
Description
all
Displays the information of all environmental sensors.
Tip: You can also type the command without adding
this option "all" to get the same data.
A specific
environmental
sensor number*
Displays the information for the specified
environmental sensor only.
* The environmental sensor number is the ID number assigned to the sensor, which can be found on the Peripherals page of
the PRO3X web interface.
Displayed information:
Without the parameter details only the sensor ID, sensor type and reading are displayed.
Note: A state sensor displays the sensor state instead of the reading.