APC Essential CLI Commands for Network Management

Page 34

General Management Commands

exit

Syntax:

{exitlogoutlogoffquitbye} Description: Exit from the CLI interface. Parameters: None.

Output Format:

OK

Bye.

Error Message: E101

help

Syntax:

help? [command]

Description: Obtain help on CLI commands

Parameter:

command

The name of the command for which help will be provided. If you omit command, the output consists of a list of all the CLI commands available and applicable to your account type.

Output format: command-specific help:

OK

command_syntax help_text

Output format: list of available commands:

OK

command: command: command: command

Error Message: E101

reset_defaults_pdu

Syntax:

reset_defaults_pdu

Description: Resets only the configuration parameters specific to the Switched Rack PDU and its outlets to their default settings.

Access: Administrator only

Parameters: None.

Output Format:

OK

Resetting PDU and outlet configurations to defaults.

Error Messages: E101, E104

30

Command Line Interface (CLI) User’s Guide

Image 34
Contents User’s Guide Page Contents Index Product Capabilities FeaturesPDU features not supported by the CLI ScriptingFirmware version required System RequirementsExporting an .ini File Rack PDUs requiredUsing the Commands How to Enter CLI CommandsCLI Online Help Command Error CodesCLI reports all errors in the following format FormatLogging On and Off User Name and PasswordLog-on procedure Logging OnLogging Off Log-off procedureAutomatic log-off Command Syntax Characters and FontsBraces and vertical line Syntax ExamplesItalic text with no brackets or braces Brackets and ellipsesAuthentication of users Command ReferenceTypes of users who can access the CLI User Management OverviewUser Management Commands AdduserDeluser AssignOutlet assigned to johnreynolds Deluser usernamePasswd Outlet no longer assigned to johnreynolds UnassignUnassign outletrange,outletrange... username WhoamiOutlet Overview Access to outletsSynchronized outlet groups Off Outlet CommandsOff outletrange,outletrange On Web Server On 1,5-7Web Server Outlet turned on Outletgroups Poweroffdelay Outletnumber outletname Power off delay is time secondsPowerondelay Outletnumber outletname Power on delay is time secondsReboot 1,5-7 RebootReboot outletrange,outletrange Reboot Web ServerRebootduration outletrange,outletrange...time RebootdurationRebootduration outletrange,outletrange Outletnumber outletname Reboot duration is time secondsStatus outletrange,outletrange StatusOutletnumberoutletstatusoutletname Current Switched Rack PDU CommandsAccess All three account types with access to the CLI OK currentAList User outletnumber, outletnumberName Lowloadwarning phasenumber currentLowloadwarning Name outlet newnameNearoverloadwarning Nearoverloadwarning phasenumberNear overload warning threshold is currentA Overloadalarm Overloadalarm phasenumber currentSetting overload for phasenumber to setting Overloadrestriction phasenumberOverload restriction is setting for phasenumber OverloadrestrictionPower PducoldstartdelayPowerinvolt-ampsVApowerinwattsW Exit General Management CommandsResetdefaultspdu HelpStart XMODEM-CRC Transfer Now UploadiniBytes 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.