Command Line Interface UPS Network Management Card 2 AP9630, AP9631
This manual is available in English on the APC Web site (www.apc.com). Dieses Handbuch ist in Deutsch auf der APC Webseite (www.apc.com) verfügbar. Este manual está disponible en español en la página web de APC (www.apc.com). Ce manuel est disponible en français sur le site internet d’APC (www.apc.com). Questo manuale è disponibile in italiano sul sito web di APC (www.apc.com). Este manual está disponível em português no site da APC (www.apc.com).
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.
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.
• 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.
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.
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 the Super User password to XYZ: user -n apc -pw XYZ 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.
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.
Option Argument Description The default values for these three settings generally do not need to be changed: -v : APC -i : The MAC address of the NMC, which uniquely identifies it on the network -u : The name of the application firmware module Example: To use a DHCP server to obtain network settings: 1. Type boot -b dhcp 2.
Option Argument Description -rsc 00 | 15 | 30 | 45 | 60 | 75 | 90 Set the minimum battery charge, as a percentage of the total capacity. cfgpower Access: Super User, Administrator, Device User Description: Configure the power parameters: this enables you to show and configure transfer points, sensitivity and output voltage. These options are not available with all UPS devices. Option Argument Description These values can vary with different devices.
Option Argument Description -b 2400 | 9600 | 19200 | 38400 Configure the serial baud rate (9600 by default). Example 1: To enable SSH access to the command line interface, type: console -s Example 2: To change the Telnet port to 5000, type: console -pt 5000 date Access: Super User, Administrator Definition: Configure the date used by the NMC. To configure an NTP server to define the date and time for the NMC, see the User’s Guide.
Example: To delete a file: 1. Navigate to the folder that contains the file. For example, to navigate to the logs folder, type: cd logs 2. To view the files in the logs folder, type: dir 3. Type delete . detstatus Access: Super User, Administrator, Device User Description: View the detailed status of the UPS. See also the -st option in “ups” on page 18. Option Arguments Description -all Show all applicable status information for this UPS. -rt Runtime remaining, in hours and minutes.
Parameter Argument Description -n Set the domain name IPv6. -h Set the hostname. energyWise Access: Super User, Administrator, Device User Description: These options facilitate the use of a Cisco EnergyWise switch to monitor and control your UPS and its devices. This includes turning off the UPS and individual Switched Outlets (if your UPS has them). Parameter Argument Description -e enable | disable Enable or disable EnergyWise. -p Specify a port.
exit Access: Super User, Administrator, Device User Description: Exit from the command line interface session. format Access: Super User, Administrator Description: Reformat the file system of the NMC and erase all security certificates, encryption keys, configuration settings, and the event and data logs. Be careful with this command. To reset the NMC to its default configuration, use the resetToDef command. ftp Access: Super User, Administrator Description: Enable or disable access to the FTP server.
Option Argument Definition -OM enable | disable Override the manual settings. -p Specify the primary server. -s Specify the secondary server. Example 1: To enable the override of manual setting, type: ntp -OM enable Example 2: To specify the primary NTP server, type: ntp -p 150.250.6.10 ping Access: Super User, Administrator, Device User Description. Determine whether the device with the IP address or DNS name you specify is connected to the network.
Description: Configure the command line interface prompt to include or exclude the account type of the currently logged-in user. Any user can change this setting; all user accounts will be updated to use the new setting. Option Argument Description long The prompt includes the account type of the currently logged-in user. short The default setting.
Example 2: To enable RADIUS and local authentication, type: radius -a radiusLocal Example 3: To configure a 10-second timeout for a secondary RADIUS server, type: radius -t2 10 reboot Access: Super User, Administrator Description: Restart the interface of the NMC. resetToDef Access: Super User, Administrator Description: Reset all parameters to their default.
In the table below, n is the access control number: 1,2,3, or 4. Option Arguments Description -S enable | disable Enable or disable SNMPv3. -u[n] -a[n] -c[n] -ap[n] sha | md5 | none Indicate the type of authentication protocol. -pp[n] aes | des | none Indicate the privacy protocol. -ac[n] enable | disable Enable or disable access. -au[n] Give access to a specified user profile.
Option Argument Description -i Type the IP address of the NMC, using the format xxx.xxx.xxx.xxx -s Type the subnet mask for the NMC. -g Type the IP address of the default gateway. Do not use the loopback address (127.0.0.1) as the default gateway. -d Type the DNS name configured by the DNS server. -h Type the host name that the NMC will use. Example 1: To view the network settings of the NMC, type tcpip and press ENTER.
Option Argument Description -disc | , Identify new input contact or output relay connections. | – Example 1: To open the output, type: uio -rc 2 open Example 2: To view the status of the devices connected to a Dry Contact I/O Accessory that is installed in universal input/ output port 2, type: uio -st 2 ups Some ups options are dependant on the UPS model. Not all configurations may support all options of the ups command.
Option Arguments Description Control any of three outlet groups at a Smart-UPS XLM. Specify the outlet group with #. When the state of the outlet group is on, the option accepts three arguments: • Off — Turn off the group immediately. • DelayOff — Turn off the group after the number of seconds configured as Power Off Delay. • Reboot — Turn off the group immediately, then turn it on after the number of seconds configured as Reboot Duration and Power On Delay.
The ups command options for MGE Galaxy-specific UPS devices: These commands are only available on the MGE Galaxy 300 and MGE Galaxy 7000 UPS. Some options may only be available based on the individual UPS model. Option Argument Description | all Display the input measurements for the chosen phase of the UPS. Typing “all” displays the information for all phases of the UPS. voltage | current | frequency | all Specify the input measurement for the ups command.
Option Argument Description View information about the firmware update file present on your NMC, including its name, whether it is compatible with the UPS, and its version. -fileinfo user Access: Super User, Administrator Description: Configure the user name and password for each account type, and configure the inactivity timeout. (You can’t edit a user name, you must delete and then create a new user).
web Access: Super User, Administrator Description: Enable access to the user interface using HTTP or HTTPS. For additional security, you can change the port setting for HTTP and HTTPS to any unused port from 5000 – 32768. Users must then use a colon (:) in the address field of the browser to specify the port number. For example, for a port number of 5000 and an IP address of 152.214.12.114: http://152.214.12.
