Schneider Electric AP9630, AP9631 User Manual

User’s Guide

UPS Network

Management Card 2

AP9630, AP9631

(www.apc.com)

This manual is available in English on the Web site (www.apc.com).

Dieses Handbuch ist in Deutsch auf der Webseite (www.apc.com) verfügbar. Este manual está disponible en español en la página web (www.apc.com). Ce manuel est disponible en français sur le site internet (www.apc.com). Questo manuale è disponibile in italiano sul sito web (www.apc.com).

Este manual está disponível em português no site (www.apc.com).

Данное руководство на русском языке доступно на сайте (www.apc.com )

(www.apc.com)

(www.apc.com) .

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

Introduction

Product Description

Features

The two Schneider Electric UPS Network Management Cards (NMC) mentioned

below are Web-based, IPv6 Ready products that manage supported devices using multiple open standards such as:

- Hypertext Transfer Protocol (HTTP)	- Secure SHell (SSH)
- Simple Network Management Protocol	- Hypertext Transfer Protocol over Secure
versions 1 and 3 (SNMPv1, SNMPv3)	Sockets Layer (HTTPS)
- File Transfer Protocol (FTP)	- Secure Copy (SCP)
- Telnet

The AP9630 Network Management Card 2:

•Provides UPS control and self-test scheduling features

•Provides data and event logs

•Provides support for the PowerChute® Network Shutdown utility

•Supports using a Dynamic Host Configuration Protocol (DHCP) or BOOTstrap Protocol (BOOTP) server to provide the network (TCP/IP) values of the NMC

•Supports using the Remote Monitoring Service (RMS)

•Enables you to configure notification through event logging (by the NMC and Syslog), e-mail, and SNMP traps. You can configure notification for single events or groups of events, based on the severity level or category of events

•Provides the ability to export a user configuration (.ini) file from a configured card to one or more unconfigured cards without converting the file to a binary file

•Provides a selection of security protocols for authentication and encryption

•Communicates with InfraStruxure® Central or InfraStruxure Manager

The AP9631 Network Management Card includes all AP9630 Network Management Card features and the following:

•Provides two USB ports

•Supports two universal input/ output ports, to which you can connect:

–Temperature (AP9335T) or temperature/humidity sensors (AP9335TH)

–Relay input/output connectors that support two input contacts and one output relay (using AP9810 Dry Contact I/O Accessory)

UPS Network Management Card 2 User’s Guide

1

Devices in which you can install the Network Management Card 2. The NMC can be installed in:

•Any Smart-UPS® model that has an internal expansion slot, or any Symmetra® UPS except the Symmetra PX 250 or Symmetra PX 500 UPS

•MGE® Galaxy® 300, 3500, or 7000

•Expansion Chassis (AP9600)

•Triple Expansion Chassis (AP9604)

IPv4 initial setup

You must define two TCP/IP settings for the NMC before it can operate on the network:

•IP address of the NMC

•IP address of the default gateway (only needed if you are going off segment)

Caution: Do not use the loopback address (127.0.0.1) as the default gateway. Doing so disables the card. You must then log on using a serial connection and reset the TCP/IP settings to their defaults.

To configure the TCP/IP settings, see the Network Management Card Installation Manual, available on the Network Management Card Utility CD and in printed form.

For detailed information on how to use a DHCP server to configure the TCP/IP settings at an NMC, see “TCP/IP and Communication Settings” on page 54.

IPv6 initial setup

IPv6 network configuration provides flexibility to accommodate the user's requirements. To configure the TCP/IP settings for IPv6, see the user interface online help for details on the options: Manual, Auto Configuration, DHCPv6 Mode under this menu: Administration > Network > TCP/IP > IPv6 settings.

Network management features

These applications and utilities work with a UPS that connects to the network through an NMC.

•PowerChute Network Shutdown — Provide unattended remote graceful shutdown of computers that are connected to UPS devices

•PowerNet® Management Information Base (MIB) with a standard MIB browser — Perform SNMP SETs and GETs and use SNMP traps

•InfraStruxure Central — Provide enterprise-level power management and management of agents, UPS devices, and environmental monitors.

•Device IP Configuration Wizard — Configure the basic settings of one or more NMCs over the network

•Security Wizard — Create components needed for high security for the NMC when you are using Secure Sockets Layer (SSL) and related protocols and encryption routines

2	UPS Network Management Card 2 User’s Guide

Internal Management Features

Overview

Use the user interface or the command line interface to view the status of the UPS and manage the UPS and the NMC. You can also use SNMP to monitor the status of the UPS.

For more information about the internal user interfaces, see “Web User Interface” on page 28 and “Command Line Interface (CLI)” on page 8. See “SNMP” on page 58 for information about how SNMP access to the NMC is controlled.

Access priority for logging on

Only one user at a time can log on to the Network Management Card. The priority for access, beginning with the highest priority, is as follows:

1.Local access to the command line interface from a computer with a direct serial connection to the Management Card

2.Telnet or SSH access to the command line interface from a remote computer

3.Web access, either directly or through InfraStruXure Central

Note: SNMP has Write + and Write access. Write + has top access and enables logging on when another user is already logged on. Write access is equivalent to Web access.

Types of user accounts

The NMC has three levels of access — Administrator, Device User, and Read-Only User — and these are protected by user name and password requirements.

•An Administrator can use all of the menus in the user interface and all of the commands in the command line interface. The default user name and password are both apc.

•A Device User can access only the following:

–In the user interface, recent events on the Home tab; the menus on the UPS tab; and the menus of the Logs tab including the event and data logs, accessible under the Events and Data headings. (The event and data logs display no button for this user to clear the log).

–In the command line interface, the equivalent features and options.

The default user name is device, and the default password is apc.

•A Read-Only User has the following restricted access:

–Access through the user interface only.

–Access to the same tabs and menus as a Device User above, but without the capability to change configurations, control devices, delete data, or use file transfer options. Links to configuration options are visible but disabled. (The event and data logs display no button for this user to clear the log).

The default user name is readonly, and the default password is apc.

To set User Name and Password values for the three account types, see “Setting user access” on page 51.

UPS Network Management Card 2 User’s Guide

3

How to Recover from a Lost Password

You can use a local computer that connects to the Management Card through the serial port to access the command line interface.

1.Select a serial port at the local computer, and disable any service that uses that port.

2.Connect the provided serial cable (part number 940-0299) to the selected port at the computer and to the configuration port at the Management Card.

3.Run a terminal program (such as HyperTerminal®) and configure the selected port for 9600 bps, 8 data bits, no parity, 1 stop bit, and no flow control.

4.Press ENTER, repeatedly if necessary, to display the User Name prompt. If you are unable to display the User Name prompt, verify the following:

–The serial port is not in use by another application.

–The terminal settings are correct as specified in step 3.

–The correct cable is being used as specified in step 2.

5.Press the Reset button. The Status LED will flash alternately orange and green. Press the Reset button a second time immediately while the LED is flashing to reset the user name and password to their defaults temporarily.

6.Press ENTER, repeatedly if necessary, to display the User Name prompt again, then use the default, apc, for the user name and password. (If you take longer than 30 seconds to log on after the User Name prompt is redisplayed, you must repeat step 5 and log on again.)

7.At the command line interface, use the following commands to change the User Name and Password settings, both of which are now apc:

user -an yourAdministratorName

user -ap yourAdministratorPassword

For example, to change the Administrator user name to Admin, type:

user -an Admin

8.Type quit or exit to log off, reconnect any serial cable you disconnected, and restart any service you disabled.

4	UPS Network Management Card 2 User’s Guide

Front Panel (AP9630)

Features

	Item	Description
1	Serial configuration port	Connects the NMC to a local computer to configure initial network
		settings or access the command line interface.
2	10/100 Base-T connector	Connects the NMC to the Ethernet network.
3	Reset button	Resets the NMC while power remains on.
4	Link-RX/TX (10/100) LED	See “Link-RX/TX (10/100) LED” on page 6.
5	Status LED	See “Status LED” on page 6.

Front Panel (AP9631)

d m p 0 0 9 9 a

Features

	Item	Description
1	USB ports	Reserved for future use.
2		Connect temperature sensors, temperature/humidity sensors, or
3	Sensor ports	relay input/output connectors that support two input contacts and
		one output relay.
4	10/100 Base-T connector	Connects the NMC to the Ethernet network.

UPS Network Management Card 2 User’s Guide

5

	Item	Description
5	Reset button	Resets the NMC while power remains on.
6	Serial configuration port	Connects the NMC to a local computer to configure initial network
		settings or access the command line interface.
7	Link-RX/TX (10/100) LED	See “Link-RX/TX (10/100) LED” on page 6.
8	Status LED	See “Status LED” on page 6.

LED Descriptions

Status LED

This LED indicates the status of the NMC.

	Condition	Description
		One of the following situations exists:
	Off	• The NMC is not receiving input power.
		• The NMC is not operating properly. It may need to be repaired or replaced. Contact
		Customer Support. See “APC Worldwide Customer Support” on page 89.
	Solid green	The NMC has valid TCP/IP settings.
	Solid orange	A hardware failure has been detected in the NMC. Contact Customer Support. See
		“APC Worldwide Customer Support” on page 89.
	Flashing green	The NMC does not have valid TCP/IP settings.1
	Flashing orange	The NMC is making BOOTP requests.1
	Alternately flashing	If the LED is flashing slowly, the NMC is making DHCP2 requests.1
	green and orange	If the LED is flashing rapidly, the NMC is starting up.
	1. If you do not use a BOOTP or DHCP server, see the Network Management Card Installation Manual provided in
	printed format and on the Network Management Card Utility CD in PDF to configure the TCP/IP settings of the
	NMC.
	2. To use a DHCP server, see “TCP/IP and Communication Settings” on page 54.
	Link-RX/TX (10/100) LED
	This LED indicates the network status of the NMC.

	Condition	Description
		One or more of the following situations exist:
		• The NMC is not receiving input power.
	Off	• The cable that connects the NMC to the network is disconnected or defective.
		• The device that connects the NMC to the network is turned off or not operating
		correctly.
	Off (continued)	• The NMC itself is not operating properly. It may need to be repaired or replaced.
		Contact Customer Support. See “APC Worldwide Customer Support” on page 89.
	Solid green	The NMC is connected to a network operating at 10 Megabits per second (Mbps).
	Solid orange	The NMC is connected to a network operating at 100 Mbps.

6	UPS Network Management Card 2 User’s Guide

Condition	Description
Flashing green	The NMC is receiving or transmitting data packets at 10 Mbps.
Flashing orange	The NMC is receiving or transmitting data packets at 100 Mbps.

Watchdog Features

Overview

To detect internal problems and recover from unanticipated inputs, the Management Card uses internal, system-wide watchdog mechanisms. When it restarts to recover from an internal problem, a System: Network Interface restarted event is recorded in the event log.

Network interface watchdog mechanism

The Management Card implements internal watchdog mechanisms to protect itself from becoming inaccessible over the network. For example, if the Management Card does not receive any network traffic for 9.5 minutes (either direct traffic, such as SNMP, or broadcast traffic, such as an Address Resolution Protocol [ARP] request), it assumes that there is a problem with its network interface and restarts.

Resetting the network timer

To ensure that the Management Card does not restart if the network is quiet for 9.5 minutes, the Management Card attempts to contact the default gateway every 4.5 minutes. If the gateway is present, it responds to the Management Card, and that response restarts the 9.5-minute timer. If your application does not require or have a gateway, specify the IP address of a computer that is running on the network and is on the same subnet. The network traffic of that computer will restart the 9.5-minute timer frequently enough to prevent the Management Card from restarting.

UPS Network Management Card 2 User’s Guide

7

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 an Administrator, or device and apc for a Device User). A Read-Only User cannot access the command line interface.

If you cannot remember your user name or password, see “How to Recover from a Lost Password” on page 4.

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 Administration tab, select Network on the top menu bar, and then the access option under Console on the left navigation menu.

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 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 an Administrator, 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.

8	UPS Network Management Card 2 User’s Guide

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).

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	vx.x.x
Symmetra APP	vx.x.x

•Three fields identify the system name, contact person, and location of the NMC. (In the user interface, select the Administration tab, General in the top menu bar, and Identification in the left navigation menu to set these values.)

Name : Test Lab

Contact: Don Adams

Location: Building 3

•The Up Time field reports how long the NMC has been running since it was last turned on or reset.

UPS Network Management Card 2 User’s Guide

9

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 Administrator 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 : Administrator

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–		N4N6-	The NMC failed to 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, contact Customer Support. See “APC Worldwide Customer Support” on page 89.

10	UPS Network Management Card 2 User’s Guide

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.
	< >	Definitions of options are enclosed in angle brackets. For example:
		-dp <device password>
	[ ]	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 User’s Guide

11

Syntax examples

A command that supports multiple options:

user [-an <admin name>] [-ap <admin password>]

In this example, the user command accepts the option -an, which defines the Administrator user name, and the option -ap, which defines the Administrator password. To change the Administrator user name and password to XYZ:

1.Type the user command, one option, and the argument XYZ: user -ap XYZ

2.After the first command succeeds, type the user command, the second option, and the argument XYZ: user -an 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. For example, to view the number of active critical alarms, type:

alarmcount -p critical

The command will fail 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	Error message
	E000	Success
	E001	Successfully Issued
	E002	Reboot required for change
		to take effect
	E100	Command failed
	E101	Command not found
	E102	Parameter Error
	E103	Command Line Error
	E104	User Level Denial
	E105	Command Prefill
	E106	Data Not Available
	E107	Serial communication with the
		UPS has been lost

12	UPS Network Management Card 2 User’s Guide

Command Descriptions

The availability of the commands and options below can vary between UPS devices.

?

Access: 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: 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: Administrator, Device User

Description:

	Option	Arguments	Description
		all	View the number of active alarms reported by the NMC. Information about the
			alarms is provided in the event log.
	-p
		warning	View the number of active warning alarms.
		critical	View the number of active critical alarms.

Example: To view all active warning alarms, type:

alarmcount -p warning

boot

Access: Administrator only

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	dhcp | bootp |	Define how the TCP/IP settings will be configured when the NMC turns on,
	<boot		resets, or restarts. See “TCP/IP and Communication Settings” on page 54 for
		manual
	mode>		information about each boot mode setting.
	-c	enable | disable	dhcp boot modes only. Enable or disable the requirement that the DHCP
			server provide the APC cookie.

The default values for these three settings generally do not need to be changed: -v <vendor class>: APC

-i <client id>: The MAC address of the NMC, which uniquely identifies it on the network -u <user class>: The name of the application firmware module

UPS Network Management Card 2 User’s Guide

13

Example: To use a DHCP server to obtain network settings:

1.Type boot -b dhcp

2.Enable the requirement that the DHCP server provide the APC cookie: boot -c enable

cd

Access: Administrator, Device User

Description: Navigate to a folder in the directory structure of the NMC.

Example 1: To change to the ssh folder and confirm that an SSH security certificate was uploaded to the

NMC:

1.Type cd ssh and press ENTER.

2.Type dir and press ENTER to list the files stored in the SSH folder.

Example 2: To return to the main directory folder, type:

cd ..

cfgshutdn

Access: Administrator only, Device User

Description: Configure the shutdown parameters: this enables you to show and configure UPS Shutdown Delay, UPS Return Delay, UPS Low Battery Duration, UPS Sleep Time, and UPS Min Return Runtime.

These options are not available with all UPS devices.

	Option	Argument		Description
	-all			Show all applicable shutdown parameters for this UPS.
		000	| 090 | 180 |
	-sd	270	| 360 | 450 |	Set the shutdown delay in seconds.
		540	| 630
	-lo	02 | 05 | 08 | 11 | 14		Set the low battery duration in minutes.
		| 17 | 20 | 23
		000	| 060 | 120 |	Set the UPS return delay in seconds, that is, the delay time before the UPS
	-rd	180	| 240 | 300 |
				turns on again.
		360	| 420
	-rrt	0–3600		Set the minimum return runtime in seconds, that is, the battery runtime to
				support the load must reach this value before the UPS turns on again.
	-sl	0.0–359.9		Set the sleep time, in hours. The argument can have any number between 0.0
				and 359.9.
	-rsc	00 | 15 | 30 | 45 | 60		Set the minimum battery charge, as a percentage of the total capacity.
		| 75 | 90

cfgpower

Access: Administrator only, Device User

14	UPS Network Management Card 2 User’s Guide

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.
	-all			Show all applicable power parameters for this UPS.
	-l	97–106		Set the low transfer point, in VAC.
	-h	127–136		Set the high transfer point, in VAC.
	-ov	100	| 120 | 110 |	Set the outlet voltage, in VAC.
	-s	Normal |		Set the sensitivity, using one of the three arguments.
		Reduced | Low
		127	| 130 | 133 |	Set the bypass upper voltage in VAC; when the voltage rises above this value,
	-bu	136	| 139 | 142 |
				the device goes into bypass.
		145	| 148
		086	| 088 | 090 |	Set the bypass lower voltage in VAC; when the voltage drops below this
	-bl	092	| 094 | 096 |
				value, the device goes into bypass.
		098	| 100

console

Access: Administrator only

Description: Define whether users can access the command line interface using Telnet, which is enabled by default, or Secure SHell (SSH), which provides protection by transmitting user names, passwords, and data in encrypted form. You can change the Telnet or SSH port setting for additional security. Alternately, disable network access to the command line interface.

	Option	Argument	Description
	-S	disable | telnet | ssh	Configure access to the command line interface, or use the disable
			command to prevent access. Enabling SSH enables SCP and disables Telnet.
	-pt	<telnet port n>	Define the Telnet port used to communicate with the NMC (23 by default).
	-ps	<SSH port n>	Define the SSH port used to communicate with the NMC (22 by default).
	-b	2400 | 9600 | 19200	Configure the speed of the serial port connection (9600 bps by default).
		| 38400

Example 1: To enable SSH access to the command line interface, type:

console -S ssh

Example 2: To change the Telnet port to 5000, type:

console -pt 5000

date

Access: Administrator only

Definition: Configure the date used by the NMC.

UPS Network Management Card 2 User’s Guide

15

To configure an NTP server to define the date and time for the NMC, see “Set the Date and Time” on page 68.

	Option	Argument	Description
	-d	<“datestring”>	Set the current date. Use the date format specified by the date -f command.
	-t	<00:00:00>	Configure the current time, in hours, minutes, and seconds. Use the 24-hour
			clock format.
		mm/dd/yy |
		dd.mm.yyyy |	Select the numerical format in which to display all dates in this user interface.
	-f	mmm-dd-yy |	Each letter m (for month), d (for day), and y (for year) represents one digit.
		dd-mmm-yy |	Single-digit days and months are displayed with a leading zero.
		yyyy-mm-dd
	-z	<time zone	Set the difference with GMT in order to specify your time zone. This enables you
		offset>	to synchronize with other people in different time zones.

Example 1: To display the date using the format yyyy-mm-dd, type:

date -f yyyy-mm-dd

Example 2: To define the date as October 30, 2009, using the format configured in the preceding example, type:

date -d “2009-10-30”

Example 3: To define the time as 5:21:03 p.m., type:

date -t 17:21:03

delete

Access: Administrator only

Description: Delete a file in the file system. (To delete the event log, see “eventlog,” beginning on page ).

Argument Description

<file name>

Type the name of the file to delete.

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 <file name>.

detstatus

Access: Administrator, Device User

Description: View the detailed status of the UPS. See also the -st option in “ups” on page 23.

Option	Arguments	Description
-all		Show all applicable status information for this UPS.

16	UPS Network Management Card 2 User’s Guide

Option	Arguments	Description
-rt		Runtime remaining, in hours and minutes.
-ss		UPS status summary: on line, on battery, etc.
-soc		UPS battery charge, as a percentage of the total capacity.
-om		Output measurements: voltage, frequency, watts percentage, VA
		percentage, current.
-im		Input measurements: voltage and frequency.
-bat		Battery voltage
-tmp		Internal temperature of the UPS
-dg		Diagnostic test results: self-test result and date, calibration result
		and date.

dir

Access: Administrator, Device User

Description: View the files and folders stored on the NMC.

dns

Access: Administrator

Description: Configure the manual Domain Name System (DNS) settings.

	Parameter	Argument	Description
	-OM	enable | disable	Override the manual DNS.
	-p	<primary DNS	Set the primary DNS server.
		server>
	-s	<secondary DNS	Set the secondary DNS server.
		server>
	-d	<domain name>	Set the domain name.
	-n	<domain name	Set the domain name IPv6.
		IPv6>
	-h	<host name>	Set the host name.

eventlog

Access: Administrator, Device User

Description: View the date and time you retrieved the event log, the status of the UPS, and the status of sensors connected to the NMC. View the most recent device events, and the date and time they occurred. Use the following keys to navigate the event log:

Key Description

ESC	Close the event log and return to the command line interface.

Update the log display. Use this command to view events that were recorded after you last

ENTER

retrieved and displayed the log.

UPS Network Management Card 2 User’s Guide

17

Key Description

SPACEBAR View the next page of the event log.

B

View the preceding page of the event log. This command is not available at the main page of the event log.

D

Delete the event log. Follow the prompts to confirm or deny the deletion. Deleted events cannot be retrieved.

exit

Access: Administrator, Device User

Description: Exit from the command line interface session.

format

Access: Administrator only

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: Administrator only

Description: Enable or disable access to the FTP server. Optionally, change the port setting to the number of any unused port from 5001 to 32768 for added security.

Option	Argument	Definition
		Define the TCP/IP port that the FTP server uses to communicate with the NMC
-p	<port number>	(21 by default). The FTP server uses both the specified port and the port one
		number lower than the specified port.
-S	enable | disable	Configure access to the FTP server.

Example: To change the TCP/IP port to 5001, type:

ftp -p 5001

help

Access: 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 help.

Example 1: To view a list of commands available to someone logged on as a Device User, type:

help

Example 2: To view a list of options that are accepted by the alarmcount command, type:

alarmcount help

netstat

Access: Administrator, Device User

18	UPS Network Management Card 2 User’s Guide

Description: View the status of the network and all active IPv4 and IPv6 addresses.

ntp

Access: Administrator, Device User

Description: View and configure the network time protocol parameters.

Option	Argument	Definition
-OM	enable | disable	Override the manual settings.
-p	<primary NTP server>	Specify the primary server.
-s	<secondary NTP server>	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: Administrator, Device User

Description. Determine whether the device with the IP address or DNS name you specify is connected to the network. Four inquiries are sent to the address.

Argument

Description

<IP address or DNS name>

Type an IP address with the format xxx.xxx.xxx.xxx, or the DNS name configured by the DNS server.

Example: To determine whether a device with an IP address of 150.250.6.10 is connected to the network, type:

ping 150.250.6.10

portspeed

Access: Administrator

Description:

	Option	Arguments	Description
			Define the communication speed of the Ethernet port. The auto command
	-s	auto | 10H | 10F |	enables the Ethernet devices to negotiate to transmit at the highest possible
		100H | 100F	speed. See “Port Speed” on page 55 for more information about the port speed
			settings.

Example: To configure the TCP/IP port to communicate using 100 Mbps with half-duplex communication (communication in only one direction at a time), type:

portspeed -s 100H

prompt

Access: Administrator, Device User

UPS Network Management Card 2 User’s Guide

19

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
	-s	long	The prompt includes the account type of the currently logged-in user.
		short	The default setting. The prompt is four characters long: APC>

Example: To include the account type of the currently logged-in user in the command prompt, type:

prompt -s long

quit

Access: Administrator, Device User

Description: Exit from the command line interface session (this works the same as the exit command).

radius

Access: Administrator only

Description: View the existing RADIUS settings, enable or disable RADIUS authentication, and configure basic authentication parameters for up to two RADIUS servers.

For a summary of RADIUS server configuration and a list of supported RADIUS servers, see “Configuring the RADIUS Server” on page 52.

Additional authentication parameters for RADIUS servers are available at the user interface of the NMC. See “RADIUS” on page 52 for more information.

For detailed information about configuring your RADIUS server, see the Security Handbook, available on the Network Management Card Utility CD and at the website, www.apc.com.

	Option	Argument	Description
			Configure RADIUS authentication:
		local |	local — RADIUS is disabled. Local authentication is enabled.
			radiusLocal — RADIUS, then Local Authentication. RADIUS and local
	-a	radiusLocal |
			authentication are enabled. Authentication is requested from the RADIUS
		radius
			server first. If the RADIUS server fails to respond, local authentication is used.
			radius — RADIUS is enabled. Local authentication is disabled.
			The server name or IP address of the primary or secondary RADIUS server.
	-p1	<server IP>	Note: RADIUS servers use port 1812 by default to authenticate users. To use a
	-p2		different port, add a colon followed by the new port number to the end of the
			RADIUS server name or IP address.
	-s1	<server secret>	The shared secret between the primary or secondary RADIUS server and the
	-s2		NMC.
	-t1	<server timeout>	The time in seconds that the NMC waits for a response from the primary or
	-t2		secondary RADIUS server.

Example 1:

To view the existing RADIUS settings for the NMC, type radius and press ENTER.

20	UPS Network Management Card 2 User’s Guide

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: Administrator

Description: Restart the interface of the NMC.

resetToDef

Access: Administrator only

Description: Reset all parameters to their default.

	Option	Arguments	Description
	-p	all | keepip	Reset all configuration changes, including event actions, device settings, and,
			optionally, TCP/IP configuration settings.

Example: To reset all of the configuration changes except the TCP/IP settings for the NMC, type:

resetToDef -p keepip

snmp, snmpv3

Access: Administrator only

Description: Enable or disable SNMP 1 or SNMP 3.

Option	Arguments	Description
-S	enable | disable	Enable or display the respective version of SNMP, 1 or 3.

Example: To enable SNMP version 1, type:

snmp -S enable

system

Access: Administrator only

Description: View and set the system name, the contact, the location and view up time as well as the date and time, the logged-on user, and the high-level system status P, N, A (see “Main screen status fields”).

	Option	Argument	Description
	-n	<system name>	Define the device name, the name of the person responsible for the device,
			and the physical location of the device.
	-c	<system contact>
			Note: If you define a value with more than one word, you must enclose the
			value in quotation marks.
	-l	<system location>	These values are also used by InfraStruxure Central and the NMC’s SNMP
			agent.

Example 1: To set the device location as Test Lab, type: system -l “Test Lab”

UPS Network Management Card 2 User’s Guide

21

Example 2: To set the system name as Don Adams, type:

system -n “Don Adams”

tcpip

Access: Administrator only

Description: View and manually configure these network settings for the NMC:

	Option	Argument	Description
	-S	enable | disable	Enable or disable TCP/IP.
	-i	<IP address>	Type the IP address of the NMC, using the format xxx.xxx.xxx.xxx
	-s	<subnet mask>	Type the subnet mask for the NMC.
	-g	<gateway>	Type the IP address of the default gateway. Do not use the loopback
			address (127.0.0.1) as the default gateway.
	-d	<domain name>	Type the DNS name configured by the DNS server.
	-h	<host name>	Type the host name that the NMC will use.

Example 1: To view the network settings of the NMC, type tcpip and press ENTER.

Example 2: To manually configure an IP address of 150.250.6.10 for the NMC, type:

tcpip -i 150.250.6.10

tcpip6

Access: Administrator only

Description: Enable IPv6 and view and manually configure these network settings for the NMC (NMC):

	Option	Argument	Description
	-S	enable | disable	Enable or disable IPv6.
	-man	enable | disable	Enable manual addressing for the IPv6 address of the NMC.
	-auto	enable | disable	Enable the NMC to automatically configure the IPv6 address.
	-i	<IPv6 address>	Set the IPv6 address of the NMC.
	-g	<IPv6 gateway>	Set the IPv6 address of the default gateway.
		router | statefull |	Set the DHCPv6 mode, with parameters of router controlled, statefull (for
	-d6		address and other information, they maintain their status), stateless (for
		stateless | never
			information other than address, the status is not maintained), never.
	Example 1: To view the network settings of the NMC, type tcpip6 and press ENTER.

Example 2: To manually configure an IPv6 address of 2001:0:0:0:0:FFD3:0:57ab for the NMC, type:

tcpip -i 2001:0:0:0:0:FFD3:0:57ab

uio

Access: Administrator, Device User

22	UPS Network Management Card 2 User’s Guide

Description: This command is available for an AP9631 Network Management Card 2 with a connected Dry Contact I/O Accessory (AP9810).

	Option	Argument	Description
	-rc <UIO port #>	open | close	Change the state of a connected output, and specify the UIO
			(universal input/ output) port number.
		<UIO port #> |	View the status of the sensors connected to the Dry Contact
		<UIO port #>,
	-st		I/O Accessory. To view the status of a specific sensor or
		<UIO port #> |
			several sensors, type their UIO port numbers.
		<UIO port #>–<UIO port #>
		<UIO port #> |
	-disc	<UIO port #>,	Identify new input contact or output relay connections.
		<UIO port #> |
		<UIO port #>–<UIO port #>

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.

Access: Administrator, Device User

Description: Control the UPS and view status information.

	Option	Arguments	Description
		off | graceoff | on |	Configure UPS actions. See “Actions (for a single UPS and
	-c	reboot | gracereboot |
			Synchronized Control Groups)” on page 32 for detailed information.
		sleep | gracesleep
			Initiate or end a runtime calibration. A calibration recalculates remaining
			runtime and requires the following:
	-r	start | stop	• Because a calibration temporarily depletes the UPS batteries, you can
			perform a calibration only if battery capacity is at 100%.
			• For some UPS devices, the load must be at least 7% to perform a
			calibration.
	-s	start	Initiate a UPS self-test.
			Control the use of bypass mode. This command is model-specific and
	-b	enter | exit	may not apply to your UPS. See “Actions (for a single UPS and
			Synchronized Control Groups)” on page 32 for detailed information.

UPS Network Management Card 2 User’s Guide

23

Option	Arguments	Description
		Control any of three outlet groups at a Smart-UPS XLM. Specify the
		outlet group with #. For information about outlet groups, see “What are
		Outlet Groups?” on page 36.
		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.
	Off | DelayOff | On |	• DelayReboot — Turn the outlet group off after the number of
		seconds configured as Power Off Delay, then turn it on after the
	DelayOn | Reboot |	number of seconds configured as Reboot Duration and Power On
-o#	DelayReboot|	Delay.
	Shutdown |
		• Shutdown — If the UPS is online, this reboots the outlet group. If the
	DelayShutdown |
		UPS is on battery, this shuts down the group and waits for AC utility
	Cancel
		power before turning on the group again.
		• DelayShutdown — Shut down the outlet group after the number of
		seconds configured as Power Off Delay.
		• Cancel — Cancel your previous commands, e.g. turning off.
		When the state of the outlet group is off, the option accepts two
		arguments:
		• On — Turn on the group immediately.
		• DelayOn — Turn on the group after the number of seconds configured
		as Power On Delay.
		The Power On Delay, Power Off Delay, and Reboot Duration must be
		configured at the user interface. See “The outlet groups option (including
		automatic load-shedding)” on page 37 for more information.
		View the status (on, off, or rebooting) of all the outlet groups. To view the
		status of a specific outlet group, specify its number. For example, type
		ups -os1 to view the status of outlet group 1, see note below.
-os#		Note:When you use this option on a UPS with a main outlet group:
		1 identifies the main outlet group, 2 identifies Switched Outlet Group 1, 3
		identifies Switched Outlet Group 2, etc.
		On a UPS with NO main outlet group:
		1 identifies Switched Outlet Group 1, etc.
-st		View the status of the UPS.
-a	start	Test the UPS audible alarm.

24	UPS Network Management Card 2 User’s Guide

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
		<phase#> | all	Display the input measurements for the chosen phase of the UPS.
			Typing “all” displays the information for all phases of the UPS.
	-input
		voltage | current |	Specify the input measurement for the ups command.
			Example: ups -input 2 frequency
		frequency | all
			Displays the frequency for phase 2 of the UPS.
		<phase#> | all	Display the input measurements for the chosen phase of the bypass
			main. Typing “all” displays all phases of the bypass main.
	-bypass
		voltage | current |	Specify the input measurement for the ups command.
			Example: ups -bypass 2 current
		frequency | all
			Displays the current for phase 2 of the bypass main.
		<phase#> | all	Display the output measurements for the chosen phase of the UPS.
			Typing “all” displays the information for all phases of the UPS.
	-output
		voltage | current | load |	Specify the output measurement for the ups command.
		power | percload | pf |	Example: ups -output 2 percload
		frequency | all	Displays the percentage of load for phase 2 of the UPS.
	-batt		Display the battery status of the UPS
	-about		Displays information about the UPS.
	-al	<c | w>	Display all existing alarms. Specifying “c” or “w” limits the display to
			either Critical (c) or Warning (w) alarms.

Example 1: To initiate a runtime calibration, type:

ups -r start

Example 2: To immediately turn off outlet group 2 at a Smart-UPS XLM, type:

ups -o2 off

upsfwupdate

This command might not be available for all UPS devices.

Access. Administrator, Device User.

Description: Initiate an update of the UPS firmware. The firmware update file must have been previously sent using FTP to the NMC and stored in the /upsfw/ directory.

Option	Argument	Description
-apply		Start the firmware update.
-status		Check the status of a firmware update that is already initiated.
-lastresult		View the result of the last attempted firmware update.

UPS Network Management Card 2 User’s Guide

25

Option	Argument	Description
-fileinfo		View information about the firmware update file present on your NMC,
		including its name, whether it is compatible with the UPS, and its version.

user

Access: Administrator only

Description: Configure the user name and password for each account type, and configure the inactivity timeout.

For information on the permissions granted to each account type (Administrator, Device User, and Read-Only User), see “Types of user accounts” on page 3.

	Option	Argument	Description
	-an	<admin name>	Set the case-sensitive user name for each account type. The maximum
	-dn	<device name>
			length is 10 characters.
	-rn	<read-only name>
	-ap	<admin password>	Set the case-sensitive password for each account type. The maximum
	-dp	<device password>
			length is 32 characters. Null/ blank passwords are not allowed.
	-rp	<read-only password>
	-t	<minutes>	Set the time that the system waits before logging off an inactive user.
			Three minutes is the default, with a maximum of ten.

Example 1: To change the Administrator user name to XYZ, type:

user -an XYZ

Example 2: To change the log off time to 10 minutes, type:

user -t 10

web

Access: 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.114:5000

	Option	Argument	Definition
	-S	disable | http | https	Configure access to the user interface. When HTTPS is enabled, data is
			encrypted during transmission and authenticated by digital certificate.
	-ph	<http port #>	Specify the TCP/IP port used by HTTP to communicate with the NMC (80
			by default).
	-ps	<https port #>	Specify the TCP/IP port used by HTTPS to communicate with the NMC (443
			by default).
	Example: To prevent all access to the user interface, type:
	web -S disable

26	UPS Network Management Card 2 User’s Guide