APC Command Line Interface manual Contents

Page 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

Using the Commands

3

How to Enter CLI Commands . . . . . . . . . . . . 3

Capitalization in commands and arguments 3 Editing in the CLI . . . . . . . . . . . . . . . . . . . . 3 The Space character as command delimiter 3 Quotation marks and the reverse slant . . . 3

Command Error Codes . . . . . . . . . . . . . . . . . 4

Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

CLI Online Help . . . . . . . . . . . . . . . . . . . . . . 4

Logging On and Off

5

Logging On . . . . . . . . . . . . . . . . . . . . . . . . . 5

User Name and Password . . . . . . . . . . . . . 5 Log-on procedure . . . . . . . . . . . . . . . . . . . 5 Responses to successful and failed log-on .5

Logging Off . . . . . . . . . . . . . . . . . . . . . . . . . 6

Log-off procedure . . . . . . . . . . . . . . . . . . . 6 Automatic log-off . . . . . . . . . . . . . . . . . . . .6

Command Syntax

7

Characters and Fonts . . . . . . . . . . . . . . . . . . 7 Syntax Examples . . . . . . . . . . . . . . . . . . . . . 8

Italic text with no brackets or braces. . . . . . 8 Braces and vertical line . . . . . . . . . . . . . . . 8 Brackets and ellipses . . . . . . . . . . . . . . . . . 8 Large braces . . . . . . . . . . . . . . . . . . . . . . . 8

Command Line Interface (CLI) User’s Guide

i

Page 2 Page 4
Image 3
Page 2 Page 4
Contents User’s Guide Page Contents Index Scripting FeaturesPDU features not supported by the CLI Product CapabilitiesRack PDUs required System RequirementsExporting an .ini File Firmware version requiredHow to Enter CLI Commands Using the CommandsFormat Command Error CodesCLI reports all errors in the following format CLI Online HelpLogging On User Name and PasswordLog-on procedure Logging On and OffLog-off procedure Logging OffAutomatic log-off Characters and Fonts Command SyntaxBrackets and ellipses Syntax ExamplesItalic text with no brackets or braces Braces and vertical lineUser Management Overview Command ReferenceTypes of users who can access the CLI Authentication of usersAdduser User Management CommandsDeluser username AssignOutlet assigned to johnreynolds DeluserPasswd Whoami UnassignUnassign outletrange,outletrange... username Outlet no longer assigned to johnreynoldsAccess to outlets Outlet OverviewSynchronized outlet groups Outlet Commands OffOff outletrange,outletrange On 1,5-7 On Web ServerWeb Server Outlet turned on Outletgroups Outletnumber outletname Power off delay is time seconds PoweroffdelayOutletnumber outletname Power on delay is time seconds PowerondelayReboot Web Server RebootReboot outletrange,outletrange Reboot 1,5-7Outletnumber outletname Reboot duration is time seconds RebootdurationRebootduration outletrange,outletrange Rebootduration outletrange,outletrange...timeStatus Status outletrange,outletrangeOutletnumberoutletstatusoutletname OK currentA Switched Rack PDU CommandsAccess All three account types with access to the CLI CurrentUser outletnumber, outletnumber ListName outlet newname Lowloadwarning phasenumber currentLowloadwarning NameNearoverloadwarning phasenumber NearoverloadwarningNear overload warning threshold is currentA Overloadalarm phasenumber current OverloadalarmOverloadrestriction Overloadrestriction phasenumberOverload restriction is setting for phasenumber Setting overload for phasenumber to settingPducoldstartdelay PowerPowerinvolt-ampsVApowerinwattsW Help General Management CommandsResetdefaultspdu ExitUploadini Start XMODEM-CRC Transfer NowBytes have successfully been transmitted Ver Index On, 16 outletgroups, 17 Outlets Index990-2766 11/2005 APC Worldwide Customer Support

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