Contents Introduction--1 Product Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Features of MasterSwitch Plus 1 How to Recover From a Lost Password . . . . . . . . . . . . . . . . . . . . . 5 Upgrading Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Front Panel 8 Rear Panel 9 Link-RX/TX (10/100) LED 10 Status LED 11 Basic Port LED 11 MasterSwitch Plus Status LED 12 Manual button 12 masterswitch plus USER’S GUIDE Access Procedures . . . .
Control Console--26 How to Log On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Overview 26 Remote access to the control console 26 Local access to the control console 27 masterswitch plus USER’S GUIDE MasterSwitch Plus Properties . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Status 37 Quick status tab 38 Navigation Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Overview 39 Select a menu to perform a task 40 Help menu 41 Links menu 42 Outlets Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Control Outlets 43 Configure Outlets 46 MasterSwitch + Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Overview 62 Logged events 63 Web interface 63 Control console 64 How to use FTP to retrieve log files 64 Event Recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Overview 69 Trap receiver settings 69 E-mail Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Menu--84 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Overview 84 Menu options 84 Security--92 Security Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Planning and implementing security features 92 Port assignments 92 User names, passwords, community names 92 Summary of access methods 93 masterswitch plus USER’S GUIDE Option Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Life-Support Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 General policy 105 Examples of life-support devices 105 Index--106 masterswitch plus USER’S GUIDE APC Worldwide Customer Support . . . . . . . . . . . . . . . . . . . . . .
Introduction Product Description MasterSwitch Plus allows you to individually control power to connected equipment and to gracefully shut down or restart up to eight connected servers running different operating systems. In order to manage your system effectively and efficiently, MasterSwitch Plus has these additional features: • Three password-protected accounts that ensure restricted access to system-, device-, and outlet-level services.
The MasterSwitch Plus does not provide power protection. Therefore, APC does not recommend plugging a unit directly into any unprotected power source, such as a wall outlet. Initial setup You must define three TCP/IP settings for the MasterSwitch Plus before it can operate on the network. • Subnet mask • IP address of the default gateway To configure the TCP/IP settings, see the MasterSwitch Plus Installation and Quick Start Manual (.\MS_PLUS\insguide.
Access Procedures Overview The MasterSwitch Plus has two internal interfaces (control console and Web interface) that provide menus with options that allow you to manage the unit. The SNMP interface also allows you to use an SNMP browser with the PowerNet® Management Information Base (MIB) to manage the unit. For more information about the internal user interfaces, see Control Console and Web Interface.
Types of user accounts The MasterSwitch Plus has three levels of access (Administrator, Device Manager, and Outlet User), all of which are protected by password and user name requirements. • An Administrator can use all of the management menus available in the control console and the Web interface. The Administrator’s default user name and password are both apc.
How to Recover From a Lost Password You can use a local computer that connects to the unit through the serial port on the front panel of the unit. 1. Select a serial port at the local computer, and disable any service which uses that port. 3. Run a terminal program (such as HyperTerminal) and configure the selected port for 2400 bps, 8 data bits, no parity, 1 stop bit, and no flow control. Save the changes. 4. Press ENTER twice to display the User Name prompt. 5.
Upgrading Firmware See also For a complete description of how to download a firmware upgrade for your MasterSwitch Plus, see the Management Card Addendum (.\MS_PLUS\Addendum.pdf) on the provided APC MasterSwitch Utility CD. 1. Select a serial port at the local computer, and disable any service which uses that port. 2. Use the supplied smart-signaling cable (940-0024C) to connect the selected port to the serial port on the front panel of the unit. 3.
Do not interrupt the download. Caution The MasterSwitch Plus will restart when the download is complete. masterswitch plus USER’S GUIDE Upgrading the firmware will not interfere with the operation of the outlets.
Front Panel Manual 10/100Base-T Reset Link - RX/TX 10/100 7 6 5 4 3 2 1 AP9617 Network Management Card To UPS MasterSwitch plus Sta tus Item masterswitch plus USER’S GUIDE Advanced Por t Status ® Smart Slot 8 Function Reset Button Resets the MasterSwitch Plus without affecting the outlet status.
Rear Panel masterswitch plus O ST R USER’S GUIDE 8 7 6 5 4 3 2 PR ES E ES T 120 VAC 60 HZ Item Function Power Cord Provides input power to the MasterSwitch Plus (120 VAC 60 HZ). Circuit Breaker Press the button to reset the circuit breaker. Outlet Label Relates each outlet to its corresponding basic port. Outlets Eight controllable outlets that provide power to connected equipment.
Link-RX/TX (10/100) LED This LED indicates the network status. Condition Description Off One or more of the following situations exist: • The Management Card is not receiving input power. • The device that connects the Management Card to the network is turned off or not operating correctly. • The Management Card itself is not operating properly. It may need to be repaired or replaced. Contact APC Worldwide Customer Support.
Status LED Condition Description Off The MasterSwitch Plus has no power. Solid Green The MasterSwitch Plus has valid TCP/IP settings. Flashing Green The MasterSwitch Plus does not have valid TCP/IP settings.1 Solid Orange A hardware failure has been detected in the MasterSwitch Plus. Contact APC Worldwide Customer Support. Flashing Orange The MasterSwitch Plus is making BOOTP2 requests. 1 If you do not use a BOOTP server, see the MasterSwitch Plus Installation and Quick Start Manual (.
LED State Definition Off MasterSwitch Plus has no power. Solid green MasterSwitch Plus has valid network settings. Flashing green MasterSwitch Plus does not have valid network settings. See the Installation Manual for more information. Flashing red slowly MasterSwitch Plus is making a BOOTP request. Solid red MasterSwitch Plus has detected a hardware failure. Manual button The Manual button is used to cancel two different commands.
Watchdog Features Overview To detect internal problems and recover from unanticipated inputs, the unit uses internal, system-wide watchdog mechanisms. When it reboots itself to recover from an internal problem, a System: Warmstart event is recorded in the Event Log. The unit implements internal watchdog mechanisms to protect itself from becoming inaccessible over the network. For example, if the unit does not receive any network traffic for 9.
MasterSwitch Plus Properties Outlet properties Outlet properties are governed by two operating modes: Annunciator and Graceful Shutdown. Some outlet properties are common to both control modes, while other properties are specific to an operating mode.
MasterSwitch Plus configuration MasterSwitch Plus behaviors The diagrams, starting with Unit/Outlet start-up sequence, define the behaviors for every event recognized by the MasterSwitch Plus unit. You customize the unit‘s behavior by choosing specific values for the unit and outlet properties. All outlet and unit properties on the diagrams are a highlighted hotlink that lead you to the property’s definition. All outlet and unit properties are defined in MasterSwitch Plus Menus.
Used in Sequence Diagram Device Confirm Graceful shutdown sequence, Graceful shutdown sequence for On-battery events, Graceful shutdown sequence for environment alarms, and Graceful reboot sequence Power Off Delay Graceful shutdown sequence, Graceful shutdown sequence for On-battery events, Graceful shutdown sequence for environment alarms, and Graceful reboot sequence Restart Delay Graceful shutdown sequence Power On Delay Unit/Outlet start-up sequence, Graceful shutdown sequence, Graceful shutdown
Property Power Off Delay Used in Sequence Diagram Graceful shutdown sequence for On-battery events, Graceful shutdown sequence for environment alarms, and Graceful reboot sequence Annunciator Graceful shutdown sequence for environment alarms and Annunciator sequence for environment alarms masterswitch plus USER’S GUIDE Alarm Action Delay ® 17
Unit/Outlet start-up sequence Power is applied to MasterSwitch Plus Unit Property‡ Power On Time Delay‡ Expires or You issue a Cancel Command Outlet Property† Annunciator Graceful Shutdown Initial State† Does the configuration contain a UPS? On Outlet is turned on masterswitch plus USER’S GUIDE Outlet Control Mode† Off No Outlet is turned off Yes UPS is operating on AC power UPS exceeds Battery Capacity Threshold† or You issue a Battery Capacity Threshold Override command When power is applie
Graceful shutdown sequence Outlet is on You issue a Graceful Shutdown command Is there a cable connected to the Basic Port? No Yes Device Confirm† Outlet Property† Yes No Server confirms shutdown masterswitch plus USER’S GUIDE MasterSwitch Plus asserts AC Fail and Low Battery signals Power Off Delay† Expires Outlet is turned off Shutdown Restart Restart Delay† Graceful Shutdown is a coordinated effort between MasterSwitch Plus and the connected device to shutdown the device in an orderly manner
Graceful shutdown sequence for On-battery events UPS indicates AC power restored or Cancel command is issued Outlet is on UPS indicates AC power failure MasterSwitch Plus Asserts AC Fail Signal Low Battery Warning Control† Never Programmed Delay Expires On Runtime Remaining UPS runtime remaining falls below UPS Low BatteryWarning Threshold x Low Battery Multiplier † Is there a cable connected to the Basic Port? Outlet is turned off No Yes Device Confirm† Outlet Property† masterswitch plus USER’S
Graceful shutdown sequence for environment alarms Outlet is turned on Environmental Monitor asserts alarm Alarm Action Delay† expires Is the alarm still active? Yes Outlet Property† No Yes No Device Confirm† Yes No MasterSwitch Plus asserts AC Fail and Low Battery signals Server confirms shutdown masterswitch plus USER’S GUIDE Is there a cable connected to the Basic Port? Power Off Delay† expires Shutdown Restart Outlet is turned off Environmental Monitor clears alarm Does the configuration co
Annunciator sequence for environment alarms Outlet in initial (non-alarm) state Environment alarm is asserted Outlet Property† Is the alarm still active? Yes masterswitch plus USER’S GUIDE Alarm Action Delay† expires No Outlet state is toggled to alarm state. Environment alarm is cleared Outlet state is toggled to initial/alarm state. This diagram sequences the events that an outlet set to Annunciator will follow when your Environmental Monitor issues an alarm.
Delayed On sequence Outlet is off You issue a Delayed On command Power On Delay† masterswitch plus USER’S GUIDE Remain Off Delay You issue a Cancel command Power On Time Delay expires Outlet remains off Outlet is turned on Outlet Property† This diagram sequences the events that an outlet will follow when you issue a Delayed On command. The sequence is an on-demand operation that requires you to choose a value for the Power On Delay property.
Reboot sequence Outlet is on You issue an Immediate Reboot command masterswitch plus USER’S GUIDE Outlet is turned off You issue a Cancel command Reboot Duration† expires Outlet remains off Outlet is turned on Outlet Property† This diagram sequences the events that an outlet will follow when you issue an Immediate Reboot command. The sequence is an ondemand operation that requires you to choose a value for the Reboot Duration property.
Graceful reboot sequence Outlet is on You issue a Graceful Reboot command Is there a cable connected to the Basic Port? No Yes Device Confirm† Yes No Server confirms shutdown Unit Property‡ Outlet Property† masterswitch plus USER’S GUIDE MasterSwitch Plus asserts AC Fail and Low Battery signals Power Off Delay† expires Outlet is turned off Shutdown Restart *All rebooted outlets are shut down This diagram sequences the events that an outlet will follow when you issue a Graceful Reboot command.
Control Console How to Log On Overview 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 Manager). If you cannot remember your user name or password, see How to Recover From a Lost Password. masterswitch plus USER’S GUIDE You can use either a local (serial) connection, or a remote (Telnet) connection to access the control console.
Local access to the control console You can use a local computer that connects to the MasterSwitch Plus through the serial port on the front of the unit. 1. Select a serial port at the local computer, and disable any service which uses that port. 3. Run a terminal program (such as HyperTerminal) and configure the selected port for 2400 bps, 8 data bits, no parity, 1 stop bit, and no flow control. Save the changes. 4. Press ENTER twice to display the User Name prompt. masterswitch plus USER’S GUIDE 2.
Main Screen Example main screen The main screen that is displayed when you log on to the control console of a MasterSwitch Plus. American Power Conversion Network Management Card AOS v1.1.6 (c) Copyright 2002 All Rights Reserved MSP APP v1.0.
• Three fields identify the system Name, Contact, and Location values. Name : MS Plus Rack 14 Contact : Bill Cooper Location : Data Center To set the Name, Contact, and Location values, see System Menu. Up Time : 0 Days 0 Hours 43 Minutes • Two fields identify when you logged on, by Date and Time. Date : 6/20/2003 Time : 10:16:58 • A User field identifies whether you logged on as Administrator or Device Manager.
Main screen status fields. • A Stat field reports the MasterSwitch Plus status. masterswitch plus USER’S GUIDE Stat : P+ N+ A+ P+ The APC operating system (AOS) is functioning properly. N+ The network is functioning properly. N? A BOOTP request cycle is in progress. N– The MasterSwitch Plus failed to connect to the network. N! Another device is using the IP address of the MasterSwitch Plus. A+ The application is functioning properly. A– The application has a bad checksum.
Control Console Menus Menu structure The menus in the control console list options by number and name. To use an option, type the corresponding number and press ENTER, then follow any on-screen instructions.
Main menu The main control console menu has options that provide access to the management features of the control console: 1234- Device Manager Network System Logout When you log on as Device Manager or as an Outlet User, you will not have access to the System or Network menus. Device Manager option This option accesses the Device Manager menu. Select the units you want to manage from this menu, each connected MasterSwitch Plus is available from this menu.
System option masterswitch plus USER’S GUIDE To do any of the following tasks, see System Menu: • Control Administrator and Device Manager access • Define the system Name, Contact, and Location values • Set the date and time used by the MasterSwitch Plus • Restart the MasterSwitch Plus • Reset control console settings to their default values • Access system information about the MasterSwitch Plus ® 33
Web Interface How to Log On You can use the DNS name or System IP address of the unit for the URL address of the Web interface. Use your case-sensitive user name and password settings to log on (by default, apc and apc, for an Administrator, or device and apc, for a Device Manager). For information about the Web page that appears when you log on to the Web interface, see Summary Page.
Supported Web browsers Some Web interface features (data verification, MD5 authentication, data log, and event log) require that you enable the following for your Web browser: • JavaScript • Java • Cookies In addition, the unit cannot work with a proxy server. Therefore, before you can use a Web browser to access its Web interface, you must do one of the following: • Configure the Web browser to disable the use of a proxy server for the unit.
URL address formats If the error “You are not authorized to view this page” occurs (Internet Explorer only), another user is logged on to the Web interface or control console. If the error “No Response” (Netscape) or “This page cannot be displayed” (Internet Explorer) occurs, Web access may be disabled, or the unit may use a non-default Web-server port that you did not specify correctly in the address. For more information, see FTP Server, and Telnet & Web options.
Summary Page When you log on to the Web interface at the MasterSwitch Plus, the status view is displayed at the right side of the screen, the quick status tab is displayed at the upper right, and the navigation menu is displayed at the left. Status • MasterSwitch Plus Status shows the status of each connected MasterSwitch Plus, MasterSwitch Plus expansion unit, and Environmental Monitoring Unit.
Quick status tab The quick status tab is displayed in the upper right of every screen in the Web interface. The tab displays a warning of any alarms and provides a link to the online help. Click the green “device operating normally” icon to return to the status screen where the status for attached devices is displayed. Click the “attention required” icon to return to the status screen where active warnings and alarms are displayed.
Navigation Menu Overview When you log on to the Web interface, the navigation menu (left frame) includes the following elements: • IP address of the unit • MasterSwitch Plus menus to manage the unit and its components – Outlets menu • Menus to manage the event log, data log, network connection, and system parameters – Events menu – Data menu masterswitch plus USER’S GUIDE – MasterSwitch Plus menu (for each attached unit) – Network menu – System menu When you log on as a Device Manager, the Network and
Select a menu to perform a task To do the following, see the Outlets Menu: • Control power to any of the individual AC outlets on the rear panel of the unit. • Control power to all of the AC outlets on the rear panel of the unit. To do the following, see the MasterSwitch Plus Menus: • Set the device name. • Set outlet names and modes. • Enable and disable environmental alarm actions. To do the following, see Event-Related Menus: • Access the event log.
• Set the date and time used by the unit. • Restart the unit. • Reset control console settings to default settings. • Define the URL addresses of the user links and APC logo links in the web interface, as described in Links menu. When you click Help, the Contents for all of the online help is displayed. However, from any Web interface pages, you can use the question mark (?) in the quick status bar to link to the section of the online help for that page.
Links menu To redefine these links so that they point to other URLs: 1. Click on Links in the System menu. 2. Define any new names for User Links. 3. Define any new URL addresses that you want User Links to access. Only HTTP links may be defined. 4. Click Apply. masterswitch plus USER’S GUIDE Provides three user-definable URL link options. By default, these links access the following APC Web pages: • APC’s Web Site accesses the APC home page.
MasterSwitch Plus Menus Outlets Menu Control Outlets To control individual outlets, select a Control Action for each outlet under the individual outlets heading, and click Apply. Control console. To control all outlets at once, select the MasterSwitch Plus unit you want to control from the Device Manager menu, and select option 9 - ALL Outlets. Select Outlet Control and a control action. Type YES and press ENTER to execute the change. masterswitch plus USER’S GUIDE Web interface.
Available Modes Action Name Description Delayed On Apply power to the outlet after its Power On Delay expires. Only available in graceful shutdown mode. Graceful Shutdown Only Immediate Off Immediately removes power from an outlet. Annunciator Graceful Reboot masterswitch plus USER’S GUIDE Graceful Shutdown Removes and then reapplies power to an outlet.
Available Modes Action Name Description Shutdown Removes power and then optionally reapplies power to an outlet. If the server is not connected to the MasterSwitch Plus, MasterSwitch Plus will remove power from the outlet after the Power Off Time Delay expires. Specify a Restart delay to reapply power automatically.
Configure Outlets Control console. To configure outlets individually, select the MasterSwitch Plus unit you want to control from the Device Manager menu, and select the outlet you want to configure. Select Outlet Configuration and choose a configuration setting from the list. Select Accept Changes to apply the new settings. masterswitch plus USER’S GUIDE Web interface. Click the outlet number link (for example 1:3) and make changes to Outlet Name, Outlet Mode, and Outlet Links.
Description Power On Delay Determines the time interval between the triggering event and power being applied to the outlet. Reboot Duration The delay between removing power from an outlet because of a reboot and reapplying power to an outlet. Alarm Action Delay The amount of time that an Environment alarm must be asserted before the unit reacts to the alarm. Battery Capacity Threshold Sets the minimum percentage of Battery Capacity required of the UPS before power can be applied to an outlet.
MasterSwitch + Menu Device Config (Outlet Config in Control Console) masterswitch plus USER’S GUIDE Web interface. To set the name of the device, the Power On Delay for the outlets for this device, and to disable or enable the Manual button on the front of the MasterSwitch Plus, select the MasterSwitch + menu, change the setting you wish to modify, and click Apply.
masterswitch plus USER’S GUIDE Control console. To set the name of the device, the Power On Delay for the outlets for this device, and to disable or enable the Manual button on the front of the MasterSwitch Plus, select the Device Manager menu. Select the MasterSwitch Plus or expansion unit you want to modify and then select ALL Outlets. Change the Name/Location, Manual Button, and Power On Time Delay fields, and then select Accept Changes to apply the new settings.
Configure Environmental Alarms Web interface. Click the Outlet Config menu under the MasterSwitch Plus unit you want to configure. Select the Environmental alarms to enable or disable by selecting the checkboxes under each Enable/Disable Environment Alarm Actions heading: • Zones 1–4 • Probe 1 Click the Apply button under each heading to accept the changes.
masterswitch plus USER’S GUIDE Setting Definition Probe 1 Humidity High Limit Controls the humidity high limit alarm for the first temperature and humidity probe. Probe 1 Temp Low Limit Controls the temperature low limit alarm for the first temperature and humidity probe. Probe 1 Temp High Limit Controls the temperature high limit alarm for the first temperature and humidity probe. Probe 2 Humidity Low Limit Controls the humidity low limit alarm for the second temperature and humidity probe.
Managing the Expansion Unit Introduction If you have purchased only the MasterSwitch Plus Expansion Unit (AP9225 EXP) and your configuration does not include an AP9225, you can configure the Expansion Unit through MasterSwitch Plus internal menus. Local access to the control console You can use a local computer that connects to the MasterSwitch Plus through the serial port on the front of the unit. masterswitch plus USER’S GUIDE Overview 1.
Navigating the internal interface The MasterSwitch plus menus allow you to manage the MasterSwitch Plus expansion unit and an Environmental Monitoring Card. All menus list items by number and name. • To enter a selection on any of the menus, type its related one- or twocharacter command and press ENTER. • To return to the previous screen, press ESC. • To exit the MasterSwitch Plus internal menus, type Q (case-sensitive) at the Main menu.
masterswitch plus USER’S GUIDE Main Menu Item Description Version Displays the version of the MasterSwitch Plus firmware. Unit Name Identifies the MasterSwitch Plus unit that has been accessed. NOTE: The Unit Name can be changed in the Unit Properties menu. UPS State Displays the status of the UPS. The possible states are: • Inactive — UPS is in sleep mode. • On Line — UPS is operating normally. • AC Fail — UPS is operating on battery. • Unknown — Communication with UPS has failed.
masterswitch plus USER’S GUIDE Item Description To Change Units Instructs you to enter a I to access the next MasterSwitch Plus unit in the cascading setup. To Change Outlet States Instructs you to enter various commands to initiate on-demand outlet actions. After entering a command, you will be asked to enter an outlet number (1– 8) to perform the action on the associated outlet or you will be asked to enter an A to perform the action on all of the outlets.
masterswitch plus USER’S GUIDE Unit Properties Menu Item Description Name Set the name of this MasterSwitch Plus unit. A maximum of 23 printable ASCII characters is allowed. Address Specify the unit’s address (1– 4) in a cascading setup. Enter 1 for the unit connected closest to the UPS, 2 for the unit adjacent to unit 1, and so on for up to four units. See the Installation and Quick-Start manual for instructions on setting up Expansion Unit addresses.
Outlet Properties Menu Overview MasterSwitch Plus has eight Outlet Properties menus—one for each outlet. To access these menus, enter an outlet number (1– 8) from the Main menu. The Outlet Properties menu varies according to the Outlet Control mode setting of the chosen outlet. masterswitch plus USER’S GUIDE Graceful Shutdown menu items Item Definition Outlet Name Identifies each outlet. Outlet Control Mode Establishes mode for associated outlet.
Definition Battery Capacity Threshold Sets the minimum percentage of Battery Capacity required of the UPS before an outlet can be turned on. Enable/Disable UPS Alarms Environment Alarm Masks: Indicates whether or not an outlet will react to a specific Environment alarm. Select Another Outlet Allows you choose another outlet to configure. Alarm Action Delay The amount of time that an Environment alarm must be asserted before the unit reacts to the alarm.
masterswitch plus USER’S GUIDE Environmental Monitoring Card menu Item Description Temp (Celcius) Displays the current ambient temperature reading of each attached probe. Temperature is displayed in nn.nn degrees Celsius. Humidity Displays the current relative humidity reading of each attached probe. Humidity is displayed in nnn.n% relative humidity. Low Limit Allows you to disable or set the low alarm threshold for temperature and humidity for each probe.
Event-Related Menus Introduction Overview • Access the event log • Define the actions to be taken when an event occurs, based on the severity level of that event – Event logging – SNMP trap notification masterswitch plus USER’S GUIDE The Events menu provides access to the options that you use to do the following tasks: – E-mail notification You can use only the Web interface to define which events will use which actions, as described in Event Log and How to Configure Individual Events.
Menu options In the Web interface, all of the events options are accessed through the Events menu. In the control console, access the available events-related options as follows: • Use the SNMP option in the Network menu to define the SNMP trap receivers. • Use CTRL-L to access the event log from any menu. For information on the following topics, use these links: • Event Log masterswitch plus USER’S GUIDE • Use the Email option in the Network menu to define the SMTP server and e-mail recipients.
Event Log Overview The unit supports event-logging for all Network Management Card application firmware modules.
Logged events Some System (Network Management Card) events do not have a severity level. Even if you disable the event log for all severity levels, events with no severity level will still be logged. To access a list of the System (Network Management Card) and MasterSwitch Plus (Device) events, see Event List page. masterswitch plus USER’S GUIDE By default, any event which causes an SNMP trap will be logged, except for SNMP authentication failures.
Control console Press CTRL-L to display up to 300 events from the event log, in reverse chronological order. Use the SPACE BAR to scroll through the recorded events. While viewing the log, type d and press ENTER to clear all events from the log. . How to use FTP to retrieve log files You can use FTP to retrieve a tab-delineated event log (event.txt) file that you can import into a spreadsheet application. • The file reports all of the events (event.txt) recorded since the log was last deleted.
Server in the Network menu has been changed from its default value (21), you must use the non-default value in the FTP command. For some FTP clients, you must use a colon to add the port number to the end of the IP address. For Windows FTP clients, use the following command (including spaces): ftp>open ip_address port_number 2. Use your case-sensitive user name and password to log on as either an Administrator or a Device Manager User.
Event Actions (Web Interface Only) Overview • SNMP Traps selects which severity levels cause SNMP traps to be generated. See SNMP traps action. • Email selects which severity levels cause e-mail notifications to be sent. See Email action. Click Details to access a complete list of the System (Network Management Card) and Device (MasterSwitch Plus) events that can occur, and then edit the actions that will occur for an individual event, as described in How to Configure Individual Events.
Severity levels Except for some System (Network Management Card) events that do not have a severity level, events are assigned a default severity level based on their seriousness: • Informational: Indicates an event that requires no action, such as a notification of a return from an abnormal condition. • Severe: Indicates an event that requires immediate attention. Unless resolved, severe Device and System events can cause incorrect operation of the unit or its Network Management Card.
To define up to four NMSs as trap receivers, see Event Recipients. Email action By default, the Email action is enabled for all events that have a severity level assigned. However, before you can use e-mail for event notifications, you must define the e-mail recipients. \ masterswitch plus USER’S GUIDE See E-mail Feature.
Event Recipients Overview The Web interface and control console both have options that allow you to define up to four trap receivers and up to four e-mail addresses to be used when an event occurs that has the SNMP traps or e-mail enabled. Trap receiver settings To define which NMSs will receive traps: • In the Web interface, use the Recipients option of the Events menu. • In the control console, use the SNMP option in the Network menu.
E-mail Feature Overview You can use the Simple Mail Transfer Protocol (SMTP) to send e-mail to up to four recipients when an event occurs.
DNS servers The unit cannot send any e-mail messages unless the IP address of the primary DNS server is defined (see DNS servers). Once you define the IP addresses of the DNS servers, verify that DNS is working correctly. Enter the DNS name of a computer on your network to test whether you can look up the IP address for that DNS name. SMTP settings masterswitch plus USER’S GUIDE The unit will wait a maximum of 15 seconds for a response from the primary or (if specified) the secondary DNS server.
Email recipients In the Web interface, the Recipients option of the Events menu or the Configure the Email recipients link in the Email Configuration page accesses the settings you use to identify up to four e-mail recipients. In the Web interface, use the Email Test option to send a test message to a configured recipient. masterswitch plus USER’S GUIDE In the control console, the Email option of the Network menu accesses the e-mail recipients settings.
masterswitch plus USER’S GUIDE Setting Description SMTP Server Selects one of the following methods for routing e-mail: • Through the SMTP server provided with the unit (the recommended option, Local). This option ensures that the e-mail is sent before the 20-second time-out for the unit, and, if necessary, is retried several times. Also do one of the following: • Enable forwarding at the SMTP server provided with the unit so that it can route e-mail to external SMTP servers.
How to Configure Individual Events Event List page Modifying events on the Configure Event Action by Severity Level page, will override any changes you have made to individual events on the Details page. Each event is identified by its unique code, its description, and its assigned severity level. For example: masterswitch plus USER’S GUIDE The Actions option in the Events menu opens the Event Action Configuration page on the Web interface.
System Menu Introduction Overview • Configure system identification, date and time settings, and Administrator, Device manager, and Outlet user access • Synchronize the real-time clock for the unit with a Network Time Protocol (NTP) server • Reset or restart the unit • Define the URL links available in the Web interface masterswitch plus USER’S GUIDE Use the System menu to do the following tasks: • Access hardware and firmware information about the unit • Download configuration files (control console on
Menu options • • • • • Identification Date & Time Tools Links (Web interface) About System The About System option is a Help menu option in the Web interface.
Option Settings User Manager masterswitch plus USER’S GUIDE Use this option to define the access values shared by the control console and the Web interface, and the authentication used to access the Web interface. Setting Definition Auto Logout The number of minutes (3, by default) before a user is automatically logged off because of inactivity. Authentication The Basic setting (default) causes the Web interface to use standard HTTP 1.
Outlet Manager Use the Outlet User Manager option to set up user accounts that have access only to certain outlets masterswitch plus USER’S GUIDE Web interface. Choose a user name, or choose Add New User to edit accounts. Setting Definition User Name The name of this user account Note: A user name in orange indicates that the user account has been disabled.
masterswitch plus USER’S GUIDE Setting Definition Disable Outlet User Account Enter the name of the outlet user account to disable. Enable Outlet User Account Enter the name of the outlet user account to enable. Edit Users Outlet Access Select the outlets to which users have access: 1. Enter the outlet user name you want to modify. 2. Select the numbers of the outlets to which the outlet user will have access: • Add outlet access by entering each number and pressing ENTER after each one.
Date & Time Use this option to set the date and time used by the MasterSwitch Plus. The option displays the current settings and allows you to change those settings manually or through a Network Time Protocol (NTP) Server. Set Manually. Use this option in the Web interface, or Manual in the control console, to set Date and Time for the MasterSwitch Plus.
Synchronize with Network Time Protocol (NTP) Server. Use this option on the Web interface, or Network Time Protocol (NTP) on the control console, to have an NTP Server automatically update the Date and Time settings for the MasterSwitch Plus. masterswitch plus USER’S GUIDE In the control console, use the NTP Client option to enable or disable the NTP Server updates. In the Web interface, use the Set Manually option. The updates are disabled by default.
Definition Reset to Defaults Except TCP/IP Resets all configuration settings except the TCP/IP settings. Reset Only TCP/IP to Defaults Resets the TCP/IP settings only. This option will not enable DHCP and BOOTP. XMODEM (serial connection only) Allows you to download firmware using a terminalemulation program when you use a local connection to the control console. To connect to the control console locally, see Local access to the control console.
About System This option identifies the following hardware information for the unit: Model Number, Serial Number, Hardware Revision, Manufacture Date, and MAC Address. This screen also displays the Name, Version, Date, and Time for the Application Module and AOS. The control console also includes fields for system Flash Type, and the Type, Sector, and CRC 16 for each module. In the Web interface, except for Flash Type, this hardware information is reported by the About System option in the Help menu.
Network Menu Introduction Overview • Define TCP/IP settings, including BOOTP server settings, when a BOOTP server is used to provide the needed TCP/IP values • Use the Ping utility • Define settings that affect the FTP, Telnet, Web interface, SNMP, E-mail, and DNS features of the MasterSwitch Plus. masterswitch plus USER’S GUIDE Use the Network menu to do the following tasks: Only an Administrator has access to the Network menu.
Option Settings TCP/IP Use this option to enable or disable BOOTP, and when BOOTP is disabled, to define the three TCP/IP settings that the MasterSwitch Plus needs to operate on the network. • System IP address for the unit • IP address of the default gateway For information about the watchdog role of the default gateway, see Resetting the network timer. masterswitch plus USER’S GUIDE • Subnet mask value When BOOTP is enabled (the default setting), you can affect only the BOOTP setting.
Current TCP/IP settings fields. The current values for System IP, Subnet Mask, Default Gateway, the MAC Address, Host Name, and the Domain Name for the MasterSwitch Plus are displayed with the TCP/IP settings in the control console and Web interface. The Ethernet Port Speed is displayed on the Web Interface only. For more information about how to use BOOTP, see the Addendum provided on the APC MasterSwitch Utility CD. For more information on using BOOTP and DHCP, see Boot Mode.
DNS Configure Domain Name Service Settings fields. Use these fields to define the IP addresses of the primary and secondary Domain Name Servers (DNS) used by the MasterSwitch Plus e-mail feature. Send DNS Query (Web interface only). Use this option, available only through the TCP/IP & DNS menu in the Web interface, to send a DNS query that tests the setup of your DNS servers. Use the following settings to define the parameters for the test DNS request.
Ping utility (control console) Select this option, available only in the control console, to check the network connection by testing whether a defined IP address responds to the Ping network utility. masterswitch plus USER’S GUIDE By default, the IP address of the default gateway is used. However, you can use the IP address of any device known to be running on the network.
FTP Server, and Telnet & Web options The Telnet and Web options are combined in the Web interface but separate in the control console. To enhance the protection provided by User Name and Password settings, change the Port setting to a unique port number from 5000 to 32767. After this change, when you log on, you must add a colon (:) (or a space, depending on your Telnet client) and the number of the non-default port to the IP address used.
SNMP An Access option (the Settings option in the control console) enables (by default) or disables SNMP. When SNMP is enabled, the Access Control settings allow you to control how each of the four available SNMP channels is used. masterswitch plus USER’S GUIDE To define up to four NMSs to serve as trap receivers, see Trap receiver settings. Setting Definition Community Name Defines the password (maximum of 15 characters) that an NMS defined by the NMS IP setting uses to access the channel.
Email Use this option to define two SMTP settings (SMTP Server and From Address) used by the e-mail feature of the MasterSwitch Plus. masterswitch plus USER’S GUIDE For more information about these settings, see SMTP settings; for more information about the e-mail capability of the MasterSwitch Plus, see E-mail Feature.
Security Security Features As a network device that passes information across the network, the MasterSwitch Plus is subject to the same exposure as other devices on the network. Use the information in this section to plan and implement the security features appropriate for your environment.
Summary of access methods masterswitch plus USER’S GUIDE Interface Security Access Notes Serial Control Console Access is by user name and password. Always enabled. Telnet Control Console These methods are available: • User name and password • Selectable server port • Server Enable/Disable The user name and password are transmitted as plain text.
Authentication Authentication versus encryption For a security method that provides additional authentication for the Web interface, but does not provide the higher security of encryption, use Message Digest 5 (MD5) Authentication. Firewalls masterswitch plus USER’S GUIDE You can select to use security features for the MasterSwitch Plus that control access by providing basic authentication through user names, passwords, and IP addresses, without using encryption.
Boot Mode Introduction Overview The method used to provide the network settings for the unit depends on Boot mode, a TCP/IP option in the Network menu. To use a DHCP server to provide the network assignment for the unit, Boot mode must be set to either DHCP & BOOTP, its default setting, or DHCP only.
When Boot mode is set to its default DHCP & BOOTP setting, the following occurs when the MasterSwitch Plus is started or reset: 1. The MasterSwitch Plus makes up to five requests for its network assignment from any BOOTP server. If a valid BOOTP response is received, the unit starts the network services and sets Boot mode to BOOTP Only. 2.
DHCP Configuration Settings MasterSwitch Plus settings The TCP/IP option in the Network menu of the Web interface and control console accesses the network settings for the MasterSwitch Plus.
When Boot mode is set to DHCP Only, two options are available: • DHCP Cookie Is in the control console (or Require vendor specific cookie to accept DHCP Address in the Web interface): By default, this option requires that the DHCP responses include the APC cookie in order to be valid. • Retry Then Stop in the control console (or Maximum # of Retries in the Web interface): This option sets the number of times the MasterSwitch Plus will repeat the DHCP request if it does not receive a valid response.
DHCP response options Each valid DHCP response contains options that provide the TCP/IP settings that the MasterSwitch Plus needs to operate on a network, and other information that affects the operation of the unit. Vendor Specific Information (option 43). The Vendor Specific Information option contains up to two APC specific options encapsulated in a TAG/LEN/DATA format: the APC Cookie and the Boot Mode Transition. APC Cookie.
This option 43 setting enables or disables the After IP Assignment option which, by default, causes the Boot mode option to use the setting that reflects the server that provided the TCP/IP settings (DHCP Only or BOOTP Only): • For a data value of 1, the After IP Assignment option is disabled, and the Boot mode option remains in its DHCP & BOOTP setting after successful network assignment.
masterswitch plus USER’S GUIDE TCP/IP options. The MasterSwitch Plus uses the following options within a valid DHCP response to define its TCP/IP settings: • IP Address (from the yiaddr field of the DHCP response): Provides the IP address that the DHCP server is leasing to the unit. • Subnet Mask (option 1): Provides the subnet mask value needed by the unit to operate on the network. • Default Gateway (option 3): Provides the default gateway address needed by the unit to operate on the network.
Product Information Warranty and Service APC warrants the MasterSwitch Plus to be free from defects in materials and workmanship for a period of two years from the date of purchase. Its obligation under this warranty is limited to repairing or replacing, at its own sole option, any such defective products. This warranty does not apply to equipment that has been damaged by accident, negligence, or misapplication or has been altered or modified in any way.
Warranty limitations Except as provided above, in no event will APC be liable for direct, indirect, special, incidental, or consequential damages arising out of the use of this product, even if advised of the possibility of such damage. Specifically, APC is not liable for any costs, such as lost profits or revenue, loss of equipment, loss of use of equipment, loss of software, loss of data, costs of substitutes, claims by third parties, or otherwise.
daytime phone number; a copy of the sales receipt; and a check as payment, if applicable. 5. Mark the RMA number clearly on the outside of the shipping carton. masterswitch plus USER’S GUIDE 6. Ship by insured, prepaid carrier to the address provided by the Customer Support technician.
Life-Support Policy General policy American Power Conversion (APC) does not recommend the use of any of its products in the following situations: • In direct patient care. APC will not knowingly sell its products for use in such applications unless it receives in writing assurances satisfactory to APC that (a) the risks of injury or damage have been minimized, (b) the customer assumes all such risks, and (c) the liability of American Power Conversion is adequately protected under the circumstances.
Index A C About System 41 Access Client ID setting 97 Community Name 69 setting 90 Configuring Access Type setting 90 Actions 66 Advanced settings Client ID 97 Domain Name 97 Host Name 97 Port Speed 97 User Class 97 Vendor Class 97 Annunciator masterswitch plus USER’S GUIDE limiting NMS SNMP access by IP address 90 proxy server before using Web interface 35 Control Action immediate off 44 Control console Device Manager menu 32 navigating menus 31 refreshing menus 31 Cookie APC 99 sequence for e
DHCP Address setting 97, 98 response options 99 Retry Then Stop setting 98 Event log 67 disabling 67 event.
System 40 I Identification fields on main screen 29 Immediate Off 44 IP addresses Network menu E-mail (control console) 72 NMS IP setting 90 O L On-battery Events Life support 105 Links OS, APC 41 redirecting user-definable links 42, 82 Local SMTP Server 73 Logging on error messages for Web interface 36 Web interface 34 masterswitch plus USER’S GUIDE of DNS server for e-mail 70 of trap receivers 69 to limit access to specified NMSs 90 N graceful shutdown sequence 20 P Paging by using e-ma
XMODEM 82 S Community Name setting 90 NMS IP setting 90 SNMP traps option 67 Status on control console main screen 30 System information, obtaining 41 masterswitch plus USER’S GUIDE Secondary NTP Server 81 Severity levels (of Events) None 67 SMTP From Address 71 Server 71 SMTP Server 71 SNMP Access Type setting 90 Authentication Traps 69 System menu About System option (control console) 41 Tools 81 User Manager 77 T TCP/IP Client ID setting 97 Current settings fields 86 Domain Name setting 97 Hos
W Web interface logging on 34 logon error messages 36 Up Time 37 URL address formats 36 X masterswitch plus USER’S GUIDE XMODEM 82 ® 110
APC Worldwide Customer Support Connect to localized APC Web sites for specific countries, each of which provides customer support information. – www.apc.com/support/ Global support with FAQs, knowledge base, and e-support. • Contact an APC Customer Support center by telephone or e-mail.
Entire contents copyright © 2003 American Power Conversion. All rights reserved. Reproduction in whole or in part without permission is prohibited. APC, the APC logo, MasterSwitch Plus, and PowerNet are trademarks of American Power Conversion Corporation and may be registered in some jurisdictions. All other trademarks, product names, and corporate names are the property of their respective owners and are used for informational purposes only.
