Command Line Interface - Schneider Electric
[Pages:25]Command Line Interface
UPS Network Management Card 2
AP9630, AP9631
This manual is available in English on the APC Web site ().
Dieses Handbuch ist in Deutsch auf der APC Webseite () verf?gbar. Este manual est? disponible en espa?ol en la p?gina web de APC (). Ce manuel est disponible en fran?ais sur le site internet d'APC (). Questo manuale ? disponibile in italiano sul sito web di APC (). Este manual est? dispon?vel em portugu?s no site da APC (). APC ( )
APC ()
APC () . APC ()
This manual is available in English on the enclosed CD. Dieses Handbuch ist in Deutsch auf der beiliegenden CD-ROM verf?gbar. Este manual est? disponible en espa?ol en el CD-ROM adjunto. Ce manuel est disponible en fran?ais sur le CD-ROM ci-inclus. Questo manuale ? disponibile in italiano nel CD-ROM allegato. Este manual est? dispon?vel em portugu?s no CD fornecido. -. CD-ROM
CD .
CD
Command Line Interface (CLI)
How To Log On
Overview
To access the command line interface, you can use either a local, serial connection, or a remote connection (Telnet or SSH) with a computer on the same network as the Network Management Card (NMC).
Use case-sensitive user name and password entries to log on (by default, apc and apc for a Super User, or device and apc for a Device User). A Read-Only User cannot access the command line interface.
See the UPS Network Management Card 2 User's Guide (for AP9630, AP9631) for more information on these options.
If you cannot remember your user name or password, see "How to Recover from a Lost Password" in the User's Guide.
Remote access to the command line interface
You can access the command line interface through Telnet or SSH. Telnet is enabled by default. Enabling SSH disables Telnet.
To enable or disable these access methods, use the Web interface. On the Configuration menu, select Network - Console.
Telnet for basic access. Telnet provides the basic security of authentication by user name and password, but not the high-security benefits of encryption.
To use Telnet to access the command line interface:
1. From a computer that has access to the network on which the NMC is installed, at a command prompt, type telnet and the IP address for the NMC (for example, telnet 139.225.6.133, when the NMC uses the default Telnet port of 23), and press ENTER.
If the NMC uses a non-default port number (from 5000 to 32768), you must include a colon or a space, depending on your Telnet client, between the IP address (or DNS name) and the port number. (These are commands for general usage: some clients don't allow you to specify the port as an argument and some types of Linux might want extra commands).
2. Enter the user name and password (by default, apc and apc for a Super User, or device and apc for a Device User).
SSH for high-security access. If you use the high security of SSL for the Web interface, use SSH for access to the command line interface. SSH encrypts user names, passwords, and transmitted data. The interface, user accounts, and user access rights are the same whether you access the command line interface through SSH or Telnet, but to use SSH, you must first configure SSH and have an SSH client program installed on your computer.
UPS Network Management Card 2 CLI
1
Local access to the command line interface
For local access, use a computer that connects to the Network Management Card through the serial port to access the command line interface:
1. Select a serial port at the computer and disable any service that uses the port. 2. Connect the provided serial cable (part number 940-0299) from the selected port on the computer to the
configuration port at the NMC. 3. Run a terminal program (e.g., HyperTerminal), and configure the selected port for 9600 bps, 8 data bits,
no parity, 1 stop bit, and no flow control. 4. Press ENTER. At the prompts, enter your user name and password.
Main Screen
Sample main screen
Following is an example of the screen displayed when you log on to the command line interface at the Network Management Card (NMC).
American Power Conversion
Network Management Card AOS vx.x.x
(c)Copyright 2013 All Rights Reserved Symmetra APP
vx.x.x
--------------------------------------------------------------------------
Name
: Test Lab
Date : 10/30/2010
Contact : Don Adams
Time : 5:58:30
Location : Building 3
User : Super User
Up Time : 0 Days, 21 Hours, 21 Minutes
Stat : P+ N+ A+
APC>
Information and status fields
Main screen information fields.
? Two fields identify the American Power Conversion operating system (AOS) and application (APP) firmware versions. The application firmware name identifies the device that connects to the network through this NMC. In the example above, the NMC uses the application firmware for a Symmetra UPS.
Network Management Card AOS Symmetra APP
vx.x.x vx.x.x
? Three fields identify the system name, contact person, and location of the NMC.
Name : Test Lab Contact: Don Adams Location: Building 3
UPS Network Management Card 2 CLI
2
? The Up Time field reports how long the NMC has been running since it was last turned on or reset.
Up Time: 0 Days 21 Hours 21 Minutes
? Two fields report when you logged in, by date and time.
Date : 10/30/2009 Time : 5:58:30
? The User field reports whether you logged in through the Super User or Device Manager account. (The Read Only User account cannot access the command line interface.) When you log on as Device Manager (equivalent to Device User in the user interface), you can access the event log, configure some UPS settings, and view the number of active alarms.
User : Super User
Main screen status fields.
? The Stat field reports the NMC status. The middle status varies according to whether you are running IPv4, IPv6, or both, as indicated in the second table below.
Stat : P+ N+ A+
P+
The operating system (AOS) is functioning properly.
IPv4 IPv6 IPv4 and
only only
IPv6*
Description
N+ N6+ N4+ N6+ The network is functioning properly.
N? N6? N4? N6? A BOOTP request cycle is in progress.
N? N6? N4- N6- The NMC did not connect to the network.
N!
N6!
N4! N6!
Another device is using the IP address of the NMC.
* The N4 and N6 values can be different from one another: you could, for example, have N4? N6+.
A+
The application is functioning properly.
A?
The application has a bad checksum.
A?
The application is initializing.
A!
The application is not compatible with the AOS.
If P+ is not displayed, see customer support at .
UPS Network Management Card 2 CLI
3
How to Use the Command Line Interface
Overview
The command line interface provides options to configure the network settings and manage the UPS and its Network Management Card (NMC).
How to enter commands
At the command line interface, use commands to configure the NMC. To use a command, type the command and press ENTER. Commands and arguments are valid in lowercase, uppercase, or mixed case. Options are case-sensitive.
While using the command line interface, you can also do the following:
? Type ? and press ENTER to view a list of available commands, based on your account type.
To obtain information about the purpose and syntax of a specified command, type the command, a space, and ? or the word help. For example, to view RADIUS configuration options, type:
radius ?
or
radius help
? Press the UP arrow key to view the command that was entered most recently in the session. Use the UP and DOWN arrow keys to scroll through a list of up to ten previous commands.
? Type at least one letter of a command and press the TAB key to scroll through a list of valid commands that match the text you typed in the command line.
? Type ups -st to view the status of the UPS.
? Type exit or quit to close the connection to the command line interface.
Command syntax
Item Description
-
Options are preceded by a hyphen.
< >
The definitions of options are enclosed in angle brackets. For example: -pw
[ ]
If a command accepts multiple options or an option accepts mutually exclusive arguments, the values may be enclosed in brackets.
|
A vertical line between items enclosed in brackets or angle brackets indicates that the items are mutually exclusive. You must use one of the items.
UPS Network Management Card 2 CLI
4
Syntax examples
A command that supports multiple options: user -n -pw
Here, the user command accepts both the option -n, which specifies the user name, and the option -pw, which changes the password. For example, to change a password to XYZ:
user -n apc -pw XYZ
Note that Super User also requires the current password, see the "user" section. A command that accepts mutually exclusive arguments for an option:
alarmcount -p [all | warning | critical]
In this example, the option -p accepts only three arguments: all, warning, or critical. For example, to view the number of active critical alarms, type:
alarmcount -p critical
The command will not work if you type an argument that is not specified.
Command Response Codes
The command response codes enable scripted operations to detect error conditions reliably without having to match error message text.
The CLI reports all command operations with the following format:
E [0?9][0?9][0?9]: Error message
Code
E000 E001
E002
E100 E101 E102 E103 E104 E105 E106
E107
Error message
Success Successfully Issued Reboot required for change to take effect Command failed Command not found Parameter Error Command Line Error User Level Denial Command Prefill Data Not Available Serial communication with the UPS has been lost
UPS Network Management Card 2 CLI
5
Command Descriptions
The availability of the commands and options below can vary between UPS devices.
?
Access: Super User, Administrator, Device User Description: View a list of all the CLI commands available to your account type. To view help text for a specific command, type the command followed by a question mark. Example: To view a list of options that are accepted by the alarmcount command, type:
alarmcount ?
about
Access: Super User, Administrator, Device User Description: View hardware and firmware information. This information is useful in troubleshooting and enables you to determine if updated firmware is available at the website.
alarmcount
Access: Super User, Administrator, Device User Description:
Option
-p
Arguments
all warning critical
Description
View the number of active alarms reported by the NMC. Information about the alarms is provided in the event log. View the number of active warning alarms. View the number of active critical alarms.
Example: To view all active warning alarms, type:
alarmcount -p warning
boot
Access: Super User, Administrator
Description: Define how the NMC will obtain its network settings, including the IP address, subnet mask, and default gateway. Then configure the BOOTP or DHCP server settings.
Option Argument
Description
-b
-c
dhcp | bootp | manual
enable | disable
Define how the TCP/IP settings will be configured when the NMC turns on, resets, or restarts.
dhcp boot modes only. Enable or disable the requirement that the DHCP server provide the APC cookie.
UPS Network Management Card 2 CLI
6
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related download
- reset the password of the admin user on a cisco firepower system
- using the cisco ios command line interface
- switch quick configuration cli guide for supermicro
- using the command line interface cli hp
- vrealize network insight command line interface guide
- forcepoint appliances command line interface cli guide websense
- using the ise command line interface cisco
- using the command line interface cisco
- cli reference guide audiocodes
- advanced console system command reference guide
Related searches
- command line to reset password
- powershell command line switches
- powershell run command line exe
- run command line from powershell
- command line pdf
- windows command line tutorial pdf
- windows 10 command line reference
- powershell command line switch parameter
- linux command line pdf
- command line reference online help
- command line reference windows 10
- command line prompts