APC Command Line Interface Syntax Examples, Italic text with no brackets or braces, Large braces

Page 12

Syntax Examples

Italic text with no brackets or braces.

adduser user_name

For the adduser command, you must specify the name of the user to add (indicated in the syntax by the variable user_name.

Braces and vertical line

pducoldstartdelay {timenever}

For the pducoldstartdelay command, you must enter either a time in seconds (time) that the PDU waits to apply power to its outlets or enter never to specify that the outlets will never turn on automatically when power is applied to the PDU.

Brackets and ellipses

assign outletrange[,outletrange...] user_name

For the assign command, you must specify at least one outlet or range of outlets and the user name of the outlet user to which the outlets are being assigned. Brackets indicate that you can optionally specify another outlet or range to assign to that user, and the ellipses indicates that, optionally, you can specify additional outlets or ranges in the same format.

Large braces

all

on outletrange[,outletrange...]

For the on command, you must enter one of the following:

•The literal value all (to turn on all outlets)

•A comma-delimited list that can include outlets specified by name or number, or ranges of outlet numbers.

8

Command Line Interface (CLI) User’s Guide

Page 11 Page 13
Image 12
Page 11 Page 13
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 OnLog-off procedure Logging OffAutomatic log-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 WhoamiAccess to outlets Outlet OverviewSynchronized outlet groups Outlet Commands OffOff outletrange,outletrange On 1,5-7 On Web ServerWeb Server Outlet turned on 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 secondsStatus Status outletrange,outletrangeOutletnumberoutletstatusoutletname Switched Rack PDU Commands Access All three account types with access to the CLICurrent OK currentAList User outletnumber, outletnumberLowloadwarning phasenumber current LowloadwarningName Name outlet newnameNearoverloadwarning phasenumber NearoverloadwarningNear overload warning threshold is currentA Overloadalarm Overloadalarm phasenumber currentOverloadrestriction phasenumber Overload restriction is setting for phasenumberSetting overload for phasenumber to setting OverloadrestrictionPducoldstartdelay PowerPowerinvolt-ampsVApowerinwattsW General Management Commands ResetdefaultspduExit HelpUploadini Start XMODEM-CRC Transfer NowBytes have successfully been transmitted 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