APC Command Line Interface manual Overloadrestriction phasenumber

Page 32

Command Reference: Switched Rack PDU Commands

overloadrestriction

Syntax to read the overload restriction:

overloadrestriction [phase_number]

Syntax to set the overload restriction:

overloadrestriction phase_number setting

Description: When the overload restriction is set to on, the command prevents outlets from turning on while the overload alarm threshold is violated.

•To read the current setting, omit setting in the command line.

•To change the current setting, include the phase number and the new value for setting (on or off) in the command line.

Access: Administrator and device manager (device-only user).

Parameters:

phase_number

The number (1, 2, or 3) of the phase

 

whose overload restriction setting you

 

want to read or set. If you omit the

 

phase number when reading the

 

setting, the command by default reads

 

the setting for phase 1.

setting

The available settings, on and off, are

 

not case-sensitive.

Output Format when reading the setting:

OK

Overload restriction is setting for phase_number.

Output Format when changing the setting:

OK

Setting overload for phase_number to setting.

Error Messages: E101, E104

28

Command Line Interface (CLI) User’s Guide

Page 31 Page 33
Image 32
Page 31 Page 33
Contents User’s Guide Page Contents Index Features PDU features not supported by the CLIProduct Capabilities ScriptingSystem Requirements Exporting an .ini FileFirmware version required Rack PDUs requiredUsing the Commands How to Enter CLI CommandsCommand Error Codes CLI reports all errors in the following formatCLI Online Help FormatUser Name and Password Log-on procedureLogging On and Off Logging OnAutomatic log-off Log-off procedureLogging Off Command Syntax Characters and FontsSyntax Examples Italic text with no brackets or bracesBraces and vertical line Brackets and ellipsesCommand Reference Types of users who can access the CLIAuthentication of users User Management OverviewUser Management Commands AdduserAssign Outlet assigned to johnreynoldsDeluser Deluser usernamePasswd Unassign Unassign outletrange,outletrange... usernameOutlet no longer assigned to johnreynolds WhoamiSynchronized outlet groups Access to outletsOutlet Overview Off outletrange,outletrange Outlet CommandsOff Web Server Outlet turned on On 1,5-7On Web Server Outletgroups Poweroffdelay Outletnumber outletname Power off delay is time secondsPowerondelay Outletnumber outletname Power on delay is time secondsReboot Reboot outletrange,outletrangeReboot 1,5-7 Reboot Web ServerRebootduration Rebootduration outletrange,outletrangeRebootduration outletrange,outletrange...time Outletnumber outletname Reboot duration is time secondsOutletnumberoutletstatusoutletname StatusStatus outletrange,outletrange Switched Rack PDU Commands Access All three account types with access to the CLICurrent OK currentAList User outletnumber, outletnumberLowloadwarning phasenumber current LowloadwarningName Name outlet newnameNear overload warning threshold is currentA Nearoverloadwarning phasenumberNearoverloadwarning Overloadalarm Overloadalarm phasenumber currentOverloadrestriction phasenumber Overload restriction is setting for phasenumberSetting overload for phasenumber to setting OverloadrestrictionPowerinvolt-ampsVApowerinwattsW PducoldstartdelayPower General Management Commands ResetdefaultspduExit HelpBytes have successfully been transmitted UploadiniStart XMODEM-CRC Transfer Now Ver Index Index On, 16 outletgroups, 17 OutletsAPC Worldwide Customer Support 990-2766 11/2005

Command Line Interface specifications

The APC Command Line Interface (CLI) is a powerful tool offered by American Power Conversion (APC) for managing and configuring various APC devices, such as uninterruptible power supplies (UPS), power distribution units (PDUs), and cooling solutions. The CLI enables users to perform a wide range of functions, from monitoring device status to configuring settings and automating tasks, all through a command-line environment. This capability is particularly beneficial for system administrators and IT professionals who prefer scripting and automation to manage their energy infrastructure.

One of the main features of the APC CLI is its comprehensive control over device parameters. Users can retrieve important information like battery status, load levels, and input/output voltages directly through command-line queries. This instant access to critical data allows for more efficient troubleshooting and monitoring of system health. Additionally, the CLI supports historical data retrieval, giving users the ability to analyze performance trends over time.

Another significant technology underlying the APC CLI is SNMP (Simple Network Management Protocol). SNMP allows for seamless integration with network management systems, enabling users to manage APC devices alongside other networked hardware. The CLI’s compatibility with SNMP makes it easier to incorporate APC devices into larger monitoring frameworks, enhancing overall system management.

Security is a vital characteristic of the APC CLI, as it often involves sensitive operational data. The interface typically supports user authentication, ensuring that only authorized personnel can access critical functions. Features like secure SSH (Secure Shell) connections provide encrypted communication channels for remote device management, protecting against unauthorized access and data breaches.

The APC CLI also provides batch processing capabilities, allowing users to execute multiple commands in a single session. This feature is particularly useful for large-scale operations where numerous devices need to be configured or monitored simultaneously. Automated scripts can be created to execute routine tasks, significantly reducing administrative overhead and minimizing the risk of human error.

In conclusion, the APC Command Line Interface stands out as an essential tool for efficient energy management. Its rich feature set, powered by modern technologies like SNMP and strong security protocols, enables comprehensive control over APC devices. With automation capabilities and real-time data access, the APC CLI is indispensable for IT professionals aiming to optimize their power management strategies and ensure system reliability.
Top Page Image Contents