APC Command Line Interface manual Product Capabilities, Features, Scripting

Page 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 Switched Rack PDUs support the following features that do not have corresponding CLI commands:

Configuration for scheduling

Configuration of synchronized outlet groups

Advanced outlet control commands, such as sequenced on

Event logging, event actions, and other features that are provided through the APC AOS firmware module and that you use for monitoring through the Web interface and control console.

To configure features for which there are not corresponding CLI commands, see “System Requirements” on page 2 and “uploadini” on page 31.

Integration with APC Rack KVM products

You can use the CLI to create scripts to automate the management of your Switched Rack PDUs through the following APC Rack Keyboard, Video, Mouse (KVM) products.

AP5401

AP5405

AP5456

Command Line Interface (CLI) User’s Guide

1

Image 5
Contents User’s Guide Page Contents Index PDU features not supported by the CLI FeaturesProduct Capabilities ScriptingExporting an .ini File System RequirementsFirmware version required Rack PDUs requiredHow to Enter CLI Commands Using the CommandsCLI reports all errors in the following format Command Error CodesCLI Online Help FormatLog-on procedure User Name and PasswordLogging On and Off Logging OnAutomatic log-off Log-off procedureLogging Off Characters and Fonts Command SyntaxItalic text with no brackets or braces Syntax ExamplesBraces and vertical line Brackets and ellipsesTypes of users who can access the CLI Command ReferenceAuthentication of users User Management OverviewAdduser User Management CommandsOutlet assigned to johnreynolds AssignDeluser Deluser usernamePasswd Unassign outletrange,outletrange... username UnassignOutlet 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 Outletnumber outletname Power off delay is time seconds PoweroffdelayOutletnumber outletname Power on delay is time seconds PowerondelayReboot outletrange,outletrange RebootReboot 1,5-7 Reboot Web ServerRebootduration outletrange,outletrange RebootdurationRebootduration outletrange,outletrange...time Outletnumber outletname Reboot duration is time secondsOutletnumberoutletstatusoutletname StatusStatus outletrange,outletrange Access All three account types with access to the CLI Switched Rack PDU CommandsCurrent OK currentAUser outletnumber, outletnumber ListLowloadwarning Lowloadwarning phasenumber currentName Name outlet newnameNear overload warning threshold is currentA Nearoverloadwarning phasenumberNearoverloadwarning Overloadalarm phasenumber current OverloadalarmOverload restriction is setting for phasenumber Overloadrestriction phasenumberSetting overload for phasenumber to setting OverloadrestrictionPowerinvolt-ampsVApowerinwattsW PducoldstartdelayPower Resetdefaultspdu General Management CommandsExit HelpBytes have successfully been transmitted UploadiniStart XMODEM-CRC Transfer Now 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.