User Guide Rack Automatic Transfer Switch (ATS) AP4421, AP4422, AP4423, AP4424, AP4430, AP4431, AP4432 AP4433, AP4434, AP4450, AP4452, AP4452J, AP4453 990-5844A-001 Publication Date: 11/2018 Au ati Transtom fer Swc itch Network by Schneider E l e c t r i c - OK - Warning - Overload 10/100 USB Reset Serial pdu0393c Au ati Transtom fer Swc itch Network USB Reset Serial by Schneider E l e c t r i c - OK - Warning - Overload 10/100
APC by Schneider Electric Legal Disclaimer The information presented in this manual is not warranted by the APC by Schneider Electric to be authoritative, error free, or complete. This publication is not meant to be a substitute for a detailed operational and site specific development plan. Therefore, APC by Schneider Electric assumes no liability for damages, violations of codes, improper installation, system failures, or any other problems that could arise based on the use of this Publication.
Contents Important Safety Information.................................................................... 1 Overview ..................................................................................................... 2 Product Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Internal Protection Measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 How Switching Works . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 Command Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Network Management Card Command Descriptions . . . . . . . . . . . . . . . . .22 ? or help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 about . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
whoami . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 xferINI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 xferStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Device Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 aboutATS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status Tab................................................................................................. 74 View ATS Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 View device alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 View device status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 View the unit status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 Configure notifications by event . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Configure notifications by group . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Set up e-mail notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Remote Monitoring Service . .
File Transfers ......................................................................................... 121 Upgrading Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121 Benefits of upgrading firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Firmware module files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Firmware File Transfer Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Important Safety Information Read the instructions carefully to become familiar with the equipment before trying to install, operate, service, or maintain it. The following special messages may appear throughout this manual or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure.
Overview The APC by Schneider Electric™ Rack Automatic Transfer Switch (ATS) with Network Management Card 2 provides redundant power to single-corded equipment loads, such as servers. The Rack ATS has two input power cords that supply power to the connected loads from both a primary and secondary power source. If the primary source becomes unavailable or goes out of the configured power range, the Rack ATS will switch to draw power from the secondary source without interrupting critical loads.
Internal Protection Measures ATS units may include the following internal protection measures: • Input relays in every model open when their source is disconnected to help prevent electric backfeed from one input cord into another (ATS 1). ATS 1 Source A Attached equipment Source B ATS 2 • Some 2U models have circuit breakers to help protect against bank overload (ATS 3).
2. The ATS constantly monitors the quality and amount of power coming from sources A and B. If one source begins to supply power that does not meet your settings, the ATS will disqualify that source. a. If the disqualified source is not in use, the ATS will generate an alarm to indicate that redundancy has been lost. b. If the disqualified source is in use, the ATS will switch to draw power from the other available source. If a preferred source is set, the ATS will wait 30 seconds to monitor that source.
Types of User Accounts The Rack ATS has various levels of access (Super User, Administrator, Device User, Read-Only User, and Network-Only User), which are protected by user name and password requirements. Up to four users are allowed to log on to the same Rack ATS simultaneously. • An Administrator or the Super User can use all of the menus in the Web UI and all of the commands in the CLI. Administrator user types can be deleted, but the Super User cannot be deleted.
Getting Started To start using the Rack ATS: 1. Install the Rack ATS using the Installation and Quick Start on www.apc.com. 2. Apply power and connect to your network. Follow the directions in the Installation and Quick Start. 3. Establish your network settings. 4. Begin using the Rack ATS with one of the following: – The front panel. See “Front Panel” on page 11. NOTE: The front panel allows you to view Rack ATS settings, but not configure them. – The CLI. See “Command Line Interface” on page 17.
Device IP Configuration Wizard The Device IP Configuration Wizard runs on Microsoft® Windows® 2000, Windows Server® 2003, Windows Server 2012, and on 32- and 64-bit versions of Windows XP®, Windows Vista®, Windows 2008, Windows 7, Windows 8, and Windows 10 operating systems. The Device IP Configuration Wizard supports cards that have firmware version 3.0.x or higher and is for IPv4 only. To install the Device IP Configuration Wizard: 1. Go to www.apc.com. 2.
DHCP You can use an RFC2131/RFC2132-compliant DHCP server to configure the TCP/IP settings for the Rack ATS. 1.
Remote access to the CLI From any computer on the same network as the Rack ATS, you can use ARP and Ping to assign an IP address to the Rack ATS, and then use Telnet to access the CLI of that Rack ATS and configure the other TCP/IP settings. NOTE: After the IP address of the Rack ATS is configured, you can access the Rack ATS using Telnet or SSH, without first using ARP and Ping. You must enable SSH before using it, so Telnet is required for initial CLI configuration. 1.
Network Management with Other Applications These applications and utilities work with a Rack ATS that is connected to the network. • PowerNet Management Information Base (MIB) with a standard MIB browser: Perform SNMP SETs and GETs and use SNMP traps • EcoStruxure IT: Collects, organizes, and distributes critical alerts and key information, providing a unified view of complex physical infrastructure environments from anywhere on the network or from your smart phone.
Front Panel Network - OK - Warning - Over o l ad x 10 /100 Reset A/B Preference USB B pdu0733b Serial NOTE: Your Rack ATS is configured so the display back light turns off after 10 minutes of inactivity. Press any display navigation button to illuminate the back light. Item Function Preference A/B Button Press to set a preferred source: the first press sets source A, the second press sets source B, and the third press sets no preference.
Load Status LED This LED identifies overload and warning conditions for the ATS. For more information on warning conditions, see “Configure warning thresholds” on page 80. Condition Description Green The Rack ATS current is below the Near Overload Warning threshold. Yellow The Rack ATS current is above the Near Overload Warning threshold. Red The Rack ATS current is above the Overload Alarm threshold. Network Status LED This LED indicates the network status.
LCD Display Screens The front panel LCD Display automatically rotates between four default screens. You can press Home or Down to move through these screens manually. You can press Select to go to the main menu or select menu items. Down allows you to move through menu items and menu screens. After 30 seconds without activity, the LCD display will revert to the default screens. You can also press Home to return to the default screens. Default screens Alarm status and total load in Amps Total: 10.
Menu screens Main menu Feed Info Network Software Info SKU/Serial # Alarm Status Log to Flash Feed Info View information for each power source (Feed A and Feed B), or view the Preferred Source (in green text). Feed A (Preferred)o Selected 118 V, 60 Hz 10.1 A, 0.0 KvA Network Feed B (Secondary)o Available 118 V, 60 Hz View the IPv4 Address, the IPv6 Address, or the MAC Address.
Alarm Status View active alarms. Alarm Statuso No Alarms Present Log to Flash Alarm Status No Alarms Present Use a USB drive at the USB port to download compressed log files. Extract the files on your computer to view the logs.
Alarm status indicators When an alarm is generated, alarm status indicators show the level of the alarm (Warning or Critical). No Alarm screens Total: 10.1A Total: 10.1A Warning Alarm (Low Load and Near Overload) Overload Low Load Overload Low Load Active Alarms: Critical Alarm (Overload) screens 1 Active Alarms: 1 Feed A (Preferred)o Selected 118 V, 60 Hz 10.1 A, 0.0 KvA Feed A (Preferred)o Selected 118 V, 60 Hz 10.1 A, 0.
Command Line Interface You can use the Command Line Interface (CLI) to configure, manage, and monitor the status of the Rack ATS. Additionally, the CLI enables you to create scripts for automated operation. You can configure all parameters of a Rack ATS (including those for which there are not specific CLI commands) by using the CLI to transfer an INI file to the Rack ATS. The CLI uses XMODEM to perform the transfer. However, you cannot read the current INI file through XMODEM.
About the Main Screen The following screen is displayed when you log on to the CLI of a Rack ATS. Schneider Electric Network Management Card AOS vx.x.x (c)Copyright 2018 All Rights Reserved ATS4g App vx.x.
• A Stat field reports the Rack ATS status. Stat:P+ N4+ N6+ A+ P+ The APC operating system (AOS) is functioning properly. IPv4 only IPv6 only IPv4 and IPv6* Description N+ N+ N4+ N6+ The network is functioning properly. N? N6? N4? N6? A BOOTP request cycle is in progress. N– N6- N4- N6- The Rack ATS failed to connect to the network. N! N6! N4! N6! Another device is using the Rack ATS IP address.
Command Syntax Item Description - Options are preceded by a hyphen. <> Definitions of options are enclosed in angle brackets. For example: -dp [] 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.
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 Message E000 Success E001 Successfully Issued E002 Reboot required for change to take effect E100 Command failed E101 Command not found E102 Parameter Error Reported when there is any problem with the arguments supplied to the command:
Network Management Card Command Descriptions ? or help Access: Super User, Administrator, Device User, Read Only, Network Only Description: View a list of all the CLI commands available to your account type, or view help text for a specific command.
about Access: Super User, Administrator, Device User, Read Only Description: Displays system information (Model Number, Serial Number, Manufacture Dates, etc.
alarmcount Access: Super User, Administrator, Device User, Read Only Description: Displays alarms present in the system. Information about the alarms is provided in the event log. Parameters: Option Argument Description -p all View the total number of active alarms reported by the Rack ATS. warning View the number of any kind of active alarm reported by the Rack ATS.
boot Access: Super User, Administrator Description: Allows the user to get/set the network startup configuration of the device, such as setting boot mode. Parameters: Option Argument Description -b Define how the TCP/IP settings will be configured when the Rack ATS turns on, resets, or restarts. See “Configure TCP/IP and communication settings for IPv4 and IPv6” on page 90 for information about each boot mode setting.
bye, exit, or quit Access: Super User, Administrator, Device User, Read Only, Network-Only User Description: Exit from the CLI session. Parameters: None Example: apc> exit Bye Error Message: None cd Access: Super User, Administrator, Device User, Read Only Description: Allows the user to set the working directory of the file system. The working directory is set back to the root directory ‘/’ when the user logs out of the CLI.
cipher Access: Super User, Administrator Description: Enable or disable cryptographic algorithms for Web UI sessions. You cannot enable or disable these algorithms directly from the Web UI. You must reboot your appliance after enabling or disabling algorithms for changes to take effect. There are three categories of algorithms: Authentication algorithms, Block Cipher algorithms, and MAC algorithms. Available and Blocked Cipher Suites are also listed.
Example 2: Retrieve a list of each available cryptographic algorithm and its status.
clrrst Access: Super User, Administrator, Device User Description: Clear reset reason. Parameters: None Example: None Error Message: None console Access: Super User, Administrator Description: Define whether users can access the CLI using Telnet, which is enabled by default, or Secure SHell (SSH), which transmits 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 CLI.
date Access: Super User, Administrator Description: Get and set the date and time of the system. To configure an NTP server to define the date and time for the Rack ATS, see “Configure date, time, and daylight savings” on page 107. Parameters: Option Argument Description -d <“datestring”> Set the current date. The format must match the current -f setting. -t <00:00:00> Configure the current time, in hours, minutes, and seconds. Use the 24-hour clock format. -f
dir Access: Super User, Administrator, Device User, Read Only Description: Displays the content of the working directory. Parameters Argument Description Show the contents of the current (or specified) directory. Example: apc> dir E000: Success 2978816 Aug 3 17:46 apc_hw05_aos_664.bin 1803460 Sep 19 17:44 apc_hw05_ats4g_664.bin 45000 Nov 2 7:45 config.
dns Access: Super User, Administrator Description: Configure the manual Domain Name System (DNS) settings. Parameters Option Argument Description -OM Override the manual DNS. -p Set the primary DNS server. -s Set the secondary DNS server. -d Set the domain name. -n Set the domain name IPv6. -h Set the host name.
email Access: Super User, Administrator, Device User Description: View email Parameters: Option Argument Description -g[n] Enable/disable generation. -t[n] Set the To address. -o[n] Set the format (long or short). -l[n] Set the language code; this should be supported by current language pack. -r[n] Set the route (local, recipient, or custom).
eventlog Access: Super User, Administrator, Device User, Read Only Description: View the date and time you retrieved the event log, the status of the Rack ATS, and the status of sensors connected to the Rack ATS. 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 CLI. ENTER Update the log display.
firewall Access: Super User, Administrator Description: Establishes a barrier between a trusted, secure internal network and another network. Parameters: Option Argument Description -S Enable or disable the Firewall. -f Name of the firewall to activate. -t Name of firewall to test and duration time in minutes. -fe No argument. List only Shows active file errors. -te No argument.
ftp Access: Super User, Administrator Description: Get/set the FTP configuration data, NOTE: The system will reboot if any configuration is changed. Parameters: Option Argument Description -p Define the TCP/IP port that the FTP server uses to communicate with the Rack ATS (21 by default). The FTP server uses both the specified port and the port one number lower than the specified port. Valid values are 21 and 5000-32768. -S Configure access to the FTP server.
lastrst Access: Super User, Administrator, Device User Description: Last reset reason Parameters: None Example: apc> lastrst 04 Requested Reset E000: Success Error Message: None ledblink Access: Super User, Administrator, Device User Description: Sets the LED on the Rack ATS to blink. Parameters: Argument Description Set the number of minutes for the LED to blink.
netstat Access: Super User, Administrator, Device User, Read Only Description: Displays incoming and outgoing network connections. Parameters: None Example: apc> netstat Current IP Information: Family mHome Type IPAddress Status IPv6 4 auto FE80::2C0:B7FF:FE51:F304/64 configured IPv4 0 dhcp 10.218.117.43/24 configured IPv6 0 manual ::1/128 configured IPv4 0 manual 127.0.0.
ping Access: Super User, Administrator, Device User Description Perform a network ‘ping’ to any external network device. Parameters Argument Description Type an IP address with the format xxx.xxx.xxx.xxx, or the DNS name configured by the DNS server. Example: apc> ping 192.168.1.50 E000: Success Reply from 192.168.1.50: time(ms)= <10 Reply from 192.168.1.50: time(ms)= <10 Reply from 192.168.1.50: time(ms)= <10 Reply from 192.168.1.
prompt Access: Super User, Administrator, Device User Description: Change the format of the prompt, either short or long Parameters Option Argument Description -s long The prompt includes the account type of the currently logged-in user. short The default setting.
radius Access: Super User, Administrator 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 “Configure the RADIUS server” on page 86. Additional authentication parameters for RADIUS servers are available at the Web UI of the Rack ATS. See “Manage remote user settings” on page 85 for more information.
reboot Access: Super User, Administrator Description: Restart the NMC interface of the Rack ATS only. Forces the network device to reboot. User must confirm this operation by entering a “YES” after the command has been entered. Parameters: Option Description -Y Skip confirmation prompt. (Uppercase Y only.) Example 1: apc> reboot E000: Success Reboot Management Interface Enter 'Y' to continue or to cancel : Rebooting...
session Access: Super User, Administrator, Device User Description: Records who is logged in, the serial, time and ID. Parameters: Option Argument Description -d End user session. -m Allow multiple users to be logged on at once. -a Enable or disable Serial Remote Authentication Override, which allows users to Bypass RADIUS by using a serial connection to the CLI.
smtp Access: Super User, Administrator Description: Internet standard for electronic mail. Parameters: Option Argument Description -f Set e-mail From address. -s Set the SMTP server address. -p Set e-mail recipient port number. Options include 25, 2525, 465, 587, and 5000 to 32768. -a Enable or disable authentication -u Set user name for authentication. -w Set e-mail password for authentication.
snmp Access: Super User, Administrator Description: Enable or disable SNMPv1. Set configuration for up to 4 Access Control groups. NOTE: SNMPv2c uses SNMPv1 configuration settings. Parameters: Option Argument Description -S Enable or disable SNMPv1. -c[n] Identify the group of Rack ATS units for access control. -a[n] Set the access level.
snmpv3 Access: Super User, Administrator Description: Enable or disable SNMPv3. Configure up to 4 SNMPv3 user profiles. Parameters Option Argument Description -S Enable or disable SNMPv3. -u[n] Set the User Name for access control. -c[n] Set the encryption phrase for access control. -a[n] Set the authentication phrase for access control. -n[n] Set the host’s name or address for access control.
snmptrap Access: Super User, Administrator Description: Enable or disable SNMP trap generation Parameters: Option Argument -c[n] Set the community for the trap receiver. -r[n] Set the NMS IP address for the trap receiver. -l[n] Enter the language code for the trap receiver. -t[n] Set the trap type for the trap receiver. -g[n] Enable or disable trap generation for the trap receiver.
system Access: Super User, Administrator 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 “About the Main Screen” on page 18 for more information about system status).
tcpip Access: Super User, Administrator Description: View and manually configure these network settings for the Rack ATS. Parameters: Option Argument Description -i Enter the IPv4 address of the Rack ATS, using the format xxx.xxx.xxx.xxx -s Enter the subnet mask for the Rack ATS. -g Enter the IP address of the default gateway. Do not use the loopback address (127.0.0.1) as the default gateway.
tcpip6 Access: Super User, Administrator Description: Enable IPv6 and view and manually configure network settings for the Rack ATS. Parameters: Option Argument Description -S Enable or disable IPv6. -man Enable or disable manual addressing for the IPv6 address. -auto Enable or disable automatic configuration for the IPv6 address. -i Set the IPv6 address of the Rack ATS.
user Access: Super User, Administrator Description: Configure individual user accounts. All users must have a user name, password, and account type. You can edit a user account, but not a user name. You must delete the account and then create a new user. User values left unconfigured will be controlled by the userdflt command. For information on the permissions granted to each account type, see “Types of User Accounts” on page 5.
userdflt Access: Super User, Administrator Description: Complimentary function to “user” establishing default user preferences. There are two main features for the default user settings: • Determine the default values to populate in each of the fields when the Super User or Administrator-level account creates a new user. These values can be changed before the settings are applied to the system.
web Access: Super User, Administrator Description: Enable access to the Web UI using HTTP or HTTPS. For additional security, you can change the port setting for HTTP and HTTPS to any unused port from 5000 to 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, type: http://152.214.12.114:5000 Parameters: Option Argument Description -h Enable or disable HTTP.
xferINI Access: Super User, Administrator Description: Use XMODEM to upload an .ini file to the NMC while you are accessing the CLI through a serial connection. After the upload completes: • If there are any system or network changes, the CLI restarts and you must log on again. • If you selected a baud rate for the file transfer that is not the same as the default baud rate for the Rack ATS, you must reset the baud rate to the default to reestablish communication with the Rack ATS.
Device Command Descriptions The device command descriptions include the ATS command’s units, resolution/scale, and ranges. aboutATS Access: Super User, Administrator, Device User, Read Only User Description: Display ATS controller information. Parameters: None Example: apc> aboutATS E000: Success Model: Firmware Rev: Firmware Date: Hardware Rev: Manufacture Date: Serial Number: AP4450 6.2.3 02/13/18 R01 03/29/17 5AXXXXXXXXX Downloader Rev: 4.
atsMeasure Access: Super User, Administrator, Device User, Read Only User Description: Read source power measurements and ATS power measurements. Parameters: None Example: apc> atsMeasure E000: Success Source A Freq: Source A Voltage: Source B Freq: Source B Voltage: Total Output Power: Source A 24V Power Supply: Source B 24V Power Supply: Source A Boost Voltage: Source B Boost Voltage: 3.3 V Power Supply: 1.0 V Power Supply: 60 Hz 121 V 60 Hz 121 V 1.00 kVA 24 V 24 V 40 V 40 V 3.3 V 1.
bkLowLoad Access: Super User, Administrator, Device User Description: Set or view the bank low-load threshold current in amps. Only single phase SKUs with two or more circuit breakers support this command. Parameters: Argument Description • all: all bank numbers • bank#: A single number, a range of numbers separated with a dash, or a comma-separated list of single bank number and/or number ranges. The new bank threshold (Amps) NOTE: The maximum bank number is 3.
bkNearOver Access: Super User, Administrator, Device User Description: Set or view the bank near-overload threshold current in amps. Only single phase SKUs with two or more circuit breakers support this command. Parameters: Argument Description • all: all bank numbers • bank#: A single number, a range of numbers separated with a dash, or a comma-separated list of single bank number and/or number ranges. The new bank threshold (Amps) NOTE: The maximum bank number is 3.
bkOverLoad Access: Super User, Administrator, Device User Description: Set or view the bank overload threshold current in amps. Only single phase SKUs with two or more circuit breakers support this command. Parameters: Argument Description • all: all bank numbers • bank#: A single number, a range of numbers separated with a dash, or a comma-separated list of single bank number and/or number ranges. The new bank threshold (Amps) NOTE: The maximum bank number is 3.
bkPeakLoad Access: Super User, Administrator, Device User Description: Display the peak load measurement from a bank(s). Only single phase SKUs with two or more circuit breakers support this command. Parameters: Argument Description • all: all bank numbers • bank#: A single number, a range of numbers separated with a dash, or a comma-separated list of single bank number and/or number ranges. NOTE: The maximum bank number is 3.
bkReading Access: Super User, Administrator, Device User, Read Only Description: View the current reading (measurement) in amps for a bank. Only single phase SKUs with two or more circuit breakers support this command. Parameters: Argument Description • all: all bank numbers • bank#: A single number, a range of numbers separated with a dash, or a comma-separated list of single bank number and/or number ranges. NOTE: The maximum bank number is 3.
eventCounts Access: Super User, Administrator, Device User Description: Display or clear the event counts reported from the ATS controller. Parameters: Enter a <0> argument to set all event counts to 0.
frontPanel Access: Super User, Administrator, Device User Description: Set or view control for the source button on the front panel. Parameters: Argument Description Lock or unlock the front panel for use.
lineVRMS Access: Super User, Administrator Description: Read or set the nominal source line voltage (V). Acceptable values depend on the SKU# of your ATS.
phNearOver NOTE: Only units without circuit breakers are supported by this command. Access: Super User, Administrator, Device User Description: Set or view the phase near-overload threshold in amps. Parameters: Example: apc> phNearOver E000: Success 8 A apc> phNearOver 9 E000: Success Error Message: E000, E102 phOverLoad NOTE: Only units without circuit breakers are supported by this command.
phReading NOTE: Only units without circuit breakers are supported by this command. Access: Super User, Administrator, Device User Description: View the phase load in Amps. Parameters: None Example: apc> phReading E000: Success 4.0 A Error Message: E000, E102 prodInfo Access: Super User, Administrator, Device User, Read Only Description: View information about the ATS.
sourceBName Access: Super User, Administrator, Device User Description: Set or view the name of power source B. Parameters: Example: apc> sourceBName E000: Success Wall Box Phase L2 apc> sourceBName “Wall Box N2 Phase L3” E000: Success Error Messages: E000, E102 sourcePref Access: Super User, Administrator, Device User Description: Set or view the desired source preference.
vNarrowLmt Access: Super User, Administrator, Device User Description: Set or view the voltage range to use when the Voltage Transfer Range is set to Narrow. This value must be less than the Medium Limit.
vWideLmt Access: Super User, Administrator, Device User Description: Set or view the voltage range to use when Voltage Transfer Range is set to Wide. This value must be greater than the Medium Limit.
Web UI To access the Web UI on Windows® operating systems, use Microsoft® Internet Explorer® (IE) 8.x or higher (with compatibility view turned on), or the latest release of Microsoft Edge®. To access the Web UI on any operating system, use the latest releases of Mozilla Firefox®, or Google Chrome®. Other commonly available browsers also may work but have not been fully tested by APC by Schneider Electric. The ATS cannot work with a proxy server.
URL address formats When you specify a non-default Web server port in Internet Explorer, you must include http:// or https:// in the URL. Common browser error messages at log on Error Message Browser Cause of the Error “This page cannot be displayed.” Internet Explorer Web access is disabled, or the URL was not correct. “Unable to connect.
Device status icons One or more icons and accompanying text indicate the current operating status of the Rack ATS: Symbol Description Critical: A critical alarm exists, which requires immediate action. Warning: An alarm condition requires attention and could jeopardize your data or equipment if its cause is not addressed. No Alarms: No alarms are present, and the Rack ATS and NMC are operating normally.
Home Tab Active Alarms: view alarms, which will also be displayed at the top right of every page. If no alarms exist, a green check mark with the words “No Alarms Present” will show. Switch/Source Status: shows the selected source and whether switchover is possible. Load Status: View the load for the device in kVA and the load for the phases and banks in A, as applicable. The meter shows the current load status: normal (green), near overload (yellow), or overload (red).
Status Tab View ATS Status View device alarms Path: Status > ATS > Alarms View current device alarms, including alarm status icons (see“Device status icons” on page 72) and descriptions. View device status Path: Status > ATS > Device View the Device Status, Properties, and Configuration information. Select Configure device settings to edit the Name, Location, or Contact information.
View Network Status Path: Status > Network > Network Current IPv4 settings System IP: The IP address of the unit. Subnet Mask: The IP address of the sub-network. Default Gateway: The IP address of the router used to connect to the network. MAC Address: The MAC address of the unit. Mode: How the IPv4 settings are assigned: Manual, DHCP, or BOOTP. DHCP Server: The IP address of the DHCP server. This is only displayed if Mode is DHCP.
Domain name system status Active Primary DNS Server: The IP address of the primary DNS server. Active Secondary DNS Server: The IP address of the secondary DNS server. Active Host Name: The host name of the active DNS server. Active Domain Name (IPv4/IPv6): The IPv4/IPv6 domain name that is currently in use. Active Domain Name (IPv6): The IPv6 domain name that is currently in use. Port Speed Current Speed: The current speed assigned to the Ethernet port in Mbps.
Control Tab The Control menu options enable you to take immediate actions affecting active user management and the security of your network. Manage User Sessions Path: Control > Security > Session Management The Session Management menu displays all active users currently connected to the ATS. To view Information about a user, select their user name. The Session Details screen displays basic information about the user including the interface they are logged in to, their IP address, and log in time.
Configuration Tab Configure the ATS Configure ATS name and location Path: Configuration > ATS > Device Status: View the ATS load in A and the Output Power in kVA. Name: Enter a descriptive name for the ATS. This will appear on the Home tab. Location: Enter the physical location of the ATS. This will appear on the Home tab. Contact: Enter the person responsible for the ATS. This will appear on the Home tab. Click Apply to save your changes or Cancel to erase your changes.
Configure switching behavior Path: Configuration > ATS > Frequency/Voltage. DANGER HAZARDOUS VOLTAGE Do not operate the Rack ATS outside Rated Voltage (+/- 10%). Voltage limits and transfer ranges represent software control of switching behavior, not input voltages for use. Failure to follow these instructions will result in death or serious injury. Frequency Deviation: Frequency deviation beyond the set value will cause the Rack ATS to switch power sources.
Configure warning thresholds Path: Configuration > ATS > Load Status: View the current in A, and the Peak Current in kVA, for the device, phases, and banks. The indicator in the green, yellow, and red meter shows the load status: normal, near overload, or overload. Warning Thresholds: The Rack ATS generates an alarm when any bank exceeds its rated value. Set the number of amps to trigger a Low Load Warning, Near Overload Warning, and Overload Alarm.
Manage Security Settings Manage user sessions Path: Configuration > Security > Session Management Allow Concurrent Logins: Select the Enable check box to allow two or more users to log on at the same time. Each user has equal access and each interface (HTTP, FTP, telnet, serial connection, etc.) counts as a logged-in user. Remote Authentication Override: The Rack ATS supports RADIUS storage of passwords on a server.
Manage local user settings Path: Configuration > Security > Local Users > Management Click Add User to add a new user, or select a User Name to edit that user’s configuration: • Access: Select the Enable check box to allow access to the ATS. • User Name: Enter a new user name. • Current Password, New Password, Confirm Password: Enter a new password in both the New Password and Confirm Password fields. You must enter a password for new users. Blank passwords, (passwords with no characters) are not allowed.
• Serial Remote Authentication Override: Use Serial Remote Authentication Override to bypass RADIUS by using the serial console (CLI) connection. This screen enables Serial Remote Authentication Override for the selected user, but, in order to work, it must also be enabled globally through the Session Management screen (see “Manage User Sessions” on page 77). • User Preferences: – Event Log Color Coding: Mark the check box to enable color-coding of alarm text recorded in the event log.
Configure default user settings Path: Configuration > Security > Local Users > Default Settings Determine the default values to populate in each of the fields when the Super User or Administrator-level account creates a new user. These values can be changed before the settings are applied to the system. • Access: Select the Enable check box to allow access to the ATS. • User Type: Select the user type from the drop-down list. – Administrator: Read-write access to all menus.
Manage remote user settings Path: Configuration > Security > Remote Users > Authentication Specify how you want remote users to be authenticated at logon. Select one of the following: • Local Authentication Only: RADIUS is disabled. Local authentication is enabled. • RADIUS, then Local Authentication: RADIUS and local authentication are enabled. Authentication is requested from the RADIUS server first. If the RADIUS server fails to respond, local authentication is used. • RADIUS Only: RADIUS is enabled.
Configure the RADIUS server Summary of the configuration procedure You must configure your RADIUS server to work with the Rack ATS. For examples of the RADIUS users file with Vendor Specific Attributes (VSAs) and an example of an entry in the dictionary file on the RADIUS server, see the Security Handbook on www.apc.com. 1. Add the IP address of the Rack ATS to the RADIUS server client list (file). 2. Users must be configured with Service-Type attributes unless Vendor Specific Attributes (VSAs) are defined.
Configure firewalls Path: Configuration > Security > Firewall > Configuration Enable or disable the firewall functionality. The configured policy is listed by default. Select the Enable check box to enable the firewall. The check box is un-checked by default. • Click Apply to confirm a firewall policy you have selected to enable. The Firewall Confirmation page will open. – The Confirmation page contains a recommendation to test the firewall before enabling. It is not mandatory.
Path: Configuration > Security > Firewall > Create/Edit Policy Create a new policy; delete or edit an existing policy NOTE: While deleting an active enabled firewall policy cannot be done, editing a running policy can be done but is not recommended as changes are applied immediately. Instead, disable the firewall, edit the policy, test it, and then re-enable the policy. Create a new policy Click Add Policy, and type in the file name for the new firewall file. The filename should have a .fwl file extension.
It is recommended that you add one of the following as the lowest priority rule in your firewall policy: • To use the firewall as a white list, add 250 Dest any / Source any / protocol any / discard • To use the firewall as a black list, add 250 Dest any / Source any / protocol any / allow Delete a policy: Select Delete Policy to open the Confirm Deletion page. Click Apply to confirm and the selected firewall file is removed from the file system.
Configure Network Settings Configure TCP/IP and communication settings for IPv4 and IPv6 Path: Configuration > Network > TCP/IP > IPv4 View the current IPv4 address, subnet mask, default gateway, MAC address, and boot mode of the Rack ATS. For information on DHCP and DHCP options, see RFC2131 and RFC2132. Setting Description IPv4 Enable or disable IPv4 with this check box. Manual Configure IPv4 manually by entering the IP address, subnet mask, and default gateway.
TCP/IP options The Rack ATS uses the following options within a valid DHCP response to define its TCP/IP settings. All of these options except the first are described in RFC2132. • IP Address (from the yiaddr field of the DHCP response, described in RFC2131): The IP address that the DHCP server is leasing to the Rack ATS. • Subnet Mask (option 1): The Subnet Mask value that the Rack ATS needs to operate on the network. • Router, i.e.
Path: Configuration > Network > TCP/IP > IPv6 settings Setting Description IPv6 Enable or disable IPv6 with this check box. Manual Configuration Configure IPv6 manually by entering the IP address and the default gateway. Auto Configuration When the Auto Configuration check box is selected, the system obtains addressing prefixes from the router (if available). It uses those prefixes to automatically configure IPv6 addresses.
Configure DNS Path: Configuration > Network > DNS > Configuration Use the options under Configuration to configure and test the Domain Name System (DNS): • Override Manual DNS Settings: When enabled, configuration data from other sources (typically DHCP) takes precedence over the manual configurations set here. • Primary DNS Server or Secondary DNS Server: Select one of these to specify the IPv4 or IPv6 addresses of the primary and optional secondary DNS server.
Configure Web access Path: Configuration > Network > Web > Access To activate changes to any of these selections, all users must log off: • Enable HTTP: (the default): Enables Hypertext Transfer Protocol (HTTP), which provides Web access by user name and password, but does not encrypt user names, passwords, and data during transmission. • Enable HTTPS: Enables Hypertext Transfer Protocol (HTTPS) over Secure Sockets Layer (SSL)/ Transport Layer Security (TLS).
Configure SSL certificate Path: Configuration > Network > Web > SSL Certificate View current certificate status. Add, replace, or remove a security certificate. Status: • Not installed: A certificate is not installed, or was installed by FTP or SCP to an incorrect location. Using Add or Replace Certificate File installs the certificate to the correct location, /ssl on the Rack ATS. • Generating: The Rack ATS is generating a certificate because no valid certificate was found.
Configure SSH host key Path: Configuration > Network > Console > SSH Host Key Status indicates the status of the host key (private key): • SSH Disabled: No host key in use: When disabled, SSH cannot use a host key. • Generating: The Rack ATS is creating a host key because no valid host key was found. • Loading: A host key is being activated on the Rack ATS.
SNMPv1 SNMPv1 configuration also enables and applies to SNMPv2c. Path: Configuration > Network > SNMPv1 > Access Enable SNMPv1 Access: Enables SNMP version 1 as a method of communication with this device. Path: Configuration > Network > SNMPv1 > Access Control You can configure up to four access control entries to specify which Network Management Systems (NMSs) have access to this device.
Path: Configuration > Network > SNMPv3 > User Profiles By default, this page lists the settings of four user profiles configured with the user names apc snmp profile1 through apc snmp profile4, and no authentication or privacy (no encryption). To edit the following settings for a user profile, select a user name in the list. User Name: The identifier of the user profile.
Configure FTP server Path: Configuration > Network > FTP Server Access: Enable (the default) or disable access to the FTP server. Port: specify the TCP/IP port (21 by default) that the FTP server uses to communicate with the ATS. The FTP server uses both the specified port and the port one number lower than the specified port. You can change the Port setting to the number of any unused port from 5001 to 32768 for added security. Users must then use a colon (:) to specify the non-default port number.
Configure Notifications You can configure event actions to occur in response to an event or group of events. These actions notify users of the event in any of several ways: • Active, automatic notification. The specified users or monitoring devices are contacted directly. – E-mail notification – SNMP traps – Remote Monitoring Service – Syslog notification • Indirect notification – Event log. If no direct notification is configured, users must check the log to determine which events have occurred.
Configure notifications by group Path: Configuration > Notification > Event Actions > By Group To configure a group of events simultaneously: 1. Select how to group events for configuration: – Select Events by Severity, and then select one or more severity levels. You cannot change the severity of an event. – Select Events by Category, and then select events in one or more pre-defined categories. 2.
Set up e-mail notifications Use Simple Mail Transfer Protocol (SMTP) to send e-mail to up to four recipients when an event occurs. To use the e-mail feature, you must define the following settings: • The IP addresses of the primary and, optionally, the secondary Domain Name System (DNS) servers. • The IP address or DNS name for the SMTP Server and From Address. • The e-mail addresses for a maximum of four recipients.
Path: Configuration > Notification > E-mail > Recipients Specify up to four e-mail recipients. Click Add Recipient, or select a name to configure the settings. E-mail Recipient • Generation: Enable (default) or disable sending e-mail to the recipient. • To Address: The user name and domain name of the recipient. To use e-mail for paging, use the e-mail address for the recipient’s pager gateway account (for example, myacct100@skytel.com). The pager gateway will generate the page.
Advanced • Use SSL/TLS: Select when encryption is used. – Never: The SMTP server does not require nor support encryption. – If Supported: The SMTP server advertises support for STARTTLS but doesn't require the connection to be encrypted. The STARTTLS command is sent after the advertisement is given. – Always: The SMTP server requires the STARTTLS command to be sent on connection to it. – Implicitly: The SMTP server only accepts connections that begin encrypted. No STARTTLS message is sent to the server.
SNMP traps With Simple Network Management Protocol (SNMP) traps, you can automatically get notifications for significant ATS events. They are a useful tool for monitoring devices on your network. Path: Configuration > Notification > SNMP Traps > Trap Receivers The trap receivers are displayed by NMS IP/Host Name, (NMS stands for Network Management System). You can configure up to six trap receivers. To configure a new trap receiver, click Add Trap Receiver.
Remote Monitoring Service Path: Configuration > Notification > Remote Monitoring The remote monitoring service (RMS) is an optional service from APC by Schneider Electric that monitors your system from a remote operation center 24 hours a day, 7 days a week, and notifies you of device and system events. To purchase the RMS service, contact your vendor or select the link on bottom of this screen: Schneider Electric RMS website.
General Configuration This menu contains miscellaneous configuration items including device identification, date and time, exporting and importing your ATS configuration options, quick links, and data consolidation for troubleshooting. Configure identification Path: Configuration > General > Identification Host Name Synchronization: Allows the host name to be synchronized with the system name so both fields automatically contain the same value.
Path: Configuration > General > Date /Time > Daylight Saving Daylight Saving Time (DST) is disabled by default. You can enable traditional United States DST, or enable and configure a customized daylight saving time to match how Daylight Saving Time is implemented in your local area. When customizing DST, the system puts the clock forward by an hour when the time and date you specify under Start is reached, and puts the clock back an hour when the time and date you specify under End is reached.
Configure Logs Identify Syslog servers Path: Configuration > Logs > Syslog > Servers Click Add Server to configure a new Syslog server. Syslog Server: Uses IPv4/ IPv6 addresses or host names to identify from one to four servers to receive Syslog messages sent by the ATS. Port: The port that the ATS will use to send Syslog messages. The default UDP port assigned to Syslog is 514. Language: Select the language for any Syslog messages. Protocol: Select either UDP or TCP.
Test Syslog servers Path: Configuration > Logs > Syslog > Test Send a test message to the Syslog servers (configured through the “Syslog servers” page). The result will be sent to all configured Syslog servers. Select a severity to assign to the test message and then define the test message. Format the message to consist of the event type (for example, APC, System, or Device) followed by a colon, a space, and the event text. The message can have a maximum of 50 characters.
Tests Tab Set the LCD/LED Lights to Blink Path: Tests > ATS > LCD Blink If you are having trouble finding your ATS, enter a number of minutes in the LCD Blink Duration field, and click Apply. The LCD display will blink for the specified number of minutes. Set the LED Lights to Blink Path: Tests > Network > LED Blink If you are having trouble finding your ATS, enter a number of minutes in the LED Blink Duration field, and click Apply.
Logs Tab View and configure the Event Log By default, the Event Log displays all events recorded during the last two days, starting with the latest events. Additionally, the log records any event that sends an SNMP trap, except SNMP authentication failures, and abnormal internal system events. You can enable color coding for events on the Local User Management screen (see “Manage local user settings” on page 82).
Event Log Filtering: Use filtering to omit information you don’t want to display. • Filter the log by date or time: Use Last or From to define the time in which the events were logged. (The filter configuration is saved until the ATS restarts.) • Filter the log by event severity or category: a. Click Filter Log. b. Clear a check box to remove it from view. c. After you click Apply, text at the upper right corner of the Event Log page indicates that a filter is active.
View and configure the Data Log Use the data log to display measurements about the Rack ATS, the power input to the Rack ATS, and the ambient temperature of the Rack ATS. The steps to display and resize the data log are the same as for the event log, except that you use menu options under Data instead of Events. Path: Logs > Data > Log View the log by date or time: Use Last or From to define the time in which the data was logged, and click Apply to save your changes.
Path: Logs > Data > Size Data Log Size: specify the maximum number of log entries. NOTE: When you change the maximum log size, all existing entries are deleted. When the log subsequently reaches the maximum size, the older entries are deleted. Firewall log Path: Logs > Firewall If you create a firewall policy (see “Configure firewalls” on page 87), firewall events will be logged here. The information in the log can be useful to help the technical support team solve problems.
Use FTP to retrieve the event.txt or data.txt files 1. At a command prompt, type ftp and the IP address of the ATS, and press ENTER. If the Port setting for the FTP Server option (set through the Network menu of the Administration tab) has been changed from its default (21), you must use the non-default value in the FTP command. For Windows FTP clients, use the following command, including spaces. (For some FTP clients, you must use a colon instead of a space between the IP address and the port number.
About Tab About the Rack ATS Path: About > ATS The hardware information is useful to APC by Schneider Electric Customer Support for troubleshooting problems with the ATS. The serial number and MAC address are also available on the ATS itself. Management Uptime is the length of time the network management interface has been running continuously.
How to Export Configuration Settings Summary of the procedure A Super User/Administrator can retrieve the .ini file of an ATS and export it to another ATS or to multiple ATS units. The steps are below; see details in the sections following. 1. Configure an ATS with the desired settings, and retrieve the .ini file from that ATS. 2. Edit the file to change the TCP/IP settings at least. 3. Using a file transfer protocol supported by the ATS, transfer the .ini file to one or more other ATS units.
Edit .ini file Edit the file carefully before you transfer it to other ATS units. 1. Use a text editor to make your changes. – Section headings, keywords, and pre-defined values are not case-sensitive, but string values that you define are case-sensitive. – Use adjacent quotation marks to indicate no value. For example, LinkURL1="" indicates that the URL is intentionally undefined. – Enclose in quotation marks any values that contain leading or trailing spaces or are already enclosed in quotation marks.
The Upload Event and Error Messages The event and its error messages The following event occurs when the receiving ATS completes using the .ini file to update its settings. Configuration file upload complete, with number valid values If a keyword, section name, or value is invalid, the upload by the receiving ATS succeeds, and additional event text states the error. Event text Description Configuration file warning: Invalid keyword on line number. Configuration file warning: Invalid value on line number.
File Transfers Upgrading Firmware Benefits of upgrading firmware When you upgrade the firmware on the ATS: • You obtain the latest bug fixes and performance improvements. • New features become available for immediate use. Keeping the firmware versions consistent across your network helps ensure that all ATS units support the same features in the same manner. Here, upgrading simply means placing the module files on the ATS; there is no installation required. Check regularly on www.apc.
Firmware File Transfer Methods NOTE: Upgrade the bootmon module first, then the AOS module, and finally, the application module by placing them on the ATS in that order. Obtain the free, latest firmware version from the APC by Schneider Electric website. To upgrade the firmware of one or more ATS units, use 1 of these 5 methods: • On a Windows operating system, use the Firmware Upgrade Utility downloaded from the website www.apc.com.
Use FTP or SCP to upgrade one Rack ATS FTP To use FTP to upgrade a Rack ATS over the network: • The Rack ATS must be on the network with its system IP, subnet mask, and default gateway configured. • The FTP server must be enabled at the Rack ATS, see “Configure FTP server” on page 99. NOTE: The following procedure assumes the bootmon file does not need upgrading. It is always necessary to upgrade the other two firmware module files. To transfer the files: 1.
Use XMODEM to upgrade one Rack ATS To use XMODEM to upgrade one Rack ATS that is not on the network, you must extract the firmware files from the Firmware Upgrade Utility (see “To extract the firmware files:” ). To transfer the files (this procedure assumes bootmon does not need upgrading, it is always necessary to upgrade the other two though): 1. Select a serial port at the local computer and disable any service that uses the port. 2.
How to upgrade multiple ATS units Use one of these methods: • StruxureWare Data Center Expert or EcoStruxure IT: See your StruxureWare or EcoStruxure documentation for instructions to update multiple ATS units. • Firmware Upgrade Utility: Use this for multiple firmware updates in IPv4 if you have Windows. The utility records all upgrade steps in a log as a good reference to validate the upgrade. See “Use the Firmware Upgrade Utility” on page 122 or FAQ article FA156099 on www.apc.com for more information.
Verifying Upgrades and Updates Verify the success or failure of the transfer To verify whether a firmware upgrade succeeded, use the xferStatus command in the CLI to view the last transfer result, or use an SNMP GET to the mfiletransferStatusLastTransferResult OID. Last Transfer Result codes Possible transfer errors include the TFTP or FTP server not being found, or the server refusing access, the server not finding or not recognizing the transfer file, or a corrupt transfer file.
Troubleshooting Rack ATS Access Problems For problems that persist or are not described here, contact the APC by Schneider Electric Customer Care at www.apc.com. Problem Solution Unable to ping the ATS If the ATS’s Status LED is green, try to ping another node on the same network segment as the ATS. If that fails, it is not a problem with the Rack ATS. If the Status LED is not green, or if the ping test succeeds, perform the following checks: • Verify all network connections.
SNMP Issues 128 Problem Solution Unable to perform a GET • Verify the read (GET) community name (SNMPv1) or the user profile configuration (SNMPv3). • Use the CLI or Web UI to confirm that the NMS has access. See “SNMP options” on page 96 Unable to perform a SET • Verify the read/write (SET) community name (SNMPv1) or the user profile configuration (SNMPv3).
Source Code Copyright Notice cryptlib copyright Digital Data Security New Zealand Ltd 1998. Copyright © 1990, 1993, 1994 The Regents of the University of California. All rights reserved. This code is derived from software contributed to Berkeley by Mike Olson. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1.
Worldwide Customer Support Customer support is available at www.apc.com. © 2018 APC by Schneider Electric. APC, PowerNet, and StruxureWare are trademarks owned by Schneider Electric, S.A.S. All other trademarks are property of their respective owners.
