APC Command Line Interface manual Index

Page 37

Index

adduser, 10 assign, 11 Automatic log-off,6

bye, 30

Commands adduser, 10 assign, 11 bye, 30 current, 23 deluser, 11 editing the command

line, 3 exit, 30 help, 30 how to enter

commands, 3 list, 24 logoff, 30 logout, 30 lowloadwarning, 25 name, 25 nearoverloadalarm, 26 off, 15

on, 16 outletgroups, 17 overloadalarm, 27 overloadrestriction, 28 passwd, 12 pducoldstartdelay, 29 power, 29 poweroffdelay, 18 powerondelay, 19 quit, 30

reboot, 20

reset_defaults_pdu, 30 status, 22

syntax, 7 unassign, 13 uploadini, 31 ver, 32 whoami, 13

current, 23

deluser, 11

Editing command lines, 3 Error codes, 4

escape character, reverse slant, 3

exit, 30

Features, 1

General management commands, 30

Help, 4, 30

.ini file, exporting, 2

KVM products, integration with, 1

list, 24 Logging on, 5 logoff, 30 logout, 30 lowloadwarning, 25

name, 25 nearoverloadalarm, 26

off, 15

Command Line Interface (CLI) User’s Guide

Image 37

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 OnLogging Off Log-off procedureAutomatic log-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 WhoamiOutlet Overview Access to outletsSynchronized outlet groups Off Outlet CommandsOff outletrange,outletrange On Web Server On 1,5-7Web Server Outlet turned on 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 secondsStatus outletrange,outletrange StatusOutletnumberoutletstatusoutletname Access All three account types with access to the CLI Switched Rack PDU CommandsCurrent OK currentAUser outletnumber, outletnumber ListLowloadwarning Lowloadwarning phasenumber currentName Name outlet newnameNearoverloadwarning Nearoverloadwarning phasenumberNear overload warning threshold is currentA Overloadalarm phasenumber current OverloadalarmOverload restriction is setting for phasenumber Overloadrestriction phasenumberSetting overload for phasenumber to setting OverloadrestrictionPower PducoldstartdelayPowerinvolt-ampsVApowerinwattsW Resetdefaultspdu General Management CommandsExit HelpStart XMODEM-CRC Transfer Now UploadiniBytes 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.