SWC FullManual
SWC FullManual
StruxureWare Central
Version 7.0.0
To use the full-featured demo version of the StruxureWare Central virtual appliance, you download the *.ova file from the APC web site, and deploy it to your virtualization platform using the default hardware configuration. For more information, see StruxureWare Central virtual appliance equivalent configurations. The demo version monitors a maximum of five device nodes and one surveillance node by default. To monitor 25 device nodes, add license keys to monitor additional nodes, or activate supported applications, you must upgrade the StruxureWare Central virtual appliance demo to the production version. Note: You can add an additional network adapter to enable private networking, or add additional hard disks to increase storage, after the OVA template is deployed. To upgrade the demo to the production version, you must purchase and apply a production license key, available on the APC web site. To monitor additional device nodes or activate supported applications, you must purchase and apply node license keys and application license keys for the virtual appliance. To migrate a StruxureWare Central hardware server to a virtual appliance, you must purchase and apply a production license key, and contact APC Support for new node license keys and application license keys for the virtual appliance. To receive these keys, you are required to provide a unique MAC address and serial number for the StruxureWare Central virtual appliance, and for the StruxureWare Central hardware server you are replacing. A unique serial number is generated for the StruxureWare Central virtual appliance at startup. It is displayed in the "About StruxureWare Central" display, accessed from the Help menu. Note: The serial number for a StruxureWare Central hardware server appears only on its serial number sticker. A printable document is available on the APC web site that fully describes deploying the StruxureWare Central virtual appliance, and the upgrade and migration processes, including how to purchase and apply the production license.
After you select the sensors you want to include in the virtual sensor, you identify a name for the virtual sensor, and specify the device group in which you want to create its virtual device parent. For each virtual sensor created, a virtual device parent is also created and added to the Device View and the Map View. You can right-click the Virtual Device parent, and select View Device Sensors to view the virtual sensor. You can view all the virtual sensors monitored by the StruxureWare Central server in the Virtual Sensors view. Note: You cannot create a virtual sensor directly from sensors you manually added to the Map View. Both physical and virtual devices are included in the device count in the Device View, and the status bar at the bottom of the display. Virtual devices are not included in the Used Node Count in the "License Keys" display, accessed from the Server Administration Settings option in the System menu. Right-click options, and button icons at the top of the view, perform the following functions: Create a virtual sensor in the specified device group ( Create Virtual Sensor option or icon). Modify the name of the virtual sensor, and add or delete sensors included for the selected virtual sensor ( Edit Virtual Sensor option or icon). Remove the selected virtual sensor from the StruxureWare Central server ( Delete Virtual Sensor option or icon). Generate a report or graph for the historical values of the selected virtual sensor ( Generate Sensor History Report option or icon). Create thresholds for the selected virtual sensor ( Create Threshold option). Note: For information about this option, see Create Thresholds option, under Alarm Configuration. Identify the selected virtual sensor in the Device View or Map View ( Select Virtual Device option). Four menus provide access to create a virtual sensor: Right-click menu Create Virtual Sensor in the Device Groups view of the Monitoring perspective. Right-click menu Create Virtual Sensor in the Device View of the Monitoring perspective. Right-click menu Create Virtual Sensor in the Map View of the Monitoring perspective. Create Virtual Sensor, an option in the Device menu.
About Help
Help is available at any time, and can be viewed and invoked in a variety of ways. Relevant topics can be printed from the Help browser window. You can choose to open help in a separate Help browser window by selecting Help Contents in the Help menu, or you can choose to open the Help view for the currently selected view by selecting Dynamic Help in the Help menu, or by pressing F1. This Help view provides access to information directly related to the selected view, and when a different view is selected, it automatically updates to provide access to help for the new view. Context-sensitive help is also available in displays: clicking the question-mark (?) button in the lower-left corner adds a version of the Help view to the display that provides access to information directly related to that display.
Help menu
This menu's options access the online help in a separate Help browser, search and dynamic help in a Help view, and copyright and version information. Help Contents Search Help Dynamic Help Opens the online help in a separate Help browser window. Opens the search function in the Help view. Opens the Help view with access to context-sensitive information about the currently selected view. Opens the "About StruxureWare Central" display which provides copyright and version information, and the MAC address and serial number of the StruxureWare Central server.
Console features
The StruxureWare Central server creates a consolidated view of your network's physical infrastructure layer. Real-time device monitoring, custom reporting capabilities, private networking, advanced security and immediate event notification all enable quick assessment and resolution of critical situations. The StruxureWare console provides your StruxureWare Central client access to the server functions and features. This console has the following major elements: An application bar that provides access to Monitoring, Surveillance, Alarm Configuration, Reports , and Power Management perspectives and views Seven main menus ( File, Device, Alarm Configuration, Updates, System, Window, and Help) Note: Right-click menus are also available in the perspectives and views. A status bar at the bottom of the display
Monitoring
This perspective opens with five views displayed, by default. Device Groups view: used in this perspective to create the device groups to which monitored devices can be assigned, and to select a device group to view or manage its devices.
Device View: lists the devices assigned to the group selected in the Device Groups view, provides information about those devices, and launch to management applications at some of those devices. Map View: displays icons for the devices in the group selected in the Device Groups view, each icon providing quick access to information about its sensor values; the icons, which are displayed against a user-definable background, can be repositioned and resized. Active Alarms view: provides information about any alarms that exist for the devices assigned to the group selected in the Device Groups view. Virtual Sensors view: allows users with Device Administrator or Server Administrator to create, modify, and delete virtual sensors. You can use the Window menu to add any other views to the Monitoring perspective. Alarm History view: allows you to review the alarms that occurred during a specified period of time, for all devices within a selected device group, or for a device, or set of devices, selected in that group. Custom Properties Editor view: allows you to add, edit, or remove custom property keys, and modify their value, on devices and sensors selected in the Device View or Map View. Note: The value of a custom property key must be modified one device or sensor at a time. Saved Discoveries view: allows you to run or schedule previously performed or new processes used to discover and add devices to the list of devices the StruxureWare Central server monitors. Firmware Update Status view: allows you to view information about the status of ongoing update processes for monitored SNMP devices and NetBotz Appliances. Device Configuration Status view: allows you to view information about the status of ongoing configuration processes for monitored SNMP devices and NetBotz Appliances. InfraStruxure Manager Migration Status view: allows you to view messages about the status of an ongoing InfraStruxure Manager Migration in table format.
Surveillance
This perspective opens with two views displayed, by default. Note: For more information about how the identified views are used for surveillance functions, see Surveillance perspective. Thumbnails view: provides thumbnail views and identification information for the surveillance equipment. Device Groups view: used in this perspective primarily to select a device group to view the thumbnails for that group's surveillance equipment.
Alarm Configuration
This perspective opens with two views displayed, by default. Navigation view: provides a list of device groups and devices monitored by the StruxureWare Central server, and allows you to create thresholds by device or by device group, and add them to notification policies. Threshold Alarm Configuration view: provides a list of thresholds associated with the device group or device selected in the Navigation view, and allows you to modify thresholds by type or by device, and add them to notification policies.
Device Alarm Configuration view: provides a list of device alarms associated with the device group or device selected in the Navigation view, and allows you to modify alarms by type or on the device that reports the alarm. Notification Policies view: allows you to create and edit the policies used by the StruxureWare Central server to generate alarm notifications, and view the thresholds you have added to those policies.
Reports
This perspective opens with the Available Reports displayed by default, including Sensor History Reports, Snapshot Reports , and Saved Sensor Reports. When an available report is generated, that report appears in its own view. Snapshot Reports include: Battery Age Device Type Inventory Environmental Humidity Environmental Temperature UPS Runtime
Power Management
This perspective provides access to PowerLogic ION Enterprise WebReach and Web Reporter. When ION Enterprise integration has been enabled on the StruxureWare Central server, depending on the version you chose in the ION Enterprise Settings display, the ION Enterprise server view will display either WebReach (version 5.6 or earlier), with read-only access, or the PowerLogic ION Enterprise server login dialog (version 6.0 and later).
Main menus
A menu bar immediately below the console title bar provides seven menus, with options that control or configure StruxureWare Central features and functions.
Menu File
Options Change Server: closes the session, and accesses the " StruxureWare Central Logon" display. Reboot Server: reboots the StruxureWare Central server. Note: When a reboot finishes, an e-mail is sent to the StruxureWare Central Administrator users that include an e-mail address as part of their user credentials. Shut Down Server: shuts down the StruxureWare Central server. Client Preferences: accesses settings specific to the StruxureWare Central client you use. Exit: closes the StruxureWare Central client.
Menu Device
Options Add Devices: accesses the "Device Discovery" wizard used by the Device discovery processes. Create Virtual Sensor: accesses options to create a virtual sensor used to monitor the average or total value of multiple numeric sensors of the same sensor type. SNMP Device Communication Settings: accesses options used to configure various functions for how the StruxureWare Central server communicates with, and monitors, SNMP devices. Modbus Device Communication Settings: accesses options used to configure various functions for how the StruxureWare Central server communicates with, and monitors, Modbus devices. Note: Modbus support is a separately-licensed feature. NetBotz Appliance Communication Settings: accesses options used to configure various functions for how the StruxureWare Central server communicates with, and monitors, NetBotz Appliances. NetBotz Appliance Configuration: accesses an Alert Settings option used to define the alert notifications generated by each monitored NetBotz Appliance, as well as options used to configure various functions at the monitored NetBotz Appliances. APC SNMP Device Configuration: accesses settings used to select an APC SNMP device or saved configuration file, and use it to configure settings at the other APC SNMP Devices monitored by the StruxureWare Central server. Manage Custom Property Keys: accesses settings used to create, modify, or remove user-created property keys for monitored devices. Surveillance Settings: accesses settings used to configure various functions for the surveillance devices at monitored NetBotz Appliances. Note: Surveillance support is a separately-licensed feature.
Alarm Configuratio n
Defines how the StruxureWare Central server performs notifications when thresholds and device alarms are triggered for its monitored devices. Create Thresholds: accesses options used to define the threshold alarms for devices monitored by the StruxureWare Central server. Create Notification Policy: accesses settings used to create a notification policy used by the StruxureWare Central server to generate alarm notifications. Manage Alarm Actions: accesses settings used to create, modify, and delete alarm actions from the StruxureWare Central server. Network Management System Integration: accesses settings used to enable the StruxureWare Central server to send SNMPv1/SNMPv3 traps to defined Network Management System consoles for alarms that occur at the monitored SNMP, Modbus, and NetBotz Appliances, and associated devices. Remote Monitoring Service: accesses settings used to register the StruxureWare Central server for the Remote Monitoring Service (RMS) support available from APC, and to select the devices you want RMS to monitor.
Reports
Provides options used to generate Sensor History reports and Snapshot reports, and manage the export configurations that are used to export reports on a scheduled basis. Generate Sensor History Report: accesses the "Report Criteria" display used to generate Sensor History and Custom Sensor History reports.
Menu
Options Snapshot Reports: generates the selected snapshot report for the device groups specified. Manage Export Scheduling: accesses the display used to schedule when reports will be automatically exported.
Updates
Provides options used to update the StruxureWare Central server and its monitored NetBotz Appliances and SNMP devices. Apply Firmware Updates: accesses the "Select Device Update" display used to download firmware updates to monitored NetBotz Appliances or SNMP devices. Apply Server Updates: accesses the "Apply Server Update" display used to update the StruxureWare Central server. Schedule Update Checks: accesses settings used to schedule when the StruxureWare Central server will check for available APC device firmware updates.
System
Server Administration Settings: accesses options used to configure a wide range of StruxureWare Central server functions. Users and Device Group Access: accesses the "Users and Device Group Access" display used to manage the users, the Monitoring and Surveillance access those users have to the device groups, and the authentication servers that provide remote access to the StruxureWare Central server. Building Management Settings: accesses settings used to configure the MODBUS TCP Output Module support that allows a Building Management System to monitor status for the devices managed by the StruxureWare Central server. Note: MODBUS TCP Output Module support is a separately-licensed feature. ION Enterprise Settings: identifies settings used to access PowerLogic ION Enterprise WebReach and Web Reporter on your ION Enterprise server. InfraStruxure Manager Migration Utility: accesses the utility used to migrate settings from an InfraStruxure Manager to a new StruxureWare Central server.
Window
Provides a Restore Default Screen Layout: option that restores the selected perspective to its default views and layout, and five categories of options that access views of the same name that are used in the Monitoring, Surveillance, and Alarm Configuration perspectives. Alarms: Active Alarms and Alarm History Alarm Configuration: Navigation, Notification Policies, Threshold Alarm Configurations, and Device Alarm Configurations Device: Device Groups, Device View, Map View, Virtual Sensors, Saved Discoveries, Custom Properties Editor, Device Configuration Status, and Firmware Update Status. Surveillance: Thumbnails only InfraStruxure Manager Migration: InfraStruxure Manager Migration Status only
Help
Provides options used to access the help, and information about the application. Help Contents: opens the help in a separate window with the top item in the table of contents selected. Search Help: opens the search function in the Help view.
10
Menu
Options Dynamic Help: opens the Help view with information about the view selected in the Monitoring, Surveillance, Alarm Configuration, Reports , or Power Management perspective. About StruxureWare Central : opens the display which provides software version and build numbers, the MAC address and serial number of the StruxureWare Central server, and copyright information.
Status bar
Reports information about the StruxureWare Central server. Each type of information can be clicked to access a related view or display. Information
Device status
Description
How many devices have a warning or critical condition.
Clicking this area accesses the "Logged on Users" display that identifies all users logged on at the server. Note: A lock icon is displayed in the status bar when the user is logged on using SSL.
Devices The number of devices the StruxureWare Central server is monitoring.
11
Option
Detached Restore Move Size
Description
Detaches the view, creating an unanchored, free-floating view. Currently disabled. Allows you to move a view to anywhere else within the selected perspective. Highlights the side of the view you want to use to resize the view: Right, Left, Top, or Bottom. Note: The sides of the view which can actually be used to resize that view will be the only enabled options.
12
6.
7.
8.
9.
10.
a. Select Server Administration Settings > E-mail Settings in the System menu. b. Define the Primary and Secondary tab settings, as needed. Enable the SOCKS server feature to enable communication with any devices you want to monitor on the private LAN, if necessary. a. Select Server Administration Settings > Server Access in the System menu. b. Enable the SOCKS Server option in the SOCKS Proxy tab. Add a remote NFS or Windows share repository the StruxureWare Central server can use instead of the local repository. a. Select Server Administration Settings > Storage Settings in the System menu. b. Use the Repositories tab to add a remote repository. c. Use the Purge Settings tab to define the purge settings you want the repository to use. Define at least one NFS or Windows share location to be used for backup files of the StruxureWare Central server configuration data, or its configuration and repositories data. a. Select Server Administration Settings in the System menu. b. Select Server Backup/Restore in the "Server Administration Settings" display. c. Identify the NFS or Windows share location at which backup files will be saved. d. Schedule how often those files will be created automatically. Note: By default, backup files will be created every Friday at 1:00 AM. Discover the SNMPv1, SNMPv3, Modbus devices, and NetBotz Appliances you want your server to monitor. Note: All four device types require their own discovery process, not only on the public LAN, but on the private LAN, as well. a. Select Add Devices in the Device menu, or click the green + icon in the Device View. b. Select which type of device you want to discover (SNMPv1, SNMPv3, NetBotz Appliance, or Modbus TCP), and click Next. c. Define the parameters to be used for the discovery process. d. Run the discovery process. e. Repeat steps a through d, as needed, to discover all the types of devices you want the StruxureWare Central server to monitor (SNMPv1, SNMPv3, NetBotz Appliance, or Modbus TCP), on both the public and private LANs. Define any or all the alarm notifications you want available to the StruxureWare Central server for any SNMPv1, SNMPv3, and Modbus devices discovered during step 9. Note: Additionally, each NetBotz Appliance has its own unique profiles it can use for alarm conditions at the devices it monitors (see step 13). The StruxureWare Central server has a Default notification policy. Device alarms and communication link status thresholds for all monitored devices are included in the Default notification policy at device discovery. You must create at least one alarm action, and add it to the Default notification policy, or another notification policy you create, before the StruxureWare Central server can generate alarm notifications for conditions that occur at monitored SNMP and Modbus devices. a. Select Manage Alarm Actions in the Alarm Configuration menu. b. Click Create to access the Alarm Action wizard. c. In the "Choose Alarm Action Type" display, select the type of alarm you want to create, and click Next. d. In the "Configure Alarm Action" display for the selected action, define the settings you want the action to use, and click Finish to exit the wizard. 14
11. Add alarm actions to the Default notification policy. a. In the Alarm Configuration perspective, in the Notification Policies view, select the Default notification policy. Right-click and select Edit. Note: To create a new notification policy, right-click or use the Create Notification Policy icon. b. Click Add to configure the alarm actions to add to the notification policy. Click Manage Actions to create alarm actions, or modify or remove existing alarm actions on the StruxureWare Central server. Note: You click Choose Thresholds to add user-created thresholds, for the device groups or devices selected, to the Default notification policy . Communication link status thresholds for monitored SNMP and Modbus devices are added to the Default notification policy at device discovery. c. Check-mark one or more actions to configure their notification options, checkmark the actions you want to add to the notification policy, and click OK. 12. Create thresholds for sensor types supported by monitored devices. a. Select the sensor type on which you want to add a threshold from the Create Thresholds option in the Alarm Configuration menu. Alternatively, select a device group or device, and right-click to select the Create Thresholds option. b. In the "Select Threshold Type" display, select the threshold type you want to add, and click Next. c. In the "Select Sensors" display, select the sensor or sensors for which you want to add thresholds, and click Next. d. In the "Create Threshold" display, define the settings, and, if desired, click Threshold Scheduling to configure when the StruxureWare Central server will generate notifications if the threshold becomes active. Click Next. e. In the "Select Notification Policies" display, select the notification policies to which you want to add the alarm threshold, and click Finish to exit the wizard. 13. Define any or all the alert actions you want available to any NetBotz Appliances discovered during step 9, to associate with the alert profiles used for alert notifications. Each NetBotz Appliance has its own unique profiles it can use for alarm conditions at the devices it monitors. Note: An alert action must be available to the StruxureWare Central server, and to each monitored NetBotz Appliance, for use with their alert profiles. a. Select Alert Actions, a NetBotz Appliance Configuration > Alert Settings option in the Device menu. b. In the "Select Alert Action Type" display, select an action. c. In the "Select Next Action" display, select Create a new alert action. d. In the "Select Next Action Devices" display, select the devices for which the action can be used. e. Define the action settings. f. In the "Choose Next Action" display, select Configure another alert action to repeat steps b through e, as needed, to finish defining all the alert actions for your StruxureWare Central server and monitored NetBotz Appliances. 14. Add at least one alert action to the one of the alert profiles used by each NetBotz Appliance for alert notifications. Note: The profiles at a NetBotz Appliance may have been defined already using its NetBotz Advanced View. You can edit it to make sure someone in your organization is notified when problems occur. a. Select Alert Profiles, a NetBotz Appliance Configuration > Alert Settings option in the Device menu. b. In the "Select Parent Device" display, select the parent device (the individual NetBotz Appliance) associated with the profile you want to configure. c. In the "Select Alert Profile" display, select the alert profile you wish to modify, and click Next.
15
d. Configure the alert profile to include at least one of the alert actions available to the selected parent device. e. Repeat steps a through d to add at least one alert action to the alert profile used by each monitored NetBotz Appliance.
16
Define how often you want the StruxureWare Central server to check for firmware updates available from APC, using Schedule Update Checks in the Updates menu. Configure the settings the StruxureWare Central server will use to log on to the web interface at the monitored devices, using the right-click Device Launch Settings option in either the Device View or Map View. Generate and manage graph or table-formatted reports for device sensors, using the Saved Reports view, or the right-click Generate Sensor History Report option in the Device Groups view, Device View, and Map View. Configure the StruxureWare Central server to send SNMPv1traps and SNMPv3 informs to defined Network Management System consoles for alarms that occur at the monitored SNMP, Modbus, and NetBotz Appliances, and associated devices, using Network Management System Integration in the Alarm Configuration menu. Configure settings at one or more of the monitored APC SNMP devices, using APC SNMP Device Configuration in the Device menu. Select devices to enable for Modbus support, a separately licensed feature, using the Building Management Settings option in the System menu. Configure settings used to integrate the StruxureWare Central server with PowerLogic ION Enterprise using the ION Enterprise Settings option in the System menu.
17
using the default hardware configuration. For more information, see StruxureWare Central virtual appliance equivalent configurations. The demo version monitors a maximum of five device nodes and one surveillance node by default. To monitor 25 device nodes, add license keys to monitor additional nodes, or activate supported applications, you must upgrade the StruxureWare Central virtual appliance demo to the production version. Note: You can add an additional network adapter to enable private networking, or add additional hard disks to increase storage, after the OVA template is deployed. To upgrade the demo to the production version, you must purchase and apply a production license key, available on the APC web site. To monitor additional device nodes or activate supported applications, you must purchase and apply node license keys and application license keys for the virtual appliance. To migrate a StruxureWare Central hardware server to a virtual appliance, you must purchase and apply a production license key, and contact APC Support for new node license keys and application license keys for the virtual appliance. To receive these keys, you are required to provide a unique MAC address and serial number for the StruxureWare Central virtual appliance, and for the StruxureWare Central hardware server you are replacing. A unique serial number is generated for the StruxureWare Central virtual appliance at startup. It is displayed in the "About StruxureWare Central" display, accessed from the Help menu. Note: The serial number for a StruxureWare Central hardware server appears only on its serial number sticker. A printable document is available on the APC web site that fully describes deploying the StruxureWare Central virtual appliance, and the upgrade and migration processes, including how to purchase and apply the production license.
You must provide the MAC Address, IP Address, hostname, and network settings before using the StruxureWare Central virtual appliance. 1. Select the StruxureWare Central virtual appliance you created, and select the option to edit the virtual machine settings. 2. Specify the MAC Address for the virtual appliance manually.
18
3. 4. 5. 6. 7.
A unique MAC Address is required for each StruxureWare Central . If the MAC Address originally assigned to the virtual appliance is changed, an error will occur on the primary interface, and the virtual appliance will not start. Power on the virtual appliance. In the console view, login to the virtual appliance using apcsetup as the username and password. Within five seconds, press m to modify the settings. Follow the prompts to specify the IP Address, hostname, subnet mask, and DNS servers for the virtual appliance. After the virtual appliance has restarted, type its IP Address or hostname into a browser to login to the StruxureWare Central client.
You can add one additional network adapter to enable private networking. You cannot remove a network adapter once it has been added. 1. Gracefully shut down the virtual appliance. 2. Select the StruxureWare Central virtual appliance, and select the option to edit the virtual machine settings. 3. Select the options to add an ethernet adapter. 4. Specify the type and the network connection. Ensure this connection is mapped correctly, particularly when the DHCP server will be enabled on the private network interface. Power on the virtual appliance. In the console view, login to the virtual appliance using apcsetup as the username and password. Within five seconds, press m to modify the settings. Accept the settings you configured previously, or modify settings if needed. Press y to accept the Enable private network interface option. Specify whether you want to enable the DHCP server on the private network interface.
5. 6. 7. 8. 9. 10.
19
Changes in the disk space will take effect once the StruxureWare Central virtual appliance has restarted. Do not shut down the virtual appliance while the disk reconfiguration process is running. The "Storage Settings" display, accessed from the Server Administration Settings option in the System menu, shows the total storage space available for the virtual appliance, not the individual hard disks. Note: To store large amounts of surveillance data, using a remote repository is recommended.
20
About changing hardware resource settings for the StruxureWare Central virtual appliance
After you have deployed the OVA, you can make changes to the StruxureWare Central virtual appliance settings from your virtualization platform client interface. You use apcsetup as the username and password. Network settings: You can configure an additional network adapter to enable the private network (APC LAN) as the apcsetup user or through the StruxureWare Central client. MAC Address settings: A unique MAC address is required for each StruxureWare Central virtual appliance. If the MAC address originally assigned to the primary or secondary network interface is changed, an error will occur on the primary interface, and the virtual appliance will not start. A message will be displayed indicating the MAC address expected before normal startup will be allowed. Hard disk settings: To increase storage for the virtual appliance, you can create additional hard disks. You cannot change the size of an existing hard disk, or remove a hard disk once it has been created. An error will occur on the primary interface, and the StruxureWare Central virtual appliance will not start. Changes in the disk space will take effect once the StruxureWare Central virtual appliance has restarted. The "Storage Settings" display, accessed from the Server Administration Settings option in the System menu, shows the total storage space available for the virtual appliance, not the individual hard disks. Note: To store large amounts of surveillance data, using a remote repository is recommended. RAM settings: You can add RAM to the StruxureWare Central virtual appliance. You must gracefully shut down the virtual appliance to configure the settings. CPU settings: You can add CPUs to the StruxureWare Central virtual appliance. You must gracefully shut down the virtual appliance to configure the settings. Note: VMware supports fault tolerance on virtual machines with 1 CPU only. Please refer to your vendor's documentation for more information about fault tolerance.
Nodes
Up to 325 device nodes
2 GB RAM 1 CPU
2 GB RAM 2 CPU
21
4 GB RAM 4 CPU
Note: VMware supports fault tolerance on virtual machines with 1 CPU only. Please refer to your vendor's documentation for more information about fault tolerance. The disk space required to monitor a given number of nodes varies according to the device types monitored and the amount of data you want to store. The minimum hard disk size is 18 GB. To determine whether to add another hard disk, you can view available disk space in the "Storage Settings" display, accessed from the Server Administration Settings option in the System menu. View this display periodically to help determine how quickly the virtual appliance consumes disk space. Note: To store large amounts of surveillance data, using a remote repository is recommended.
VMware supports fault tolerance on virtual machines with 1 CPU only. Please refer to your vendor's documentation for more information about fault tolerance. Node Count
Up to 325 device nodes supported
2 GB RAM 1 CPU
Note: The actual number of device nodes supported varies according to the device types discovered.
For information about supported configurations equivalent to StruxureWare Central Basic, Standard, and Enterprise servers, see StruxureWare Central virtual appliance equivalent configurations. Demo Configuration (minimum) Hardware Resources
1 GB RAM
22
Hardware Resources 1 TB disk 4 GB RAM 16 CPU 2 network adapters Thin or thick provisioning
Note: The actual number of device nodes supported varies according to the device types discovered. Note: VMware supports fault tolerance on virtual machines with 1 CPU only. Please refer to your vendor's documentation for more information about fault tolerance.
Virtual Appliance Equivalent Up to 525 device nodes supported Up to 250 GB disk 1 GB RAM 2 CPU
23
Description
Define the address that will identify that the emails are sent by the StruxureWare Central server. Identify the hostname or IP address of the Simple Mail Transport Protocol (SMTP) server to be used by the StruxureWare Central server. Identifies the number of the port at the SMTP server used for communication with the StruxureWare Central server. Select to use the Secure SMTP protocol for communication between the StruxureWare Central and SMTP servers. Select to define the Username and Password, the StruxureWare Central server must use to log on at the SMTP server. Note: Enable this option only when using an SMTP server that requires logon access.
SMTP Server
Port
You access this display from the Server SSL Certificates option in Server Administration Settings, a System menu option.
24
When you select NetBotz Appliance in the device discovery process, and select the security mode Require SSL, validate certificates option, use this display to add the certificate from the NetBotz Appliance you want to discover to the StruxureWare Central server first. Otherwise, device discovery will not complete successfully. Adding and removing server SSL certificates does not require the StruxureWare Central server to reboot. Element
List
Description Subject: The name of the certificate. Issued to (Organization): The name of the organization to which the certificate was issued. Issued by (Organization): The name of the organization that issued the certificate. Issued on: The date the certificate was issued. Expires on: The date the certificate expires.
Accesses the display used to import a certificate from a file, or paste a certificate into the text field. Remove the selected certificate from the StruxureWare Central server. View details of the selected certificate.
InfraStruxure Operations, InfraStruxure Change, InfraStruxure Capacity, MODBUS TCP Output Module, and the Surveillance feature are examples of applications that need to have license keys entered at the StruxureWare Central server. Energy Cost Management and Energy Efficiency license keys are also available for use with InfraStruxure Operations. The InfraStruxure Operations license key must be added before you can add the Energy Efficiency or Energy Cost Management license keys. Note: A 10-node InfraStruxure Operations license key is included on StruxureWare Central Standard and Enterprise servers. Element
List
Description
Identifies the license keys by License Type, the number of devices each license enables the server to monitor ( Node Count), and how many of those devices are being monitored ( Used Node Count). Click to add a license key to the list. Click to view information about the selected license key, and copy it into a document.
25
Type
License Type Node Count Used Node Count Installed On Expires On Expired License Key
Description
Identifies the selected license by type. The number of devices the license enables the server to monitor. The number of monitored devices using the license. The date the license was installed on the server. The date the license will expire, if any. Whether or not the license has expired. The unique key associated with the license.
Description
Identify the StruxureWare Central server's hostname. Identify the public network address of the server. Identify the TCP/IP subnet address for the server's local network segment. Identify the IP address of the gateway. Identify the name of the network domain on which the server resides.
26
Primary DNS
Identify the IP address of the primary Domain Name Service (DNS) server used to map IP addresses to domain names. Identify the IP address of the DNS server used when the primary DNS server is busy or off-line. Identify the IP address of the DNS server used when the primary and secondary DNS servers are busy or off-line.
Description
Identify the private network address of the StruxureWare Central server. Identify the TCP/IP subnet address for the local network segment. Note: When Enable Private DHCP LAN is selected, the Subnet Mask selection defines this address; otherwise, type in the subnet mask's IP address. Select to use the StruxureWare Central server as a Dynamic Host Configuration Protocol (DHCP) server for the devices on the private LAN, Network A, enabled by default. Define the range of IP addresses available to the DHCP LAN.
The first two parts of the four-part IP addresses are defined by the IP Address value, while the last two parts are initially defined by the Subnet Mask selection.
Note: You can edit the last 2 IP address values, except you cannot increase the Ending IP Address value: Total available addresses changes to Invalid IP range if you do. Subnet Mask A list of subnet mask addresses, each providing a different Starting and Ending IP Address range.
27
Identifies how many addresses are available, based on the Starting and Ending IP Address range.
Apply server time zone offset on Private LAN Check-mark to assign the StruxureWare Central server's timezone offset to the devices on the private LAN.
Description
Select to use Network B on the StruxureWare Central server private LAN for devices with static IP addresses. Identify the private network address of the StruxureWare Central server private LAN Network B, 192.168.16.1 by default. Identify the TCP/IP subnet address for the private LAN network B segment, 255.255.255.0 by default; otherwise, type in the subnet mask's IP address.
IP Address
Subnet Mask
Description
Enable Private DHCP Discovery: select to enable the StruxureWare Central server to automatically discover any SNMPv1 devices, or devices that use the APC DCal1 protocol, on the private network. All other private network devices can be discovered by a device discovery process that searches the private network's IP addresses.
28
Read Community Name: define the name to be used to discover SNMPv1 devices ( public is the default).
Trap Registration On Discovery, Register for Priority Scanning (SNMP Trap Directed Polling): select to register the StruxureWare Central server as a trap receiver at a selected APC SNMPv1 device. This allows for faster reporting of errors at that device by the server: as a trap receiver, the server will poll the device as soon as it receives an SNMPv1 trap from that device; as a non-trap receiver, the server reports device alarms during normal scan intervals only. Note: Only APC SNMPv1 devices discovered after this option is selected have the StruxureWare Central server registered as a trap receiver.
Write Community Name: define the name that can be used to register the StruxureWare Central server as a trap receiver at discovered APC SNMPv1 devices ( private is the default).
Reset APC Devices Click to reset private LAN APC devices, on Network A only, to use new IP addresses. Note: The Write Community Name is used to reset the APC devices.
Note: Enabling and disabling HTTP or HTTPS access, or changing the ports used, can prevent devices from providing data to your StruxureWare Central server. Option
Enable HTTP Port
Description
Select to enable the StruxureWare Central server to use HTTP, a non-secure Internet protocol, for web communication at the defined IP port.
29
Select to enable the StruxureWare Central server to use HTTPS, a secure Internet protocol, for web communication at the defined IP port.
Note: IP ports 1 - 65535 are valid, with the exception of ports 20, 21, 22, 23, 25, 123, 161, 162, and 389. These are ports reserved for use by NetBotz Appliances and by well-known protocols. Using these reserved ports creates a conflict that can result in operational difficulties.
SSL Certificate
This section provides information about the current SSL certificate, and allows you to modify that certificate, or, when a 3rd-party signed certificate is used, delete that certificate. The StruxureWare Central server generates a default, self-signed SSL certificate that can be used for secure HTTPS web communication. Two buttons are available to manage this certificate: Modify Certificate: used to access the "Modify Server SSL Certificate" wizard to add or create a new certificate. Note: Only enabled when the default, self-signed SSL certificate is in use. Delete Signed Certificate: used to remove a signed 3rd-party SSL certificate and revert back to using the default SSL certificate generated by the StruxureWare Central server. Note: Only enabled when the default, self-signed SSL certificate has been replaced by a 3rd-party certificate.
Modifying the SSL certificate
You can use the "Modify Server SSL Certificate" wizard to create or add a new certificate. You also can create a certificate signing request to send to a certificate signing authority.
4. In the "Copy Certificate Signing Request" display, copy the provided CSR text to a text file. Note: You can manually select the text and use Ctrl+C, or right-click anywhere in the text to use the Select All and Copy options, to copy the CSR text. 5. Submit the CSR to the appropriate 3rd-party certificate authority for signing. 6. Use the Add Certificate option in the "Choose Certificate Action" display to add the newly signed certificate at the StruxureWare Central server.
Use this wizard's displays to create self-signed certificates, add signed Secure Socket Layer (SSL) certificates that the StruxureWare Central server can use for secure, SSL-based HTTPS web communication, and to create a certificate signing request to send to a certificate signing authority.
Note: The resulting SSL certificate can be imported to the StruxureWare Central server using the Add Certificate option in the "Choose Certificate Action" display.
Description
Select to allow SSH access to the StruxureWare Central server. Select to start SSH whenever the server is turned on or rebooted.
Element
Enable SNMP Agent Read-only Community Name Read/Write Community Name Port
Description
Select to enable the SNMP agent settings. Define the community name used for read-only SNMP requests. Define the community name used for read and write SNMP requests. Identify the number of the port used for SNMP agent communication.
32
Identify the contact person for the StruxureWare Central server. Identify the location of the StruxureWare Central server.
Description
Lists the backup entries by Destination Server and provides information about each entry.
Backup Type: what data will be saved in backup files: Full: all server data (configuration and repository) will be saved in every backup file. Synchronized: only changes to server data (configuration and repository) will be saved after the initial backup file. Configuration: only server configuration data will be saved in every backup file. Schedule Enabled: whether or not backup scheduling is enabled. Scheduled Days/Time: when automatic backups will occur. Current Status: Whether or not a backup is in progress.
Backup Details Backup Progress Provides information about the backup entry selected in the list. Provides information about ongoing backup activity.
33
Add Backup Edit Backup Remove Backup Start Backup Stop Backup
Click to add a backup entry to the list. Click to edit the backup entry selected in the list. Click to remove the backup entry selected in the list. Click to manually start a backup using the entry selected in the list. Click to stop a manually-started backup. Note: An backup-cancelled e-mail will be sent to the StruxureWare Central Administrators that include an e-mail address as part of their user credentials. Click to use the "Restore from Backup" wizard to select a backup file to be used to restore the StruxureWare Central server.
Use this display to select Windows Share or NFS as the remote mount type for the saved backup file.
34
Use this display to add or edit the settings for a Windows share used to backup the StruxureWare Central server's configuration data, or its configuration and repository data.
Element
Server Hostname or IP Username Password Verify Password Domain Share Subdirectory
Description
Identity the hostname or IP address of the Windows share server. Identify the username required to access the server. Identify the password required to access the server. Retype the password. Identify the domain to which the Windows share is connected. Identify the name of the Windows share. Identify the subdirectory in the Windows share that will be used to store data. Note: If no subdirectory is specified, data will be stored in the share's root directory. Select the type of backup that will be performed.
Backup Type
Full: each backup file will contain all server configuration and repository data.
Synchronization: the first backup file will contain all server configuration and repository data, while subsequent files will contain only new or changed data.
Configuration: each backup file will contain all server configuration data, but no repository data.
Test Mount Click to test the Windows share settings.
Use this display to add or edit the settings for a NFS share used to backup the StruxureWare Central server's configuration data, or its configuration and repository data.
Element
Server Hostname or IP Share Subdirectory
Description
Identity the hostname or IP address of the NFS share server. Identify the name of the NFS share. Identify the subdirectory in the NFS share that will be used to store data. Note: If no subdirectory is specified, data will be stored in the share's root directory. Select the type of backup that will be performed.
Backup Type
35
Full: each backup file will contain all server configuration and repository data.
Synchronization: the first backup file will contain all server configuration and repository data, while subsequent files will contain only new or changed data.
Configuration: each backup file will contain all server configuration data, but no repository data.
Test Mount Click to test the NFS share settings.
Use this display to schedule when the StruxureWare Central server's configuration data, or its configuration and repository data, will be backed up automatically.
Element
Schedule Enabled
Description
Select to have the StruxureWare Central server data backed up automatically as defined by the Days and Time settings. Select the day, or days, the backups will occur. Select the time of day the backups will occur.
Days Time
You can use the "Restore from Backup" wizard to select a backup file at the NFS or Windows share at which the StruxureWare Central server saved that file. 1. 2. 3. 4. In the "Choose Backup Location Type" display, select Existing Backup Location. In the "Existing Backup Location" display, select the listed location. In the "Restore from Backup" display, select the listed backup file, and click Finish. Click OK when asked if you want to use the data from a previous date to restore your server. Note: The server will restart as a result of the restore process. You can log on after the server finishes rebooting, which can take a few minutes.
36
You can use the "Restore from Backup" wizard to select a backup file at the NFS or Windows share at which the StruxureWare Central server did not save that file. 1. In the "Choose Backup Location Type" display, select New Backup Location and either Windows Share or NFS. 2. In the appropriate display, identify the Windows Share ("New Windows Backup Location" display) or NFS Share ("New NFS Backup Location" display) location of the backup file. 3. In the "Restore from Backup" display, select the listed backup file, and click Finish. 4. Click OK when asked if you want to use the data from a previous date to restore your server. Note: The server will restart as a result of the restore process. You can log on after the server finishes rebooting, which can take a few minutes.
Use this display to choose the location of the backup file you want to use to restore the StruxureWare Central server's configuration data, or its configuration and repository data.
Option
Existing Backup Location
Description
Select to locate a backup file at a location that has been used to save your StruxureWare Central server data. Select to locate a backup file from an archived location, a location where the current backup files are not being saved.
Use this display to select the location of the backup file from the list.
Use this display to select the listed backup file you want to use to restore the StruxureWare Central server. Note: The Backup Source column identifies which server was the source of the backup file.
"New Windows Backup Location" display
Use this display to identify the Windows share location for the backup file you want to use to restore your StruxureWare Central server.
37
Element
Server Hostname or IP Username Password Verify Password Domain Share Subdirectory
Description
Identity the hostname or IP address of the Windows share server. Identify the username required to access the server. Identify the password required to access the server. Retype the password. Identify the domain to which the server is connected. Identify the name of the Windows share that contains the backup file. Identify the subdirectory in the Windows share that contains the backup file. Note: If no subdirectory is specified, the backup file is stored in the share's root directory.
Use this display to identify the NFS share location for the backup file you want to use to restore your StruxureWare Central server.
Element
Server Hostname or IP Share Subdirectory
Description
Identity the hostname or IP address of the NFS share server. Identify the name of the NFS share. Identify the subdirectory in the NFS share that will be used to store data. Note: If no subdirectory is specified, data will be stored in the share's root directory.
Description
Select to enable the proxy settings. Identify the hostname or IP address of the proxy server. Identify the port at the proxy server that the StruxureWare Central server will use to communicate with that server.
38
Identify the username to be used to access the proxy server. Identify the password to be used to access the proxy server. Click to make sure the StruxureWare Central server can access the identified proxy server using the proxy settings you define. Lists the internet addresses you want the StruxureWare Central server to be able to communicate with directly, without using the proxy server. Click to add the IP address of a host to the list. Click to remove a selected host from the list.
Add Remove
Repositories tab
Use this tab to manage the repositories the StruxureWare Central server can use, and review information about a selected repository. Element
List
Description
Lists the local and remote repositories, and identifies each repository's Status, Type, Maximum Capacity, and Conditions. Identifies the Type, Status, and Condition for the selected repository. Provides information about the current usage for the selected repository, as well as detail about the Type of data that can be stored, as well as the allotted capacity ( Size) and current usage ( Percentage) for each Type. Provides status information when something occurred at the server for the selected repository, such as the server went offline, or the an authentication ( Username or Password) value changed for a Windows repository. Note: This Status Message appears only when status at the selected repository's server has changed. If the problem persists, contact the Administrator for the affected repository server.
Details Usage
Status Message
39
Select to have the StruxureWare Central server limited to using a remote repository, only (disabled when no remote repository is available). Note: If the remote is offline, the server will store data in the local repository until the remote becomes available. Click to migrate the server configuration and repository data currently stored in the local repository to the remote storage repositories. Note: Disabled when no remote repository is available. Click to add a remote repository. Click to edit a selected remote repository. Click to remove a selected remote repository from the list.
Migrate to Remote
At least one remote repository should be defined and used by the StruxureWare Central server, rather than the local repository. Note: If your organization uses multiple StruxureWare Central servers, and Windows or NFS repository servers for remote storage, each StruxureWare Central server should use its repository server: multiple StruxureWare Central servers should not store data on the same remote repository. You can add, edit, or delete any remote repository, but not the local repository. Note: To delete a repository, select it in the Repositories tab, and click Delete Repository. 1. Select Server Administration Settings in the System menu. 2. In the "Server Administration Settings" display, select Storage Settings. 3. In the Repositories tab, select to edit or add a repository. To edit a repository, select the listed repository and click Edit Repository. To add a repository, click Add Repository and select Windows Repository or NFS Repository in the "Choose Repository Type" display. 4. In the appropriate settings display, do the following: a. Configure the Windows Share ("Windows Repository Settings" display) or NFS Share ("NFS Repository Settings" display) settings. b. Click Test Repository Settings. Note: An error message identifies why the test failed, if the share settings are defined incorrectly. c. Configure the File System settings, and click Finish. 5. Use the Purge Settings tab to define when data will be purged from all online repositories that are not in an error or read-only state.
This display has two sections and a Test Repository Settings button. This button must be used to test the Windows Share settings when adding a repository, or when changing more than the Repository Name during an edit of a repository. You will be unable to add or edit the File System settings until the test is successful. Note: The StruxureWare Central server will generate an error message that identifies why a test failed. If the problem persists, contact the Administrator for the repository server you are trying to use.
Element
Repository Name Server Hostname or IP Username Password Verify Password Domain Share Subdirectory
Description
Identify a name for the repository. Identity the hostname or IP address of the Windows share server. Identify the username required to access the Windows share. Identify the password required to access the Windows share. Retype the password. Identify the domain to which the Windows share is connected. Identify the name of the Windows share. Identify the subdirectory in the Windows share that will be used to store data. Note: If no subdirectory is specified, data will be stored in the root directory of the share.
Element
Enabled Read-only Free Space Maximum Capacity
Description
Select to enable the repository. Select if you want to allow only read access to the repository. Identifies how much free space is available for the repository. Identify the maximum capacity of the repository, based on the available Free Space. For example, if there is 79.85 gigabytes (GB) available, type in a number that is equal to, or
41
Element
Repository Name Server Hostname or IP Share Subdirectory
Description
Identify a name for the repository. Identity the hostname or IP address of the NFS share server. Identify the name of the NFS share. Identify the subdirectory in the NFS share that will be used to store data. Note: If no subdirectory is specified, data will be stored in the root directory of the share.
Element
Enabled Read-only Free Space Maximum Capacity
Description
Select to enable the repository. Select if you want to allow only read access to the repository. Identifies how much free space is available for the repository. Identify the maximum capacity of the repository, based on the available Free Space. For example, if there is 79.85 gigabytes (GB) available, type in a number that is equal to, or less than 79.85, and select GB from the dropdown menu.
42
Use this section to define the settings for the conditions that will cause an automatic purge of the repositories.
Type
Begin Purge End Purge Warn of Purge Send Warning E-mails
Description
Identify the percentage of total capacity that will initiate a purge. Identify the percentage of total capacity that will cause the purge to end. Identify the percentage of total capacity that will result in a warning that a purge may occur soon. Select to send e-mails to the StruxureWare Central Administrators that include an e-mail address as part of their user credentials, when the Warn of Purge threshold is reached. Click to save changes to the settings.
Manual Purge
Type
Purge Data Created On or Before
Description
Select the date for which all data stored on or before that date will be purged.
Choose the Types of Data to Manually Purge Select to include Alarm History Data, Alarm Binary Data, Sensor Data, Untagged or All Surveillance Data, or a combination of these choices, in the manual purge. Note: You can prevent tagged surveillance data from being purged by selecting Untagged
43
Surveillance Data instead of All Surveillance Data. Run Manual Purge Click to purge the selected data for the defined range of dates.
Description
Checkmark to select whether a Network Time Protocol (NTP) server you specify provides the date and time values for the StruxureWare Central server; otherwise, these values are defined by the Date and Time elements or Use Client Time. When selected, a Network Time Protocol (NTP) server you specify provides the date and time values for the StruxureWare Central server; otherwise, these values are defined by the Date and Time elements or Use Client Time. When selected, the NTP time is provided by the Date and Time elements or Use Client Time. Identify the IP address or hostname of at least one NTP server, when Use Remote NTP Server Time is selected. Define the date the server will use, when Enable StruxureWare Central as NTP Server is not selected, or when Enable StruxureWare Central as NTP Server and Set NTP Time Manually are selected.
Date
44
Time
Define the time the server will use, when Enable StruxureWare Central as NTP Server is not selected, or when Enable StruxureWare Central as NTP Server and Set NTP Time Manually are selected. Click to use your client time and date settings at the server, when Enable StruxureWare Central as NTP Server is not selected, or when Enable StruxureWare Central as NTP Server and Set NTP Time Manually are selected. Displays the current date, and can be used to define that date, when Enable StruxureWare Central as NTP Server is not selected, or when Enable StruxureWare Central as NTP Server and Set NTP Time Manually are selected.
Calendar
Description
Select the language the StruxureWare Central server will use for messages, such as e-mails. By default, the server uses the language associated with the Server Time Zone setting, or English (U.S.), if the associated language is not supported. Note: The server's measurements (metric or US standard) and date formats will be matched to the formats commonly used at the selected locale. Select to have the StruxureWare Central server use a 24-hour clock. Select the time zone in which the StruxureWare Central server is located.
45
Audio Settings
Use this option to select whether your StruxureWare Central client will play a sound when alerts occur.
Element
Play Sound when an Alert Occurs Select Provided Audio File
Description
Select to enable your client to play the sound for the Select Audio File selection. Select the sound you want your client to play from the drop-down list of files provided for the StruxureWare Central client. Browse to the AIFF, AU, WAV, or MIDI formatted audio file you want your client to play. Click to hear the sound for the Select Provided Audio File or Select Custom Audio File selection.
46
Browser Settings
Use this option to select the web browser your StruxureWare Central client will use to connect to the web interface at a monitored device.
Element
Use the Default OS Web Browser
Description
Select to use the operating system default web browser to open a browser window external to the StruxureWare Central client (the default). Select to use an alternate web browser to open a browser window external to the StruxureWare Central client. Identify the location of the alternate web browser executable file. Click to browse to the executable file for the web browser you want to use, if necessary, to select its Path. Click to verify that the selected browser can access the APC home page. Check-mark to use the StruxureWare Central client web browser to open a browser in a view inside the StruxureWare Central client (the default selection). Note: Use this option, when you specify Device Launch Settings, to automatically log in to the web interface of devices that use basic authentication. See "Device Launch Settings" display under Monitored Devices.
Path Browse
Test Browser Use the Internal Web Browser when Launching to Devices
The default setting is Use OS Locale, which selects to use the language associated with your client's location, if that language is supported. Otherwise, English is the default Use OS Locale language. Note: Server Locale, accessed by selecting Time Settings, a Server Administration Settings option in the System menu, allows you to select the language the StruxureWare Central server uses for its messages.
Use this option to select whether to show a popup option when a custom property is added, or to automatically add a column to the Device View for a newly created custom property.
Note: The default settings allow a popup option to appear, and columns to be added to the Device View and "View Device Sensors" display, for each new custom property key created. When a custom property key is created using the Manage Custom Property Keys option in the Device menu, or the Add Custom Property option in the right-click menu of the Custom Property Editor, Device View, or Map View, a popup option appears, by default, to select whether to add the new custom property key to the Device View as a column. You can uncheck the Show popup option when custom property key is added option, check-marked by default, to disable the popup option. Additionally, a new column can be added to the Device View when each new custom property key is created. You can uncheck the Add a new column to the Device view for each new custom property key created option, checkmarked by default, to prevent new columns from being created for every new custom property key. To add, modify, or remove custom property keys, you use the Manage Custom Property Keys option in the Device menu. To show columns for custom property keys in the Device View, you use the Configure Column icon in that view.
48
Monitored devices
The StruxureWare Central server can monitor and manage APC, MGE, Modbus TCP, NetBotz, and third-party devices. Once these devices have been discovered, you can do the following: Review sensor and devices status information about the devices in the Device View and Map View. Review information about existing device alarm conditions in the Active Alarms view. Review information about historical device alarm conditions in the Alarm History view. Launch to the remote device management applications. Generate reports for sensors at the devices. Assign devices to groups and subgroups in the Device Groups view. Create alert thresholds on device sensors.
Supported devices
The StruxureWare Central server can monitor APC, MGE, Modbus TCP, NetBotz, and third-party devices that it can discover on its public and private LANs. NetBotz Rack or Wall Appliances (except for 300, 303, 310, 400, and 410 models). Modbus TCP Output devices First generation power distribution units (PDUs) and AP76xx outlet strips, when discovered on the private LAN, only. Any APC or third-party device that can communicate with the server using SNMPv1 or SNMP v3 communication, with three levels of support provided. Basic SNMP support The StruxureWare Central server can provide only Type ( SNMP Device only), on-line or communication lost Status, Hostname, and Groups information. Model ID SNMP support Full SNMP support The StruxureWare Central server can report Model information, in addition to the information provided for basic SNMP support. The StruxureWare Central server can provide sensor data and alarms information, in addition to the information provided for model ID SNMP support.
Note: Additional sensors can be created on devices using Supplemental OIDs, an SNMP Device Communication Settings option in the Device menu.
49
You can use Device Definition Files, an SNMP Device Communication Settings and Modbus Device Communications Settings option in the Device menu, to check the APC website for new or updated DDFs, and download those files to the StruxureWare Central server. APC SNMP devices that use a Network Management Card (NMC) version of 3xx or higher have a DDF file that the StruxureWare Central must download at discovery time. This DDF file contains information about the alarm conditions the device can report.
Use this display to define how the StruxureWare Central server will use an Internet browser to communicate with the device or devices selected by Device Launch Settings, a rightclick option in the Device and Map Views.
The StruxureWare Central server uses these settings to connect to the web interface at any monitored device ( Launch to Device, a right-click option in the Device View and Map view), and to connect to the Advanced View interface at any monitored NetBotz Appliance ( Launch Advanced View, a right-click option in the Device View and Map view). You can specify the username and password used to connect to the web interface of the device or devices selected. When Use the Internal Web Browser when Launching to Devices is selected in the Client Preferences option of the File menu, you can doubleclick the device, or select the right-click option Launch to Device, to automatically login to the web interface of devices that use basic authentication without being prompted for credentials. Note: You cannot automatically login to the web interfaces of APC SNMP devices monitored by NetBotz Appliance versions 320, 420, and 500. Element
HTTP HTTPS Port
Description
Click to select the HTTP protocol for browser communication. Click to select the security-enhanced HTTPS protocol for browser communication. Identify the number of the port used for browser communication at a selected device: 80 is the default for HTTP; 443 is the default for HTTPS. Identify the username used to login to the device. Identify the password used to login to the device.
Username Password
51
Description
Identifies the hostname or IP address of the selected device. Identifies the model of the selected device, when known. Identifies when the StruxureWare Central server last scanned the device for its sensor values. Select the set of logically grouped sensors you want to view. Note: Some devices have sensors that cannot be logically grouped in sets; they list their individual sensors, instead. Use to search the device labels, sensors, and sensor values, and custom property keys, if any. Shows the sensors and sensor values for the selected device or devices. Note: When multiple devices are selected, Device Label information is included to identify which device reports a sensor value.
Search List
This " View Device Sensors" display also has right-click options to manage the list of sensors and sensor values. Option
Edit Custom Properties
Description
Allows you to add a custom property, or modify the value of an existing property, for the selected sensors.
52
Delete Sensors
Allows you to remove a sensor with a sensor value of unplugged. This option is available for SNMP devices only. Note: When you delete a sensor, all historical data for that sensor is also deleted. Allows you to change the state of sensors that report state values.
When a user has Device Group Monitoring View Access or higher, and accesses the " View Device Sensors" display from a camera, the display has a Camera tab. Element
Automatically fit to window Resolution
Description
Checkmark to fit the image to the display. Select the resolution you want to use to display the real-time feed for the selected camera.
The selected device type and its associated icon will be displayed in Map View and the Type column in Device View in the Monitoring perspective, and the Navigation view in the Alarm Configuration perspective. You can select the 'Default' setting to change the icon and device type back to its original type.
The StruxureWare Central server uses these settings to connect to the web interface at any monitored device ( Launch to Device, a right-click option in the Device View and Map view), and to connect to the Advanced View interface at any monitored NetBotz Appliance ( Launch Advanced View, a right-click option in the Device View and Map view). You can specify the username and password used to connect to the web interface of the device or devices selected. When Use the Internal Web Browser when Launching to Devices is selected in the Client Preferences option of the File menu, you can doubleclick the device, or select the right-click option Launch to Device, to automatically login to
53
the web interface of devices that use basic authentication without being prompted for credentials. Note: You cannot automatically login to the web interfaces of APC SNMP devices monitored by NetBotz Appliance versions 320, 420, and 500. Element
HTTP HTTPS Port
Description
Click to select the HTTP protocol for browser communication. Click to select the security-enhanced HTTPS protocol for browser communication. Identify the number of the port used for browser communication at a selected device: 80 is the default for HTTP; 443 is the default for HTTPS. Identify the username used to login to the device. Identify the password used to login to the device.
Username Password
You must specify the write community name for the Rack PDU device at device discovery, or in the "Edit Device Scan Settings" display, accessed from the Device Scan Settings option of the SNMP Device Communication Settings option in the Device menu. You can configure delay parameters for the outlets via SNMP or by logging into the device. A "Communication Error" is displayed when the Rack PDU device does not respond to a command for any reason, for example, when the write community name identified in the "Device Scan Settings" display is incorrect. User permissions defined in the "Modify Device Group Access" display, accessed from the Users and User Groups option in the System menu, determine which users have access to outlet control. StruxureWare Central Server Administrators, Device Administrators, and Device Viewer users with monitoring access set for Administration Access or View and Control can access outlet control. CAUTION: When you perform a command at an outlet that is part of an outlet group, that command will be executed at all outlets in the group. The StruxureWare Central server cannot determine which outlets are part of an outlet group. Element
List
Description Name: Select one or more outlets to control. Status: The status of the outlet.
Command
Select the command you wish to perform at the selected outlets. Note: Only the commands supported by the selected device are listed. Click to update the status of the outlets. Click to perform the command at the outlets selected.
54
Description
Checkmark to select one or more locks, one or more associated Rack Access Pod 170 devices, or the NetBotz Appliance or NetBotz Rack Access Device. The current state of the door, Open, or Closed The current state of the door handle, Up, or Down The current state of the lock, Locked, or Unlocked Press to lock or unlock the selected doors.
Note: The state of the door, handle, or lock is Unplugged when the Rack Access Pod 170 has been removed from the NetBotz Appliance. You can right-click a NetBotz Rack Access Device, NetBotz Appliance, or Rack Access Pod 170 to expand or collapse the list of door locks ( Expand or Collapse option).
55
You can select a device, or devices, to filter the Active Alarms view to show only the alarms for selected devices. Note: When a NetBotz Appliance is selected, the Active Alarms view will display its alarms, including all alarms associated with the devices it monitors. You can double-click a device to log on to its web interface, if it has one, or use the right-click Launch to Device option for a device. Right-click options, and icon buttons at the top of the view, perform the following functions: Initiate a device discovery process used to add SNMP devices, Modbus devices, or NetBotz Appliances to be monitored by the StruxureWare Central server ( Add Devices option or the green + icon). Delete devices that you no longer want the StruxureWare Central server to monitor ( Delete Devices option or the x icon). Note: This option is disabled for a device that has a NetBotz Appliance as its parent device. Generate a report or graph for the historical values of the sensors at selected devices ( Generate Sensor History Report option or Generate Custom Sensor History Report icon). Access the Alarm History view to review historical alarm data for any selected devices ( Show Alarm History option). Define the port and protocol settings, and the username and password to be used by the StruxureWare Central server to communicate with monitored devices ( Device Launch Settings option). Note: For monitored APC SNMP and Modbus devices, the default username and password "apc" is provided by default. Control the outlets at a selected APC or supported third-party Rack PDU device ( Outlet Control option). Log on to the web interface at a selected device, if it has one ( Launch to Device option). Log on to the Advanced View interface at a selected NetBotz Appliance ( Launch Advanced View option). Note: This option is enabled by Advanced View Settings, a Client Preferences option in the File menu. Remove selected devices from a shared device group, without causing the StruxureWare Central server to stop monitoring those devices ( Remove Device from Group option). Request that the StruxureWare Central server immediately scan selected devices for sensor values, without waiting until the server would normally scan those devices ( Request Device Scan option). Note: This option is unavailable for NetBotz Appliances, and devices that have a NetBotz Appliance as their parent device. View all the values being reported by the sensors at selected devices ( View Device Sensors option). Select the appropriate device type for a third party device, or more accurately define an SNMP device ( Change Device Type option). Create thresholds for a selected device, or set of devices ( Create Thresholds option). Note: For information about this option, see Create Thresholds option, under Alarm Configuration. Configure selected APC SNMP devices to use the same values for shared settings ( APC SNMP Device Configuration option). Note: An APC SNMP Device Configuration option is also in the Device menu. For information about these options, see APC SNMP Device Configuration.
56
Access an option to lock or unlock rack doors using the Rack Access Control option for a main NetBotz Appliance, or any of its associated Rack Access Pod 170 devices. Note: The Rack Access Control option is available only when a Rack Access Pod 170 is connected to the selected NetBotz Appliance. Access a specific configuration option for a selected NetBotz Appliance or camera pod ( NetBotz Appliance Configuration options). Note: A NetBotz Appliance Configuration option is also in the Device menu. For information about these options, see NetBotz Appliance Configuration. Access the Surveillance perspective with a selected camera highlighted in the Thumbnails view ( Show in Surveillance Perspective option). Note: Show in Surveillance Perspective is only available when a camera is selected; when multiple cameras are selected, only the camera closest to the top of the Devices View is highlighted in the Thumbnails view. Disable or re-enable notifications for any SNMP or Modbus device, or device group ( Enter/Exit Maintenance Mode options). Create a custom property, or edit the value of an existing property, for the selected devices or sensors ( Add Custom Property option). Access the Custom Properties Editor view to add, modify, or remove custom properties for selected devices or sensors ( Open Custom Properties Editor option). Create a virtual sensor for a selected device, or set of devices ( Create Virtual Sensor option). Note: For information about this option, see Virtual Sensors view.
57
You can move copies of any associated device, including the device that represents the appliance, to any other device group; a copy of that device remains associated with the main NetBotz Appliance listing.
Information columns
The Device View columns provide information and status for listed devices. Note: A Configure Columns icon at the top of the view allows you to define which columns are displayed. Column
Type Status
Description
The type of device, with SNMP Device used as a generic identification. The severity of the most serious alarm condition at a device. Note: You can select a device in the Device View to access information about its alarms in the Active Alarms view.
Monitored SNMP devices typically report three status conditions: Normal: no alarm conditions exist. Warning, a condition exists that may require attention to make sure it does not deteriorate into a critical state. For example, a UPS that is running on battery power during a power failure will shut down its load equipment if its battery power is depleted before power returns to normal. Critical: a condition exists that requires immediate attention. For example, a discharged battery can result in the loss of UPS protection during a power failure. NetBotz Appliances typically report two status conditions, in addition to Normal: Error: a sensor threshold violation exists that requires immediate attention. For example, a high temperature violation that could lead to equipment damage. Failure: an operational failure exists that requires immediate attention. For example, communication with a camera pod was lost which could lead to an undetected security violation. Note: The status reported for alert threshold violations can be defined by the severity settings for each threshold. For example, a door sensor can be set to
58
Hostname
Parent Device
Groups
59
Icon
Description Use this Export Device List icon to save a copy of the device list as a *.csv (the default selection) or *.txt file. Use this Add Devices icon to initiate a device discovery process used to add SNMP devices, Modbus devices, or NetBotz Appliances to be monitored by the StruxureWare Central server. Use this Delete Devices icon to delete devices that you no longer want the StruxureWare Central server to monitor. Use this Custom Sensor History Reports icon to create a report or graph for the historical values of the sensors at selected devices (see Reports feature). Use this Configure Columns icon to identify the columns to be included in the device list.
Reposition icons within the map ( Edit Map option or icon), and save the new positions ( Save Map option or icon). Reset the device icons back to their default positions ( Auto-Arrange option or icon). Select ( Select All option) or deselect ( Deselect All option) all devices in the Map View. Select the graphic used for the background, and define how icons are displayed ( Map Settings option or icon). Select sensor values to be displayed by the icons ( Custom Label Settings option or icon). Select the appropriate device type for a third party device, or more accurately define an SNMP device ( Change Device Type option). Other right-click options allow you to perform functions not directly related to managing the Map View. Delete devices that you no longer want the StruxureWare Central server to monitor ( Delete Devices option). Note: This option is disabled for a device that has a NetBotz Appliance as its parent device. Initiate the process used to create a report or graph for the historical values of the sensors at selected devices ( Generate Sensor History Report option or graph icon). Access Alarm History view to review historical alarm data for any selected devices ( Show Alarm History option). Define the port and protocol settings to be used by the StruxureWare Central server to communicate with monitored devices ( Device Launch Settings option). Note: For monitored APC SNMP and Modbus devices, the default username and password "apc" is provided by default. Control the outlets at a selected APC or supported third-party Rack PDU device ( Outlet Control option). Log on to the web interface at a selected device, if it has one ( Launch to Device option). Log on to the Advanced View interface at a selected NetBotz Appliance ( Launch Advanced View option). Note: This option is enabled by Advanced View Settings, a Client Preferences option in the File menu. Request that the StruxureWare Central server immediately scan selected devices for sensor values, without waiting until the server would normally scan those devices ( Request Device Scan option). Note: This option is unavailable for NetBotz Appliances, and devices that have a NetBotz Appliance as their parent device. View all the values being reported by the sensors at selected devices ( View Device Sensors option). Create a custom property, or edit the value of an existing property, for the selected devices or sensors ( Add Custom Property option). Access the Custom Properties Editor view to add, modify, or remove custom properties for selected devices or sensors ( Open Custom Properties Editor option). Configure selected APC SNMP devices to use the same values for shared settings ( APC SNMP Device Configuration option). Note: An APC SNMP Device Configuration option is also in the Device menu. For information about these options, see APC SNMP Device Configuration. Create thresholds for a selected SNMP or Modbus device, or set of devices ( Create Thresholds options).
61
Note: For information about these options, see Create Thresholds , under Alarm Configuration menu. Disable or re-enable notifications for any SNMP or Modbus device, or device group ( Enter/Exit Maintenance Mode options). Access an option to lock or unlock rack doors using the Rack Access Control option for a main NetBotz Appliance, or any of its associated Rack Access Pod 170 devices. Note: The Rack Access Control option is available only when a Rack Access Pod 170 is connected to the selected NetBotz Appliance. Access a specific configuration option for a selected NetBotz Appliance or camera pod ( NetBotz Appliance Configuration options). Note: For information about these options, see NetBotz Appliance Configuration under Device menu. Add or edit alert thresholds for a selected NetBotz Appliance or devices that have a NetBotz Appliance as their parent device ( Alert Thresholds options under NetBotz Appliance Configuration ). Note: For information about these options, see Alert Thresholds options, under Alert Settings in the NetBotz Appliance Configuration option of the Device menu. Edit camera settings for a selected NetBotz Appliance or cameras that have a NetBotz Appliance as their parent device ( Camera Settings option under NetBotz Appliance Configuration ). Create a virtual sensor for a selected device, or set of devices ( Create Virtual Sensor option). Note: For information about this option, see Virtual Sensors view.
Icon
Description Use this Edit Map/Exit Edit Map icon to reposition devices within the map, and save the new positions. Use this Find Devices, Groups, or Sensors in Map icon to search and select device groups and sensors by label, or devices by IP address, location, hostname, model name or device label. Note: Boolean operators are not supported. Use this Map Settings icon to define the background, as well as how icons are displayed. Use this Auto-Arrange icon to reset the device icons back to their default positions.
62
Icon
Description Use this Custom Label Settings icon to select the identifier and sensor values to be displayed for the Map View devices.
You can select an identifier and a sensor value for all devices to display in a Map View, however, only devices that report that sensor will show its value.
63
1. Select the Map Settings right-click option, or the Map Settings icon at the top of the Map View. Select the Map Label Settings option. 2. Check-mark the Show Identifier option, and select an identifier from the list. 3. Make sure the Show Value option is check-marked. 4. Select the sensor you want to use from the available sensor list.
Selecting Custom Label Settings for a selected device or set of devices
You can select a device or set of devices in a Map View, and select an identifier to display instead of the identifier set in the Map Settings display. You must select one device at a time to also define a custom value to display for a specific sensor. 1. Select the device or set of devices in the Map View. 2. Select the Custom Label Settings right-click option, or the Custom Label Settings icon at the top of the Map View. 3. Check-mark the Show Identifier option, and select the identifier you want the device or set of devices to display. 4. When one device is selected, define the sensor value you want the device to display, by choosing one of the following options: Select Display the value set in Map Settings if you want the selected device to use the settings defined in the Map Settings display. Select Choose a specific sensor value, and select the sensor you want to use from the available sensor list, if you want the selected device to use a custom setting.
You access this display from the right-click menu in a map, after Edit Map is selected. You use three tabs, Sensors, Devices, and Device Groups, to select the sensors, devices, or device groups you want to add to the map. You can use the Search field to filter the list on each tab based on the text you type. Note: Only the Boolean operators AND, OR, and NOT are supported. You can select the Configure Columns icon on the Sensors and Devices tabs to identify the columns that appear in the display. You can click the column headers to sort the list in ascending or descending order.
The Unassigned group is automatically added to the map for the All Devices group. Any device group you create, and any device you add to a device group, is automatically added to the map for the selected device group. Sensors must be added to a map manually. When all the device groups, devices, or sensors available for the selection are already added to the map, the list on the Sensors, Devices, or Device Group tabs is empty. When a device group, device, or sensor has not been added to the map, or has been removed from the map, it is listed on the appropriate tab, and can be added to the map at a later time. Element
Sensors tab
Description
Displays all available sensors, for every device in every device group, not already on the map.
64
Note: Sensors are not added to a map by default. They must be added manually from this display. Devices tab Displays the devices, in every device group, not already on the map. Note: When the device group you select contains only devices, the list in the Devices tab is at first empty. Devices are added to the map by default. Displays no device groups until one or more device groups are removed from the map. Note: When the device group you select contains only device groups, the list in the Device Groups tab is at first empty. Device groups are added to the map by default.
Use this option to customize how the background and icons will look in a Map View.
Element
Custom Background Select Image Save No Background Grid Background (Default) Width Height Small Icons Large Icons Identifier Orientation
Description
Click to select a graphic to use as a custom background. Click to browse to and select the graphic you want to use for the custom background. Click to save the selected background image as a file at your local machine. Click to use a blank background. Click to use a blank-tiled background, the default. Drag right or left to change the width of the icons. Drag up or down to change the height of the icons. Click to use small icons. Click to use large icons. Choose how to show the identifier you selected in Map Label Settings or Custom Label Settings, if any.
Horizontal will show the identifier below the icon, horizontally, and Vertical will show the identifier to the right of the icon, vertically.
Icon Preview Shows the affect of applied Sizing and Identifier definition on how icons will appear in a Map View.
65
Note: Sensor values are always shown below the icon, horizontally, and are not shown in the Icon Preview.
Use this option to define the identifier and sensor value labels to display for all devices and sensors on a map. Note: Sensor values can be displayed for the devices managed by a NetBotz Appliance, but not for the NetBotz Appliance itself. Element
Show Identifier Show Value
Description
Check-mark to select the identifier to show for all devices and sensors on a map. Check-mark to show the value of the selected sensor for all devices on the map that report that sensor. Select the sensor for which you want to show the value.
List
Note: Only the devices that report the sensor will show the sensor value. All the sensors for every device in the selected device group's Map View are listed. There may be more than one sensor of a given type, as different devices report different sensors. For example, the main input voltage sensor reported by a Smart-UPS is different than the main input voltage phase 1 sensor reported by a Symmetra PX. Thus, if you select main input voltage as the sensor, only devices that have that exact sensor will report the value. Devices that report the selected sensor will update with the sensor value except for the following: Devices that do not report the sensor value. Devices that have a different sensor defined in the Custom Label Settings display. Note: You can also use the Custom Label Settings display to select a new sensor value label for one device on a map without affecting the sensor value labels at any other devices.
Description
Check-mark to select the identifier to show for the selected device or set of devices.
66
Select to make sure no changes are made to the sensor value label settings you set in the Map Settings option for the selected device. Select to choose a specific sensor value to show for the selected device. Note: You cannot configure the sensor value when multiple devices are selected. Select the sensor you want to use from the available sensor list.
List
67
Four menus provide access to create a virtual sensor: Right-click menu Create Virtual Sensor in the Device Groups view of the Monitoring perspective. Right-click menu Create Virtual Sensor in the Device View of the Monitoring perspective. Right-click menu Create Virtual Sensor in the Map View of the Monitoring perspective. Create Virtual Sensor, an option in the Device menu.
69
A Search field and Clear button allow you to filter the list to display only the device groups that include your typed text. A Configure Columns icon allows you to define which columns are displayed. Column
Type Hostname
Description
The type of device. The hostname, or IP address, if no hostname is defined, for a monitored device or NetBotz Appliance, or <not addressable> for a virtual device. The label defined for a device. The location associated with a device, if known. The device model, if known. Identifies the StruxureWare Central server, for devices directly monitored by the server, or the hostname or IP address for a NetBotz Appliance and its supported devices. The names of any device groups a device belongs to, including All Devices and Unassigned. A custom property key, identified by name.
Device Groups
A Search field and Clear button allow you to filter the list to display only the sensors that include your typed text. A Configure Columns icon allows you to define which columns are displayed. Column
Sensor Current Reading Hostname
Description
The name of the sensor. The last reported value for the sensor. The hostname, or IP address, if no hostname is defined, for the device or NetBotz Appliance monitoring the sensor, or <not addressable> for a virtual device. The unit of measurement for the sensor. The type for the device monitoring the sensor. The model for the device monitoring the sensor.
70
The label defined for the device monitoring the sensor. Identifies the StruxureWare Central server, for devices directly monitored by the server, or the hostname or IP address for a NetBotz Appliance and its supported devices. A custom property key, identified by name.
For each virtual sensor created, a virtual device parent is also created and added to the Device View and the Map View.
This virtual sensor name appears in the Label column for both the virtual device parent and virtual sensor.
Description
Provides information about each virtual sensor in the view. Click to add a sensor to the selected virtual sensor. Click to remove a sensor from the selected virtual sensor. Note: You cannot remove all sensors from a virtual sensor.
71
Alarm views
Two views provide information about the alarms that occur at monitored devices, both of which can be accessed from Alarms in the Windows menu: Active Alarms view is part of the default layout of the Monitoring perspective; Alarm History view also can be accessed by selecting Show Alarm History, a right-click menu option in the Device View, Map View, or Device Groups view.
Clip option
Use this option to view clips that were included with a selected alarm. A tab identifies each camera that has a clip attached to the alarm. The clip is displayed in the upper portion of the tab, while icons used to view each frame, and to export the clip, and information about the clip are provided in the lower portion.
72
Element
View Pane
Description
Shows the content of the clip.
Play (
)/Pause (
) icons
Click the Play icon to start the clip; click the Pause icon to pause the playback on the current image. You may begin playing the clip during the load sequence, if you desire.
Drag the control left or right to find a specific frame within the clip. The number to the right of the bar shows the currently displayed frame. You also can click the up and down arrows to the right of the slider bar to advance or rewind the clip by a single frame. The beginning date, ending date, and time of the clip are displayed below the slider bar.
Click this icon to access the "Export Clip" display. Note: For information about the "Export Clip" display, see "Recorded Camera Clips" display under Surveillance perspective. If there is audio associated with the current clip, the audio icon is displayed in black; if there is no audio, the icon is grayed out. ) If the clip has a digital signature associated with it, this icon is displayed in color; if the clip is unsigned, the icon is grayed out. Displays the loading status of the selected clip: Loading or Loading Complete.
Audio icon (
Displays the following information about the current clip: Total Frame Count Duration Resolution
Comments option
Use this option to view, add, or remove comments about the selected alarm.
You can add up to 25 comments for the selected alarm. The date and time the alarm occurred, and the username, date and time for each comment are displayed. You can click the X icon next to each comment to permanently remove it from the list. Events generated by the StruxureWare Central server are italicized in blue. The date and time the alarm occurred, and the name of the user that acknowledged the alarm, if applicable, are displayed. System events cannot be removed from the list. StruxureWare Central Server Administrator users can add and remove comments for any alarm.
73
Device Administrator users can add comments for alarms at devices in the device groups to which they have access, and can remove only their own comments. Device Viewer users can view comments for alarms at devices in the device groups to which they have access. Note: For a non- StruxureWare Central Administrator user, including a user for which no role is selected, access privileges are determined by Device Group Access settings in the Users tab for that user, and for the user groups to which the user is assigned.
Details option
Use this option to view information about a selected alarm. Note: Three elements ( Resolved by, Resolved Comment, and Resolve Alarm) are available only for an alarm that must be manually resolved because it is associated with a sensor alert threshold that has Return-to-Normal Requires User Input selected in its Advanced tab. Element
Sensor Type Alarm Name Device Device Location Time Occurred Time Resolved Resolved by Resolved Comment
Description
The sensor associated with the alarm. The type of device. The name of the alarm. The label information for the device. The location of the device, when available. When the alarm occurred, by date and time. When the alarm was resolved, by date and time, or Not Yet Resolved, if still active. The user who manually resolved an alarm using the "Resolve Alarm" display. Any optional comment made in the "Resolve Alarm" display while manually resolving an alarm. The Custom URL in the Advanced tab for the alert threshold setting associated with the alarming sensor, when defined for that threshold. Note: For more information, see Alert Thresholds under Alert Settings ( Device menu). The Custom Description in the Advanced tab for the alert threshold setting associated with the alarming sensor, when defined for that threshold. Note: For more information, see Alert Thresholds under Alert Settings ( Device menu). Information about how to clear the alarm, when available. Click to use the "Resolve Alarm" display to manually resolve an alarm.
Custom URL
Custom Description
74
Graph option
Use this option to view a graph for an alarm associated with a sensor. Note: This is available only for some of the alarms that list a sensor in the Sensor column of an alarms list; it is unavailable for alarms that have no sensor identified in the Sensors column. Each graph has its value measurements labeled up the left side of the graph, and date and time values labeled across the bottom.
Icon
Description Use the Hide Alarm Details icon to hide the Alarm Details section. Use the Show Alarm Details icon to show the Alarm Details section. Use the Configure Columns icon to identify the columns that appear in the active alarms list. All available columns are displayed by default. Use the Show Hidden Alarms icon to view acknowledged alarms set as hidden, or to hide affected alarms once you have viewed them. Use the Generate Custom Sensor History Report icon to create a report or graph for the historical values of sensors at devices associated with alarms selected in the alarms view (see Reports feature).
The view includes a search element that allows you to list only the alarms that match your typed text, and a table that provides information about those alarms. Column
Clip
Description
Uses a camera icon ( ) to identify alarms that include a surveillance clip. Describes details for the alarm. Describes the severity level associated with the alarm. Identifies the hostname or IP address of the device. Identifies the type of alarm. Identifies the location of the device, when available. Identifies the IP address or hostname for a NetBotz Appliance, or <server_name> (StruxureWare Central) , for SNMP devices monitored by the StruxureWare Central server. Identifies when the alarm occurred. Identifies the sensor associated with the alarm, when an alert threshold setting is defined for the sensor alarm. Note: For information about the alert threshold settings, see Alert Thresholds, under Alert Settings. Indicates whether notifications for the alarm were suppressed when the alarm was acknowledged.
Notifications Suppressed
You can use the list, right-click options, and button icons to do the following: Show or hide the Alarm Details section ( Show/Hide Alarms Details icon). Select which columns appear in the list ( Configure Columns icon). Click a column title to sort the list in ascending or descending order based on the information in that column. Access the "Alarm Details" display for a selected alarm ( View Alarm Details and Comments option, or double-click the alarm). Select an alarm in the list and select that device in the Device View ( Select Device option). Generate a report for the historical values of the sensors at the device associated with the selected alarm ( Custom Sensor History Report icon). Note: All device sensors associated with the device will be listed, with the sensor for that alarm selected in that list. View all the values being reported by the device associated with the selected alarm ( View Device Sensors option). Log on to the web interface of the device associated with the selected alarm, if it has one ( Launch to Device option). Specify how you want to acknowledge selected alarms ( Alarm Acknowledgement option). View acknowledged alarms set as hidden, or hide affected alarms once you have viewed them ( Show Hidden Alarms icon).
76
Show the selected threshold or device alarm in the Threshold Alarm Configurations view or the Device Alarm Configurations view in the Alarm Configuration perspective ( Find Alarm Configuration option). Note: This option is not available for active alarms on NetBotz Appliances. Modify the settings for only the selected instance of a threshold or device alarm, or all instances of that threshold or device alarm on every device that reports it ( Edit Alarm Configuration option). Note: This option is not available for active alarms on NetBotz Appliances.
Description
The sensor associated with the alarm. The type of device. The name of the alarm. The label information for the device. The location of the device, when available. The time the alarm was reported. The time the alarm was resolved, or Not Yet Resolved when the alarm is still active. A custom URL included in alarm notifications. A custom description included in alarm notifications. Information about how to clear the alarm, when available.
Type
Set as Hidden
Description
Checkmark to hide the alarm in the Active Alarms view of any StruxureWare Central
77
client logged in to the StruxureWare Central server. Note: You can click the Show Hidden Alarms icon to view acknowledged alarms set as hidden. The information for affected alarms is italicized. You can then select any italicized alarms and uncheck the Set as Hidden option to display them in the view. Suppress Future Notifications StruxureWare Central Checkmark to prevent notifications from being sent for the alarm, when the alarm actions specified in the notification policy are set to repeat. Note: When the alarm is resolved, Return to Normal events are sent using the alarm actions specified in the notification policy. Enter additional information about acknowledging the alarm.
Add Comment
78
Time Occurred Time Resolved Status Description Clip Severity Device Hostname Alarm Type Location Parent Device
Identifies when an alarm occurred. Identifies when an alarm was resolved, unless it is still active. Identifies whether an alarm is Active or Resolved. Describes details for the alarm. Uses a camera icon to identify alarms that include a surveillance clip. Identifies the severity level associated with the alarm. Identifies the hostname or IP address of the device associated with the alarm. The type of alarm. The location of the device, when known. Identifies the IP address or hostname for a NetBotz Appliance, or <server_name> (StruxureWare Central) , for SNMP devices monitored by the StruxureWare Central server. Identifies the sensor associated with the alarm, when an alert threshold setting is defined for the sensor alarm. Note: For more information, see Alert Thresholds, under Alert Settings.
Sensor
You can use the list, right-click options, and button icons, to do the following: Click a column title to sort the list in ascending or descending order based on the information in that column. Select which columns appear in the list ( Configure Columns icon). Access the "View Alarm Details" display for a selected alarm ( View Alarm Details right-click option, or double-click the alarm). Select an alarm in the list and access the listing for its device in the Device View ( Select Device right-click option). Generate a report or graph for the historical values of the sensors at the device associated with the selected alarm ( Generate Custom Sensor History Report right-click option or ( ) icon). Note: All device sensors associated with the device will be listed, with the sensor for that alarm selected in that list. View all the values being reported by the sensors at the device associated with the selected alarm ( View Device Sensors right-click option). Show the selected threshold or device alarm in the Threshold Alarm Configurations view or the Device Alarm Configurations view in the Alarm Configuration perspective ( Find Alarm Configuration option). Modify the settings for only the selected instance of a threshold or device alarm, or all instances of that threshold or device alarm on every device that reports it ( Edit Alarm Configuration option). Log on to the web interface of the device associated with the selected alarm, if it has one ( Launch to Device right-click option). Export a copy of the list as a *.csv (the default selection) or *.txt file ( Export Alarm History ( ) icon).
79
Scroll between multiple pages using standard scrolling elements (arrows and page number box). Note: A maximum of 500 alarm entries can be reported by a page, with additional pages provided for every additional 500 entries.
80
81
3. Write Community Name: the community name used to control an APC SNMP v1 device or register as a trap receiver at an APC SNMPv1 device. 4. Port: the port number that the SNMPv1 devices use for communication. 5. Timeout: how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed. 6. Retries: how many times the StruxureWare Central server will attempt to communicate with a device at an IP address, after the initial failure, before it stops trying to access a device at that address. 7. Register for Priority Scanning: enables the StruxureWare Central server to be defined as a trap receiver at discovered APC SNMPv1 devices. Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. It allows the StruxureWare Central server to immediately poll an APC SNMP device in response to a trap, rather than waiting to poll the device during the normal scanning interval. 8. Device File Transfer Settings: accesses the "Device File Transfer Settings" display used to edit, create, or view the file transfer settings for FTP or SCP access to SNMP devices. "SNMPv3 Discovery Settings" display: 1. IP Range: the IP addresses the discovery process will search. 2. Username: the username used for secure communication with discovered SNMPv3 devices. 3. Authentication Type/ Password: the authentication protocol and password. 4. Encryption Type/ Password: the encryption method and password. 5. Port: the port number that the SNMPv3 devices use for communication. 6. Timeout: how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed. 7. Retries: how many times the StruxureWare Central server will attempt to communicate with a device at an IP address, after the initial failure, before it stops trying to access a device at that address. 8. Register for Priority Scanning: enables the StruxureWare Central server to be defined as a trap receiver at discovered APC SNMPv3 devices. Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. It allows the StruxureWare Central server to immediately poll an APC SNMP device in response to a trap, rather than waiting to poll the device during the normal scanning interval. 9. Device File Transfer Settings: accesses the "Device File Transfer Settings" display used to edit, create, or view the file transfer settings for FTP or SCP access to SNMP devices. "NetBotz Appliance Discovery Settings" display: 1. IP Range: the IP addresses the discovery process will search. 2. Port: the port used for communication with the NetBotz Appliances. 3. Security Mode: the security mode used for communication with the NetBotz Appliances. 4. Credentials: accesses a display used to manage the credentials that can be used to communicate with NetBotz Appliances. "Modbus Discovery Settings" display: 1. Single IP Address: one IP address the discovery process will search.
82
2. Select Device Type: lists the Modbus device types the StruxureWare Central server supports. 3. Slave Address: identifies the slave address of the Modbus device. 4. Port: the port number the Modbus device uses for communication. 5. Timeout (seconds): how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed. 4. In the "Discovery Scheduling" display, do one or both of the following actions, and click Finish, to add the process to the Saved Discoveries view. Use the Enable discovery scheduling option to schedule the days and times when the discovery process will be run automatically. Note: You cannot schedule discovery for Modbus TCP devices. Use the Run discovery now option to run the discovery process when you click Finish.
83
1. IP Range: the IP addresses the discovery process will search. 2. Username: the username used for with discovered SNMPv3 devices. 3. Authentication Type/ Password: the authentication protocol and password. 4. Encryption Type/ Password: the encryption method and password. 5. Port: the port number that the SNMPv3 devices use for communication. 6. Timeout: how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed. 7. Retries: how many times the StruxureWare Central server will attempt to communicate with a device at an IP address, after the initial failure, before it stops trying to access a device at that address. 8. Register for Priority Scanning: enables the StruxureWare Central server to be defined as a trap receiver at discovered APC SNMPv3 devices. Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. It allows the StruxureWare Central server to immediately poll an APC SNMP device in response to a trap, rather than waiting to poll the device during the normal scanning interval. 9. Device File Transfer Settings: accesses the "Device File Transfer Settings" display used to edit, create, or view the file transfer settings for FTP or SCP access to SNMP devices. "NetBotz Appliance Discovery Settings" display: 1. IP Range: the IP addresses the discovery process will search. 2. Port: the port used for communication with the NetBotz devices. 3. Security Mode: security mode used for communication with the NetBotz Appliances. 4. Credentials: accesses a display that lists credentials that can be used to communicate with NetBotz Appliances, and allows you to manage (edit, create, or delete) the credentials. 4. In the "Discovery Scheduling" display, do one or both of the following actions, and click Finish, to add the process to the Saved Discoveries view. Use the Enable discovery scheduling option to schedule the days and times when the discovery process will be run automatically. Use the Run discovery now option to run the discovery process when you click Finish.
How you use this wizard will depend, in part, on the type of devices you want to discover: SNMPv1, SNMPv3, NetBotz Appliances, or Modbus TCP.
Description
Select to discover devices that use standard SNMP communication. Select to discover devices that use secure SNMP communication. Select to discover NetBotz Rack or Wall Appliances (except for 300, 303, 310, 400, and 410 models). Select to discover devices that use Modbus TCP communication.
Modbus TCP
Description
Define the IP addresses the discovery process will search for SNMPv1 devices. For example:
xxx.xxx.12.6: searches a single IP address. xxx.xxx.10-13.20-80: searches a specific set of IP addresses (20 through 80) at the 10, 11, 12, and 13 subnets. xxx.xxx.14.*: searches all IP addresses at subnet 14.
SNMPv1 Settings
Read Community: define the community name to be used to read information at the SNMPv1 devices ( public, by default). Write Community: define the community name to be used to control the APC devices or register as a trap receiver at the APC SNMPv1 devices ( private, by default). Port: define the port number that the SNMP devices use for communication ( 161, by default). Timeout: define how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed ( 2, by default).
85
Retries: define how many times the StruxureWare Central server will attempt to communicate with a device at an IP address, after the initial failure, before it stops trying to access a device at that address ( 3, by default).
Trap Registration Register for Priority Scanning: select to have the StruxureWare Central server registered as a trap receiver at discovered APC SNMPv1 devices. Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. It allows the StruxureWare Central server to immediately poll an APC SNMP device in response to a trap, rather than waiting to poll the device during the normal scanning interval. Click to use the display for Device File Transfer Settings, an SNMP Device Communication Settings option in the Settings menu, to edit, create, or view the file transfer settings used for FTP or SCP access to SNMP devices.
Description
Define the IP addresses the discovery process will search for SNMPv3 devices. For example:
xxx.xxx.12.6: searches a single IP address. xxx.xxx.10-13.20-80: searches a specific set of IP addresses (20 through 80) at the 10, 11, 12, and 13 subnets. xxx.xxx.14.*: searches all IP addresses at subnet 14.
SNMPv3 Settings Username: Define the username used for secure communication with discovered SNMP devices.
Authentication Type/ Password: select the authentication protocol ( None, MD5 or SHA) and password used with that protocol. Encryption Type/ Password: select the encryption method ( None, DES, or AES-128) and password used with the DES or AES-128 method.
86
Port: define the port number that the SNMP devices use for communication ( 161, by default). Timeout: define how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed ( 2, by default). Retries: define how many times the StruxureWare Central server will attempt to communicate with a device at an IP address, after the initial failure, before it stops trying to access a device at that address ( 3, by default).
Trap Registration Register for Priority Scanning: select to have the StruxureWare Central server register itself as a trap receiver at discovered APC SNMPv3 devices. Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. It allows the StruxureWare Central server to immediately poll an APC SNMP device in response to a trap, rather than waiting to poll the device during the normal scanning interval. Click to use the display for Device File Transfer Settings, an SNMP Device Communication Settings option in the Settings menu, to edit, create, or view the file transfer settings used for FTP or SCP access to SNMP devices.
87
Element List
Description Lists the access settings the StruxureWare Central server can use for FTP or SCP access to its monitored devices. Username: The username used for access to a device. Note: By default, the StruxureWare Central server can download firmware only to devices that use apc (lowercase) for the username and password (the actual password used for device access is identified in the "Edit Device File Transfer Settings" display). IP or IP Range: The IP address, or range of addresses, at which the access settings support FTP or SCP communication. FTP Port: The port used for FTP access to a device. SCP Port: The port used for SCP access to a device. Timeout: How long the server will wait before it considers that an attempt to access a device has failed. Retry Limit: How many times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default). Protocol: The protocol the transfer settings set will use to access devices ( FTP only, SCP only, or Try SCP, fall back to FTP).
Click to add an access setting to the list. Click to edit a selected access setting. Click to delete a selected access setting.
Use this display to add or edit the settings the StruxureWare Central server uses for File Transfer Protocol (FTP) or Secure Copy (SCP) access to APC SNMPv1 and SNMPv3 devices. Note: Functionally identical versions of this display can be accessed from the "Device File Transfer Settings" displays used by the "Apply Firmware Updates," "SNMPv1/SNMPv3 Device Discovery," and "APC SNMP Device Configuration" wizards, and by Device File Transfer Settings, an SNMP Device Communication Settings option in the Device menu.
88
Element
Username Password Verify Password IP or IP Range
Description
Identify the name used for access to a device. Identify the password used for access to a device. Retype the password. Identify The IP address, or range of addresses, at which the access settings support FTP or SCP communication ( *.*.*.*, by default). Identify whether the transfer settings will use FTP ( FTP only), SCP ( SCP only), or attempt to use SCP, but fall back to using FTP if SCP fails ( Try SCP, fall back to FTP). Select the port the server will use for FTP access to devices ( 21, by default). Select the port the server will use for SCP access to devices ( 22, by default). Identify how long the server will wait before it considers that an attempt to access a device has failed ( 3000, by default). Select the number of times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default).
Protocol
Retry Limit
Description
Define the IP addresses the discovery process will search for NetBotz Appliances. For example:
xxx.xxx.12.6: searches a single IP address. xxx.xxx.10-13.20-80: searches a specific set of IP addresses (20 through 80) at the 10, 11, 12, and 13 subnets. xxx.xxx.14.*: searches all IP addresses at subnet 14.
Port Range Define the range or port numbers that the discovery process will use to communicate with NetBotz Appliances ( 80, by default). For example:
80: uses port 80 only. 60-80: uses ports 60 through 80, inclusive.
Security Mode Select the Secure Sockets Layer (SSL) protocol to use for communication with NetBotz Appliances:
Modbus TCP devices with static IP addresses can be discovered on the public LAN; on Network A on the private LAN, when DHCP discovery is disabled (enabled by default); or on one segment you define on Network B on the private LAN. Note: Modbus TCP device discovery entries are not stored in the "Saved Discoveries" list. Element
Single IP Address Select Device Type Slave Address Port Timeout (seconds)
Description
Define the IP address the discovery process will search for a Modbus device. Define the device type from the list of those supported by the StruxureWare Central server. Define the address of the device associated with the master Define the port the Modbus device uses for communication (502, by default). Define how long the StruxureWare Central server will wait for a response, in seconds, when it polls an IP address before it considers the poll failed ( 5, by default).
Description
Select to schedule when a discovery process will run automatically, by the day, or days, of the week, and time of day. Select to run the discovery process when you exit the wizard.
90
This Saved Discoveries view also has right-click menu options and button icons that manage the discovery processes. Option Add Edit Delete Run Stop Import Discovery Entries Export Discovery Entries Description Accesses the "Device Discovery" wizard to create a new discovery process. Accesses the "Device Discovery" wizard to edit a selected discovery process. Deletes a selected discovery process. Runs a selected discovery process. Stops a selected discovery process, when that process is running. Import the SNMPv1 or NetBotz Appliance discovery entries from a local file. Export the SNMPv1 or NetBotz Appliance discovery entries to a local file.
Element
Description
91
Select the location to save a copy of the device discovery properties as a *.txt file.
Lists the saved discovery processes, and provides the following information about each: IP or IP Range: The IP addresses the discovery process searched for devices. Type: The devices the process discovered: SNMPv1or NetBotz Appliance. Parameters: The network settings the discovery process used.
Export
Element
Choose File List
Description
Select the location to import the device discovery as a *.txt file.
Lists the imported discovery processes, and provides the following information about each: IP or IP Range: The IP addresses the discovery process searched for devices. Type: The devices the process discovered: SNMPv1or NetBotz Appliance. Parameters: The network settings the discovery process used.
Accesses the display used to manage the settings the StruxureWare Central server uses for File Transfer Protocol (FTP) or Secure Copy (SCP) access to APC SNMPv1 devices. Accesses the display used to manage the list of credentials used for communication with the NetBotz Appliances. Click to import the selected device discoveries to the Saved Discoveries view.
Import
92
Use this file format to import SNMPv1 and NetBotz Appliance device discovery entries to the Saved Discoveries view from a local *.txt file. Note: You cannot import device discovery entries for SNMPv3 or Modbus devices.
Format for SNMPv1: SNMPv1:<IP Address or Range>:<port>:<timeout>:<retries>:<trap registration (true or false)>:<read community>:<write community> Example: SNMPv1:10.218.10-15.*:161:2:3:true:public:private Format for NetBotz Appliance: NetBotz Appliance:<IP Address or Range>:<port>:<security mode (HTTP or HTTPS_AVAIL_NO_VERIFY or HTTPS_REQ_NO_VERIFY or HTTPS_REQ_VERIFY)> Example: NetBotz Appliance:10.218.10.166:80:HTTP
93
Description
Select to use the Date, Time, and Recurrence settings to schedule update checks. Define the date when the update check will occur. Define the time of day that update check will occur. Define how often the update check will occur, either Once, at the defined date and time, or recurring Daily, Weekly, or Monthly, starting at the defined date and time.
Message
Description
The next update check is set to occur on Reports the date and time for the next scheduled update check. <Date> at <Time>. Recommended Action: None The scheduled update checking service The Check for Updates option is not is disabled. selected. Recommended Action: Select to enable scheduling.
94
Message
Description
Unable to schedule the specified update An unexpected server error occurred. check. Recommended Action: Try again. If the problem persists, contact APC Support ( http://www.apc.com/support ). You attempted to use an invalid date or time Cannot schedule the updates check. Based on the server's time settings, the to schedule a check for updates. selected time is in the past. Recommended Action: Use a time setting that is in the future.
Note: This procedure assumes your client has internet access to the APC updates server. If not, you will need to download the updates catalog to a machine that does have access, and transfer the file to your client. 1. Access the Software/Firmware download page (http://apc.com/tools/download). 2. In the Filter by Hardware list, select StruxureWare Central , then select your part number, and click Submit. 3. In StruxureWare Central Device Firmware Catalog File listing, click Download. 4. In the APC Login/Registration page, click Login, if you are already registered, or Register, to register. 5. In the Personal Login page, log in. 6. In the Software/Firmware download page, click Download Now. 7. Once the updates catalog is downloaded, select Apply Firmware Updates in the Updates menu in the StruxureWare Central client. 8. In the "Select Device Updates" display, click Import. 9. In the "Open" display, browse to the downloaded APC updates catalog, and click Open. 10. Go to step 4 of the Performing a firmware update task to update devices using the imported APC updates catalog.
Element
Search
Description
Use the Search field to filter the list based on the text you type. Note: Only the Boolean operators AND, OR, and NOT are supported. Use the Configure Columns icon to identify the attribute columns that appear in the list. Use this list, which identifies the available updates, and the appliances or devices that can use each, to select the ones you want to update.
To select all devices listed for an available update, select the update. To select some, but not all, select the device or devices, but not the update.
Select/Deselect All Update Description Check Updates Select all the devices for all the updates. Provides information about the update selected in the list. Click to download any firmware updates available from the APC updates server for the StruxureWare Central server's monitored devices, when the server has internet access. Click to import the APC updates catalog to the server from your client, when the server that has no internet access.
Import
96
Note: A copy of the APC updates catalog zip file must already be downloaded to your client from APC. Device File Transfer Settings Click to access the display used to manage the File Transfer Protocol (FTP) or Secure Copy (SCP) access values for APC SNMPv1 and SNMPv3 devices. Note: Functionally identical versions of this display are used by the "SNMPv1/SNMPv3 Device Discovery" and "APC SNMP Device Configuration" wizards, as well as by Device File Transfer Settings, an SNMP Device Communication Settings option in the Settings menu. A change saved in one display is reflected in all. Click to perform a firmware update.
Apply Updates
Element List
Description Lists the access settings the StruxureWare Central server can use for FTP or SCP access to its monitored devices. Username: The username used for access to a device. Note: By default, the StruxureWare Central server can download firmware only to devices that use apc (lowercase) for the username and password (the actual password used for device access is identified in the "Edit Device File Transfer Settings" display). IP or IP Range: The IP address, or range of addresses, at which the access settings support FTP or SCP communication.
97
Element
Description FTP Port: The port used for FTP access to a device. SCP Port: The port used for SCP access to a device. Timeout: How long the server will wait before it considers that an attempt to access a device has failed. Retry Limit: How many times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default). Protocol: The protocol the transfer settings set will use to access devices ( FTP only, SCP only, or Try SCP, fall back to FTP).
Click to add an access setting to the list. Click to edit a selected access setting. Click to delete a selected access setting.
Use this display to add or edit the settings the StruxureWare Central server uses for File Transfer Protocol (FTP) or Secure Copy (SCP) access to APC SNMPv1 and SNMPv3 devices. Note: Functionally identical versions of this display can be accessed from the "Device File Transfer Settings" displays used by the "SNMPv1/SNMPv3 Device Discovery" and "APC SNMP Device Configuration" wizards, as well as by Device File Transfer Settings, accessed from Apply Firmware Updates, an option in the Updates menu, and by Device File Transfer Settings, an SNMP Device Communication Settings option in the Settings menu. Element
Username Password Verify Password IP or IP Range
Description
Identify the name used for access to a device. Identify the password used for access to a device. Retype the password. Identify The IP address, or range of addresses, at which the access settings support FTP or SCP communication ( *.*.*.*, by default). Identify whether the transfer settings will use FTP ( FTP only), SCP ( SCP only), or attempt to use SCP, but fall back to using FTP if SCP fails ( Try SCP, fall back to FTP). Select the port the server will use for FTP access to devices ( 21, by default).
Protocol
FTP Port
98
Select the port the server will use for SCP access to devices ( 22, by default). Identify how long the server will wait before it considers that an attempt to access a device has failed ( 3000, by default). Select the number of times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default).
Retry Limit
Element
List
Description
Provides information about the update at each device selected for a firmware updates process, either an ongoing process, or the last process performed.
Hostname: the device hostname or IP address Model: device model Location: location information for the device Status: status of the update App Version: application (App) version number of the update OS Version: operating system (OS) version number of the update Note: Reported for SNMP device updates only. Time Completed: when the update finished
Firmware Update Progress Identifies the number of Updates in progress, Updates canceled, Updates completed, and Successful updates. Click to cancel pending device updates.
Note: The StruxureWare Central server can process device updates for up to 20 devices at a time. This button appears in the Firmware Update Status view only, and only when more than 20 devices were selected to be updated. For example, if 77 devices are selected, Cancel Pending Updates appears when 99
the first set of 20 devices begins to be processed. You can click Cancel Pending Updates at this point to cancel the remaining 57 updates. If you chose not to cancel the pending updates, the button remains in the view while the second and third sets of 20 devices are processed, and disappears when the last set of 17 devices begins to be processed.
Several different status messages can be reported in this view for SNMP device updates initiated by using Apply Firmware Updates in the Updates menu.
Description The number of pending firmware updates that were cancelled. Recommended Action: None
Failed to update device: file verification failed for <file type> <file version>.
A problem occurred, after the server transferred the update to the device successfully, that prevented the server from verifying that the update at the device matches the update sent to the device. CAUTION: The device will not function correctly if the update at the device does not match the update from the server. Recommended Action: Make sure the access settings have not changed at the server or device, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ).
100
Message
Description Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device. An unknown error occurred. Recommended Action: Make sure the device is turned on and online, the appropriate file transfer protocol is enabled at the device, and that the "Device File Transfer Settings" display settings are correct. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ).
A network or file transfer protocol communication problem exists. Recommended Action: Make sure the device is turned on and online, the appropriate file transfer protocol is enabled at the device, and that the "Device File Transfer Settings" display settings used to access the device include the device's correct port number. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ). Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device.
Failed to update device: unable to log on. The server does not have the appropriate file transfer protocol settings needed to log on to the device, or communication was lost after the connection was successful. Recommended Action: Make sure the access settings needed to log on to the device are defined in the "Device File Transfer Settings" display, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ). Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device.
101
Message Failed to update device: unable to transfer <file type> <file version>.
Description A problem occurred, after the server logged on to the device successfully, that prevented the server from transferring the update. Recommended Action: Make sure the access settings have not changed at the server or device, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ). Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device.
Now the server can attempt to log on to the device. Recommended Action: None
Now the server can attempt to transfer the update to the device. Recommended Action: None
Successfully transferred <file type> <file Now the server can attempt to verify that the update at the device matches the file used version> to the device. for the update. Recommended Action: None Transferring <file type> <file version> to The server is trying to transfer the update to the device. the device... Recommended Action: None Unable to log on to the device: waiting to The server has failed at least one attempt to log on to the device, but has not reached its retry... retry limit. Recommended Action: None Unable to transfer <file type> <file version>: waiting to retry... The server has failed at least one attempt to transfer the update to the device, but has not reached its retry limit. Recommended Action: None Unable to verify <file type> <file version>: waiting to retry... The server has failed at least one attempt to verify the update at the device matches the update sent by the server, but has not reached its retry limit. Recommended Action: None Update cancelled. The update was cancelled. Recommended Action: None 102
Update pending...
Update started...
The server is trying to verify that the update at the device matches update sent by the server. Recommended Action: None
The server verified that the update at the device matches the update sent by the server. Recommended Action: None
The server is waiting for the device to restart, using the update that was transferred. Recommended Action: None
You have selected to cancel at least one pending update. Recommended Action: Click Yes to continue with the cancellation.
Several different status messages can be reported in this view for NetBotz Appliance updates initiated by selecting Apply Firmware Updates in the Updates menu.
Description An unknown error occurred. Recommended Action: Make sure the NetBotz Appliance is turned on and online, its HTTP or HTTPS web service is enabled, and the "NetBotz Appliance Credentials" display accessed from Server Administration in the Settings menu includes the correct IP Address, Port, Username, and Password settings. Correct any network connection problem.
103
Message
Description If the problem persists, contact APC Support ( http://www.apc.com/support ). A network or HTTP/HTTPS communication problem exists. Recommended Action: Make sure the NetBotz Appliance is turned on and online, its HTTP or HTTPS web service is enabled, and the "NetBotz Appliance Credentials" display accessed from Server Administration in the Settings menu includes its correct IP address and port settings. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ). Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device.
Failed to update device: unable to log on. The server does not have the FTP access settings needed to log on to the device, or communication was lost after the connection was successful. Recommended Action: Make sure the "NetBotz Appliance Credentials" display accessed from Server Administration in the Settings menu includes the correct Username and Password for the NetBotz Appliance. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. If the problem persists, contact APC Support ( http://www.apc.com/support ). Note: Once the problem is corrected, select Apply Firmware Updates in the Updates menu to update the device. Transferring update... ({0}% The update is being transferred, with how much of the transfer has occurred reported as a percentage. The update was successful. Recommended Action: None Update pending... The update is pending, but not started. Recommended Action: None Update started... The update has started. Recommended Action: None
104
Description The update still needs to be loaded at the NetBotz Appliance. Recommended Action: None
105
The Device Groups View, which interacts with every view except Camera view in some way, can be used to do the following: Use the Device View to assign devices to groups by dragging and dropping from one group to another. Access information about the device alarms at any selected group in the Active Alarms view. Select a device group for which you want to have camera information displayed in the Thumbnails view. Use the Thumbnails view to assign camera devices to groups by dragging and dropping from one group to another. Use right-click options, and the button icons at the top of the view, to perform the following functions. Create a new group, when All Devices is selected, or subgroup, when any other group, except Unassigned, is selected ( Create Device Group option). Rename a selected group, other than All Devices and Unassigned ( Rename Device Group option). 106
Delete a selected group, other than All Devices and Unassigned ( Delete Device Group option). Access the Alarm History view for any selected group ( Show Alarm History option). Access a 24-hour Graph View for up to 50 of a specific sensor type for a selected device group ( Graphing and Reporting sensor options). Note: For more information about this view, see Graph View under Graphing and Reporting feature. Initiate the process used to create a report or graph for the historical values of the sensors at selected devices ( Custom Device Report option or graph icon). Access a specific configuration option for a selected NetBotz Appliance or Appliances ( NetBotz Appliance Configuration options). Note: A NetBotz Appliance Configuration option is also in the Device menu. For information about these options, see NetBotz Appliance Configuration . Configure selected APC SNMP devices to use the same values for shared settings ( APC SNMP Device Configuration option). Note: An APC SNMP Device Configuration option is also in the Device menu. For information about these options, see APC SNMP Device Configuration . Create thresholds for a selected device, or set of devices ( Create Thresholds option). Note: For information about this option, see Create Thresholds option, under Alarm Configuration . Disable or re-enable notifications for any SNMP or Modbus device, or device group ( Enter/Exit Maintenance Mode options). Access the Custom Properties Editor view to add, modify, or remove custom properties for selected devices or sensors ( Open Custom Properties Editor option). Create a virtual sensor for a selected device group ( Create Virtual Sensor option). Note: For information about this option, see Virtual Sensors view.
1. In the Device Groups view, right-click one of the following device groups: All Devices, to add a new group. A user-defined group, to add a subgroup to the selected group. 2. Click Create Device Group. 3. Enter a name for the group or subgroup, and click Finish. 4. Assign devices to the new group by dragging and dropping devices from the Device View. 5. Click Device Group Access to edit the user and user group monitoring and surveillance access to the device group, as needed. 107
1. In the Device Groups view, right-click the group or subgroup you want to rename. 2. Click Rename Device Group. 3. Enter a name for the group or subgroup, and click Finish.
Deleting a device group
1. In the Device Groups view, right-click the group you want to delete. 2. Click Delete Device Group. 3. Click Yes in the "Confirmation" display.
1. In the Device Groups view, select the group in which the devices are currently located (including Unassigned). 2. In the Device View, highlight the devices you want to move. Note: To move a NetBotz Appliance, and its supported devices, highlight its main listing; if you highlight a device associated with a NetBotz Appliance, a copy of that device will move, and a copy remains with the NetBotz Appliance listing. 3. Drag the selected devices from the Device View to the desired group in the Device Groups view. Note: When devices are assigned to a subgroup, those devices are included in its parent group, as well.
Assigning devices to multiple groups
1. In the Device Groups view, select a group that contains one or more of the devices you want to assign to multiple device groups. Note: For devices in the Unassigned group, move them to one of the groups in which you want those devices assigned, then select that group. 2. In the Device View, highlight the devices you want to copy to another group. 3. Hold the Ctrl key down, and drag copies of the selected devices from the Device View to the desired group in the Device Groups view, including all devices associated with a NetBotz Appliance, when that appliance's main listing is selected. Note: For a device associated with a NetBotz Appliance, you can drag a copy to another group without using the Ctrl key. 4. Repeat until all devices are in the correct device groups.
108
When a device is assigned to multiple device groups, you will need to repeat this procedure for each device group. 1. In the Device Groups view, select a device group to which the devices are currently assigned. 2. In the Device View, highlight the devices you want to remove. 3. Drag the devices to Unassigned in the Device Groups view. Note: If you want to assign those devices to another group, you can drag them to that group instead of to Unassigned.
Using the right-click option in the Device View
When a device is assigned to multiple device groups, you will need to repeat this procedure for each device group. 1. In the Device Groups view, select a device group to which the devices are currently assigned. 2. In the Device View, highlight the devices you want to remove. 3. Right-click one of those devices, and highlight the Remove the device from group option. 4. Select the name of the group from which you want the devices moved. Note: The devices will be moved back to the Unassigned group.
109
Full Name
Type
110
Column
You use buttons or right-click options to add new local users or local user groups, and to edit or delete users or user groups, whether local or remote. Note: Remote users and user groups are added using the "Users and Device Group Access" display Authentication Servers tab. Add a local user using the "User Configuration" display ( Add User button or rightclick option). Note: You can select right-click and local device group and click Add User to Selected Group to add a new user directly to the selected group (this option is unavailable when a remote user group is selected). Add a local user group using the "User Group Configuration" display ( Add User Group button or right-click option). Edit the credentials, user roles, and user group membership for a selected local user using the "User Configuration" display ( Edit button or right-click option). Edit the name, user group roles, and user group members for a selected local user group using the "User Group Configuration" display ( Edit button or right-click option). Note: You cannot edit the Unassigned Users group, a group that lists local users that are not assigned to another local user group. Edit the user roles for a selected remote user using the "User Configuration" display ( Edit button or right-click option). Edit the user group roles for a selected remote user group using the "User Group Configuration" display ( Edit button or right-click option). Note: You cannot edit the Remote Users group, listed in the table only when at least one authentication server has been added using the Authentication Servers tab. Delete a local or remote user or user group ( Delete button or right-click option). Note: You cannot delete the Remote Users group, listed in the table only when at least one authentication server has been added, or the Unassigned Users group, which is always listed. Access the Device Group Access section of the Users Tab ( Device Group Access button or right-click option).
3. In the User Group Memberships tab, select the local user groups to which you want the user to belong, if any. Note: If you select a user group with StruxureWare Central Administrator identified in its Roles column, selecting any other user group will have no affect on user privileges: this user group provides full access to all server, monitoring, and surveillance functions.
112
1. In the Users and User Group Details section of the Users tab, select a listed remote group and click Edit, to access the "User Group Configuration" display. Note: For a remote user group, only the User Roles selections in the User Group Information tab are available. 2. In the User Group Roles section, select the role or roles for the group, if any, and click Apply. Note: The StruxureWare Central Administrator role provides full access to all server, monitoring, and surveillance functions.
Use this tab to define the credentials for a local user only.
Credential Username Password Verify password Full name (optional) E-mail address (optional for nonStruxureWare Central Administrators)
Definition Identify the name used to log on to the server. Type in the password to be used to log on to the server. Retype the password. Identify the user's full name. Identify the user's email address. Note: This address is used to send e-mail to a StruxureWare Central Administrator for notifications related to the StruxureWare Central server itself, and monitored NetBotz Appliances, but not for monitored SNMP or Modbus devices. Identify a role, title, or other attribute that describes the user.
Description (optional)
User Roles or User Group Roles (User or User Group Information tab)
Use this tab to select the role you want to assign to a local or remote user or user group. Note: For a non- StruxureWare Central Administrator user, including a user for which no role is selected, access privileges are determined by Device Group Access settings in the Users tab for that user, and for the user groups to which the user is assigned.
113
Description Full access to all server, monitoring, and surveillance functions for all device groups. Note: The StruxureWare Central Proxy is included automatically when the StruxureWare Central Administrator role is selected. Telnet access from the StruxureWare Central server's public network to devices on its private network. Provides no access to server, monitoring, or surveillance functions, except as defined by other settings: Local Users: User Group Memberships tab, and Device Group Access settings in the Users tab Remote Users: Device Group Access settings in the Users tab Local or Remote User groups: Device Group Access settings in the Users tab Note: Before a StruxureWare Central Proxy user can use Telnet to access a private-side device, Telnet must be enabled at that device, and SOCKS Proxy, a Server Access option for Server Administration Settings in the System menu, must be enabled.
User roles will be listed for separatelylicensed applications that require access to StruxureWare Central server data. For example, two roles are available for the InfraStruxure Operations, InfraStruxure Capacity and InfraStruxure Change applications: InfraStruxure Operations Administrator InfraStruxure Operations Viewer Note: An application's Administrator has full access to the data the StruxureWare Central server provides to that application; an application's Viewer has access only to data provided for the device groups at which that viewer has access privileges at the StruxureWare Central server.
Use this tab to select the user groups to which you want to assign a local user. Note: Local users cannot be added to remote user groups; remote users cannot be added to any user group, local or remote. 114
This tab lists all local user groups, allowing you to select the groups to which a local user is assigned. Three of those user groups are provided, by default. Note: The user will be listed under any user group in the "Users and Device Group Access display's Users tab to which it is assigned in its User Group Memberships tab. Device Administrators: by default, this user group provides Administration Access for monitoring, and No Access for surveillance, at all device groups. Device Viewers: by default, this user group provides View Access for monitoring, and No Access for surveillance, at all device groups. Server Administrators: by default, this user group provides the same access as the StruxureWare Central Administrator users role: full access to all server, monitoring, and surveillance functions. Note: You can edit the default names and access privileges for any of these user groups.
Use this setting to define the name for a local user group only.
User Group Members tab
Use this tab to select the local users you want to assign to a local user group. Note: Local users cannot be added to remote user groups; remote users cannot be added to any user group, local or remote. Lists all local users, allowing you to select which of those users you want assigned to the user group. Note: A user selected in this tab will be listed under the user group in the "Users and Device Group Access" display's Users tab.
115
Note: This users group is listed only when at least one authentication server has been added using the Authentication Servers tab. The primary StruxureWare Central Administrator user ( apc, by default). Any user or user group that has StruxureWare Central Administrator selected for its role. Note: You can change this role for any user or user group except the primary StruxureWare Central Administrator user ( apc, by default). Membership in a user group can affect a user's monitoring and surveillance access at the device groups. The settings that provide the least-restrictive access, whether it is the user's or user group's Device Group Access settings, define the access a user has. For example, if a user with No Access for surveillance at a device group belongs to a user group with View and Tag Access for surveillance at that device group, that user has View and Tag Access. Column
User or User Group Name
Description
Lists the user groups, including default ( Device Administrators, Device Viewers, Server Administrators, and Unassigned Users) and user-created groups. Users are listed under the user group to which they are assigned (local users not assigned to another group are listed under Unassigned Users; remote users are listed only under Remote Users). Note: This column is used in the Users and User Group Details section of the Users tab, as well. Reports the Monitoring and Surveillance access a selected user or user group has at the device groups.
Device Group
You can edit the access settings for a device group if Modify Device Group Access is enabled for the selected user or user group.
Note: The All Devices group access settings provide a baseline for all other device groups. The other device groups will use at least the same access settings as All Devices, but any group can be set to use less-restrictive settings. Monitoring Surveillance Reports the monitoring access a selected user or user group has at the device groups. Reports the surveillance access a selected user or user group has at the device groups.
Monitoring access
Five selections are available for user or user group monitoring access at a selected device group. Note: Users assigned the StruxureWare Central Administrator role, or assigned to a user group that has this role, have full monitoring and surveillance access, as well as access to all server functions. 116
View Access - No Camera A user with this access setting for a device group can perform the following functions for the devices in that group: Images View information about active and historical alarms. View information about device sensors. Create a Graph view for a selected sensor type that is associated with the devices. View and export copies of saved reports in a table (as .csv or .txt file) or graph (as .bmp, jpg, or .png file) format. Create and export copies of device sensor reports in a table (as .csv or .txt file) or graph (as .bmp, jpg, or .png file) format. Launch to the web interfaces at the devices. Request that the StruxureWare Central server scan a selected SNMP or Modbus device, or set of SNMP and Modbus devices, to update the available information. View Access A user with this access setting for a device group can perform the following functions for the devices in that group: View information about active and historical alarms. View information about device sensors. View NetBotz Appliance camera images. View clips in active and historical alarms. Create a Graph view for a selected sensor type that is associated with the devices. View and export copies of saved reports in a table (as .csv or .txt file) or graph (as .bmp, jpg, or .png file) format. Create and export copies of device sensor reports in a table (as.csv or.txt file) or graph (as .bmp, jpg, or .png file) format. Launch to the web interfaces at the devices. Request that the StruxureWare Central server scan a selected SNMP or Modbus device, or set of SNMP and Modbus devices, to update the available information. View and Control Access Users with this access setting for a device group can perform the same monitoring functions View Access provides, as well as the following additional functions: Change the state of a sensor in the right-click menu of the "View Device Sensors" display, when available. Change the state of an outlet in the "Outlet Control" display, when available. Administration Access A user with this access setting at a device group can perform all the same monitoring functions View Access provides, as well as the following additional functions: Create a custom Map View for the device group.
117
Monitoring Access
Description Configure NetBotz Appliance Alert Thresholds and SNMP and Modbus Thresholds for device sensors in that group. Configure NetBotz Appliance Configuration options at monitored NetBotz Appliances in that group. Configure the Device Configuration settings for SNMP and Modbus devices in that group. Configure the Device File Transfer Settings. Apply SNMP device and NetBotz Appliance firmware updates that have been downloaded to the StruxureWare Central server for the group's devices. Note: Only a StruxureWare Central Administrator can download the updates to the server.
Surveillance access
Five selections are available for a user or user group's surveillance access at a selected device group. Note: Users assigned the StruxureWare Central Administrator role, or assigned to a user group that has this role, have full monitoring and surveillance access, as well as access to all server functions. In addition to the surveillance functions identified in the following table, a user can perform all functions for the monitoring access associated with a device group: any Surveillance setting other than No Access for a device group requires at least View Access for that group's monitoring access setting. Surveillance Access No Access Description No surveillance access is provided.
View Live Feed Only (No A user with this access setting for a device group can perform the following functions for that group's camera devices: camera clips) Access the Camera view for a licensed camera in the Thumbnails view. Change the state of a sensor in the Camera view, when available, when the user is also assigned View and Control monitoring access. View Access A user with this access setting for a device group can perform the following functions for that group's camera devices: View and export surveillance clips. Access the Camera view for a licensed camera in the Thumbnails view. Change the state of a sensor in the Camera view, when available, when the user is also assigned View and Control monitoring access. View and Tag Access A user with this access setting at a device group can perform all functions View Access provides, but with the added ability to tag surveillance clips. A user with this access setting at a device group can perform all functions View and Tag Access provides, but with the added ability to 118
Administration Access
Surveillance Access
Description configure the Surveillance Settings for all camera devices, and delete surveillance clips.
119
Authentication Server" wizard, will be listed in the Groups and Users folders for the appropriate server or servers in the Authentication Servers tab, and in the Users tab. Note: When a remote user, or a user that belongs to a remote user group, attempts to log on to the StruxureWare Central server, the logon values (username and password) are sent to the authentication server associated with that user. It is that server, and not the StruxureWare Central server, that authenticates the log on attempt.
Use this display to configure the settings for the authentication server.
Description Define a name to be used as a label that identifies the authentication server. Identify the hostname or IP Address of the authentication server. Select the type of authentication server: Active Directory or OpenLDAP.
120
Description Identify the number of the port used for authentication server communication ( 389 is the default). Select to use the Secure Sockets Layer (SSL) protocol for communication between the StruxureWare Central and the authentication server.
Use SSL
Use this display to configure the settings the StruxureWare Central server uses to access the authentication server.
Description Identify the user DN required to access the authentication server. Identify the password required to access the authentication server. Identify a search base that can narrow the search scope and decrease directory lookup time at the authentication server.
Use this display to select the remote users and remote user groups that will have logon access to the StruxureWare Central server.
121
Reports menu
Provides options used to generate Sensor History reports and Snapshot reports, and manage the export configurations that are used to export reports on a scheduled basis. Note: A Manage Export Scheduling right-click option in the Saved Sensor Reports section also accesses the "Manage Export Scheduling" display. For more information about the Manage Export Scheduling option, see Reports feature.
122
Reports perspective
This perspective provides access to predefined snapshot reports, and sensor history reports you create, about the devices monitored by the StruxureWare Central server. The Reports perspective allows you to generate, view, and export reports in HTML, CSV (comma-delimited), or PDF format, for the device groups selected. Available Reports: lists the snapshot reports, sensor history reports, and saved sensor reports available for the devices the StruxureWare Central server monitors, and allows you to generate those reports for selected device groups and devices. Sensor History Reports: allows you to generate and customize sensor history reports for the devices the StruxureWare Central server monitors. Sensor history reports can be saved in the Saved Sensor Reports section, and exported in graphformat, or viewed and exported in table-format or summary-format. Snapshot Reports: allows you to generate a report, containing data for the particular time at which the report is generated, for the devices the StruxureWare Central server monitors. Snapshot reports can be viewed in graph-format only, and exported to HTML, CSV (comma-delimited), or PDF. Saved Sensor Reports: allows you to view, edit, rename, delete, and export sensor history reports you have saved. Report Views: display snapshot reports, and sensor history reports, generated for the device groups selected, and allows you to export those reports. See Snapshot Reports and Sensor History Reports for more information.
123
data or summary data reports as .csv or .txt files, and graph reports as .bmp,.jpg, or.png files. Note: You cannot save Snapshot Reports in the Saved Reports view. You can save these reports locally as *.HTML,*.CSV (comma-delimited), or *.PDF files. For more information, see Snapshot Reports .
Description
Relative: select to use a drop-down menu option that identifies a period of time you want the report to cover.
Range: select to use to define the Start and End dates for the period of time you want the report to cover.
Choose Report Format Choose Devices and Device Groups Choose Sensor Types Select Sensors Select to display the report in graph (the default), summary, or table format. Select the devices or device groups you want to include in the report. Select the sensor types you want to include in the report.
Search and Clear: use to search for a specific sensor, or to narrow the list to include only those sensors that include your typed text. Configure Columns icon: identify the columns that appear in the display. Sensors list: select the device sensors you want the report to include. When modifying an existing report, the list includes all sensors for the devices that were selected when the report was created or last edited,
124
with the following information provided for each sensor: Device: device label Sensor: sensor name Sensor Type: sensor type Alarm State: current sensor status Location: device location, if known Device Status: current device status Hostname: device hostname or IP address
Select/Deselect All: use to select to include all sensors in the report, or to deselect the currently selected sensors.
Description
Define or modify the name that will identify the report in the Saved Reports view. Select to enable the report data export on a scheduled basis. Select to export summary-report data only. Select the name of an existing export configuration. Click to use the "Add Export" wizard to add a new export configuration. Select how the report data will be delimited for export: Comma, Semicolon, Space, or Tab. Choose the columns, including those created using custom property keys, and the order in which they will appear in the report. Note: This option is not available when Export Summary Data Only is selected. Select to specify the locale for the report data or Use Server Locale (the default). Days: Select the day or days of the week for the exports.
Locale Scheduling
125
Report Interval
Graph-format reports
This report format provides data, in the form of a graph and device sensor list, for up to 1026 device sensors. Note: You can access a graph-format report view by clicking Generate Report in the Reports perspective, and choosing Graph as the report format (the default), or by selecting a report in the Saved Reports view.
The name ( *Sensor History Report, for an unsaved report) is identified on the tab for each report; the sensor type and time frame is identified at the top of each report. You can select the Trend Line button icon to display a linear trend line when all numeric sensors included in the graph-format report use the same unit of measure. Trend lines are calculated using a linear regression model and the ordinary least squares estimation method. All the available data returned by the StruxureWare Central server for the sensors selected, and the time range specified for the report, are considered in the model. The data are extended for twice the specified time range to create the trend line. For example, in a report with a time range of seven days, the linear regression is calculated over fourteen days: seven days of actual data, and seven days of prediction. You can use the device sensor list columns, right-click menu, and button icons, to do the following: Click a column title to sort the list in ascending or descending order based on that column's information. Edit the date range, report format, or sensors for a selected report using the "Report Criteria" display ( Edit Report Criteria option or icon). Edit the report name or export properties using the "Name and Schedule Data Export" display ( Edit Report Criteria option or icon). Save a copy of the report as a *.bmp (the default selection), *.jpg, or *.png file ( Export Graph icon). Access the "Set Refresh Rate" display used to control how often an open graph will refresh automatically, if at all ( Refresh icon). Note: The refresh settings are client-specific, and have no affect on the refresh settings used by other StruxureWare Central clients. Display a linear trend line for twice the time period as the data, on numeric sensors only, when all numeric sensors included in the graph use the same unit of measure ( Trend Line icon). Highlight the point for which data is displayed when you move the cursor over the graph ( Marker icon). Click and drag the graph to view a specific area ( Pan icon). View a summary-format version of a selected report ( Summary Data icon or Open Summary Data option). View a table-format version of a selected report ( Table Data icon or Open Table Data option). Name a report and save it in the Saved Reports section of the Available Reports view ( Save icon). View the graph in more or less detail ( Zoom In or Zoom Out option and icon). Note: You can click and drag the cursor to select a portion of the graph to view in more detail. 126
Reset the graph back to its original position ( Reset Graph Position option).
Graph section
Provides a graphic representation of the values reported by the device sensors included in a Sensor History Report or Custom Sensor History Report , over the period of time selected. Every device sensor is represented by its own color, as identified in the device sensor list. The time frame is identified below the title, and labeled along the bottom of the graph. For a Sensor History Report , a single sensor's value range is labeled along the left-side of the graph. For Custom Sensor History Reports , which can cover multiple types of sensors, one sensor value range is labeled along the left-side of the graph, while any additional value ranges for the report's sensors are labeled to the right of the graph. A linear trend line is plotted on graph-format reports for twice the time period as the data, on numeric sensors only, when all numeric sensors included in the graph use the same unit of measure.
Sensor list section
Lists and provides information about each device sensor included in a Sensor History Report , including the color used to represent values for each sensor in the graph.
Column
Color
Description
The color used for the sensor values in the graph.
Note: You can deselect the color to remove sensor values from the graph, or select (the default), to include the sensor values.
Location Parent Device The location of the sensor, if known. StruxureWare Central for SNMP and Modbus devices, or the hostname of a NetBotz Appliance for devices monitored by a NetBotz Appliance. The device label. The sensor type, followed by a name, if the sensor has one. The unit of measurement for numeric sensors, only. The last reported value during the time span of the report. The lowest value measured by numeric sensors only, during the time span of the report. The highest value measured by numeric sensors only, during the covered time span. The average value measured by numeric sensors only, during the covered time span.
Monitored Device Sensor Units Last Known Value Minimum Value Maximum Value Average Value
127
Use this display to control how often the selected graph-format Sensor History Report or Custom Sensor History Report will refresh automatically, if at all.
You can use any auto-refresh setting when you create a graph with less than 50,000 data points. When you create a graph with 50,000 - 199,999 data points, the graph will refresh only when you select a refresh interval of five minutes or greater. When you create a graph with 200,000 data points or more, the graph will not refresh. Note: These settings are client-specific, and have no affect on the refresh settings used by other StruxureWare Central clients. Element
Enable Graph Refresh
Description
Enable (check-marked) or disable (default setting) the automatic refresh of the graph-format report. Select how often the report will refresh ( 5 Minutes, by default).
Refresh Interval
This display allows you to view and save the data in a graph-format report as a table.
You click the Table Data icon or select the Open Table Data option in a graph-format Sensor History Report to view data as a table. The "Sensor Table Data" display shares all the same features as a table-format Sensor History Report with the following exceptions: Sensor table data cannot be saved in the Saved Reports section of the Reports perspective. The report criteria for the table data cannot be modified. Scheduled data export is not available. The number of sensors covered in the report, total number of data points, and the time frame are identified at the top of each table. You can use the search feature, table columns, and button icons, to do the following: Type text in the Search field to locate a specific device or sensor in the report, or to narrow the list to a particular set of device sensor entries. Click a column title to sort the list in ascending or descending order based on that column's information. Select the columns, and the order in which they appear in the table, and choose whether or not to highlight alarming sensors in the table ( Edit Report Options icon). Save sensor table data as a *.csv (the default selection) or *.txt file ( Save Report Data and chevron icons). Note: You must use the chevron icon to select the *.txt format. Browse through a multiple-page report ( Go to arrow icons, and a box that identifies the page number). Column
Device Parent Device
Description
The device label. <hostname> (StruxureWare Central) for SNMP and Modbus devices, or the IP address or
128
hostname of a NetBotz Appliance for devices monitored by that appliance. Sensor Location Time Value Unit Status The sensor name. The location of the sensor, if known. The date and time of the most recent sensor value change. The value measured at the identified date and time. The unit of measurement for numeric sensors, only. The sensor status: Alarm (when a Warning, Error, Critical, or Failure condition exists), or no text (when no alarm condition exists). Note: Sensor status is reported only for sensors that have been configured at the StruxureWare Central server, for SNMP and Modbus devices the server monitors directly, or at the NetBotz Appliances, for devices monitored by those appliances, using Alert Thresholds, the NetBotz Appliance Configuration > Alert Settings options in the Device menu.
This display allows you to view and save the data in a graph-format report as a summary.
You click the Summary Data icon or select the Open Summary Data option in a graphformat Sensor History Report to view data as a summary. The "Sensor Summary Data" display shares all the same features as a summary-format Sensor History Report with the following exceptions: Sensor summary data cannot be saved in the Saved Reports section of the Reports perspective. The report criteria for the summary data cannot be modified. Scheduled data export is not available. The total number of data points are identified at the top of each table. You can use the search feature, table columns, and button icons, to do the following: Type text in the Search field to locate a specific device or sensor in the report, or to narrow the list to a particular set of device sensor entries. Click a column title to sort the list in ascending or descending order based on information in that column. Choose whether or not to highlight alarming sensors in the table ( Edit Report Options icon). Save sensor summary data as a *.csv (the default selection) or *.txt file ( Save Report Data and chevron icons). Note: You must use the chevron icon to select the *.txt format. Browse through a multiple-page report ( Go to arrow icons, and a box that identifies the page number). A summary-format report shares all of the same features as a table-format report, with the following exceptions: A table-format report provides entries for each value change at those sensors during the reports time-frame; a summary-format report provides a single entry for each
129
selected sensor that summarizes the values at those sensors during the reports timeframe. Unlike a table-format report, a summary-format report does not include a Status column. Note: A summary-format report includes information about the Last Known Value, which has a different meaning than the Value reported by a table-format report. Only a summary report includes the following information: Column Minimum Value Maximum Value Average Value Last Known Value Description The lowest value recorded during the time-frame of the report. The highest value recorded during the time-frame of the report. The average of the values recorded during the time-frame of the report. The most recent value recorded before the end of the time-frame of the report.
Table-format reports
This report format provides sensor data, in the form of table that lists all device sensors included in a report.
You create a table-format Sensor History Report by selecting the Table report format in the "Report Criteria" display. You can access a table-format report view of a previously generated report: Select the Edit Report Criteria icon in the report view, and the Table report format. Select the Edit Report Criteria right-click option in Saved Reports in the Reports perspective, and the Table report format. Note: You can click the Table Data icon or select the Open Table Data option in a graphformat Sensor History Report to view data as a table. See "Sensor Table Data" display. The number of sensors covered in the report, total number of data points, and the time frame are identified at the top of each table. You can use the search feature, table columns, and button icons, to do the following: Type text in the Search field to locate a specific device or sensor in the report, or to narrow the list to a particular set of device sensor entries. Click a column title to sort the list in ascending or descending order based on that column's information. Edit the date range, report format, or sensors for a selected report using the "Report Criteria" display ( Edit Report Criteria icon). Edit the report name or export properties using the "Name and Schedule Data Export" display ( Edit Report Criteria option or icon). Name a report and save it in the Saved Reports section of the Available Reports view ( Save icon). Select the columns, and the order in which they appear in the table, and choose whether or not to highlight alarming sensors in the table ( Edit Report Options icon). Save sensor table data as a *.csv (the default selection) or *.txt file ( Save Report Data and chevron icons). Note: You must use the chevron icon to select the *.txt format.
130
Browse through a multiple-page report ( Go to arrow icons, and a box that identifies the page number). Column
Device Parent Device
Description
The device label. <hostname> (StruxureWare Central) for SNMP and Modbus devices, or the IP address or hostname of a NetBotz Appliance for devices monitored by that appliance. The sensor name. The location of the sensor, if known. The date and time of the most recent sensor value change. The value measured at the identified date and time. The unit of measurement for numeric sensors, only. The sensor status: Alarm (when a Warning, Error, Critical, or Failure condition exists), or no text (when no alarm condition exists). Note: Sensor status is reported only for sensors that have been configured at the StruxureWare Central server, for SNMP and Modbus devices the server monitors directly, or at the NetBotz Appliances, for devices monitored by those appliances, using Alert Thresholds, the NetBotz Appliance Configuration > Alert Settings options in the Device menu.
Use this display to choose the columns and the order in which they appear in the tableformat report.
Type
Highlight Alarming Sensors
Description
Select to highlight (in red) the Value for sensors that have active alarm conditions when a threshold setting has been defined for that alarm at the StruxureWare Central server, for a sensor associated with a monitored SNMP device, or at a NetBotz Appliance associated with a sensor. Lists columns created using custom property keys, and any default columns not included in the report. Allows you to choose the columns to include in the report. Lists the columns to include in the report. Allows you to specify the order in which the columns appear in the report. Select the interval between entries in a report.
Available Columns
131
Summary-format reports
This report format provides sensor data, in the form of a table, that identifies all device sensors that were included in the report, and summarizes the values measured by those sensors during the time-frame specified for the report.
You create a summary-format Sensor History Report by selecting the Summary report format in the "Report Criteria" display. You can access a summary-format report view of a previously generated report: Select the Edit Report Criteria icon in the report view, and the Summary report format. Select the Edit Report Criteria right-click option in Saved Reports in the Reports perspective, and the Summary report format. Note: You can click the Summary Data icon or select the Open Summary Data option in a graph-format Sensor History Report to view data as a summary. See "Sensor Summary Data" display. A summary-format report shares all of the same features as a table-format report, with the following exceptions: A table-format report provides entries for each value change at those sensors during the reports time-frame; a summary-format report provides a single entry for each selected sensor that summaries the values at those sensors during the reports timeframe. Unlike a table-format report, a summary-format report does not include a Status column. Note: A summary-format report includes information about the Last Known Value, which has a different meaning than the Value reported by a table-format report. Only a summary report includes the following information: Column Minimum Value Maximum Value Average Value Last Known Value Description The lowest value recorded during the time-frame of the report. The highest value recorded during the time-frame of the report. The average of the values recorded during the time-frame of the report.
The most recent value recorded before the end of the time-frame of the report. The total number of data points covered in the report are identified at the top of each summary. You can use the search feature, columns, and button icons, to do the following: Type text in the Search field to locate a specific device or sensor in the report, or to narrow the list to a particular set of device sensor entries. Click a column title to sort the list in ascending or descending order based on that column's information. Edit the date range, report format, or sensors for a selected report using the "Report Criteria" display ( Edit Report Criteria icon). Edit the report name or export properties using the "Name and Schedule Data Export" display ( Edit Report Criteria option or icon).
132
Name a report and save it in the Saved Reports section of the Available Reports view ( Save icon). Select the columns, and the order in which they appear in the table, and choose whether or not to highlight alarming sensors in the table ( Edit Report Options icon). Save sensor table data as a *.csv (the default selection) or *.txt file ( Save Report Data and chevron icons). Note: You must use the chevron icon to select the *.txt format. Browse through a multiple-page report ( Go to arrow icons, and a box that identifies the page number).
"Edit Report Options" display (summary-format)
Use this display to highlight active Critical, Error, Failure, and Warning alarms in the summary-format report.
Type
Highlight Alarming Sensors
Description
Select to highlight (in red) the Value for sensors that have active alarm conditions when a threshold setting has been defined for that alarm at the StruxureWare Central server, for a sensor associated with a monitored SNMP device, or at a NetBotz Appliance associated with a sensor.
Snapshot Reports
This section provides access to predefined reports about the devices monitored by the StruxureWare Central server.
The Snapshot Reports section allows you to generate, view, and export reports in HTML, CSV (comma-delimited), or PDF format, for the device groups selected. Element
UPS Runtime
Description
Lists UPS systems, by IP Address, within available UPS Runtime-range categories (for example, <10 minutes). Lists the number of monitored devices for each device type, by model name. Lists UPS systems, by IP address, within Battery Age-range categories (for example, 2-3 years). Lists the % Humidity, by sensor, within Humidityrange categories (for example 40-50). Lists the Temperature, by sensor, within Temperature-range categories (for example 60-80). Allows you to choose the device groups you want to include in the report selected.
Generate Report
133
You can use the Go To arrow icons to browse through a multiple-page report, along with the box that identifies the page being viewed. Icon Description
Use the chevron icon included with this Export icon to save the selected report as *.HTML, *.CSV, or *.PDF.
Element
Device Group
Description
Check-mark the groups you want to include in the report selected Note: All device groups, and the Select/Deselect All option, are check-marked by default. Click to render the report for the device groups selected.
Generate Report
Icon
Description Use this Edit Report Criteria icon to edit the time frame or sensors you want a selected report to cover. Use this Marker icon to highlight the point for which data is displayed when you move the cursor over the graph. Use this Pan icon to click and drag the graph to view a specific area. Use this Zoom In icon to view the graph in more detail.
134
Icon
Description Use this Zoom Out icon to view the graph in less detail. Use this Summary Data icon to view a summary-format version of a selected report. Use this Table Data icon to view a tableformat version of a selected report. Use this Trend Line icon to view a linear trend line for the same time period as the data, on numeric sensors only, when all numeric sensors included in the graph use the same unit of measure. Use this Refresh icon to select how often reports will refresh. Use this Save icon to name a report and save it in the Saved Reports section of the Available Reports view. Note: An asterisk (*) preceding the report name indicates the report has not been saved. Use this Export icon to save a copy of a report to the local drive.
Icon
Description Use this Edit Report Criteria icon to edit the time frame or sensors you want a selected report to cover. Use this Save icon to name a report and save it in the Saved Reports section of the Available Reports view. Note: An asterisk (*) preceding the report name indicates the report has not been saved. Use this Save Copy of Graph icon for a graph-format report to save it as a *.bmp, *.jpg, or *.png file. Use this Save Report Data icon for a tableformat or summary-format report to save a copy of the report as a .*txt or *.csv file. Note: You must use the chevron icon included with this Save Report Data icon in 135
Icon
Description table-format and summary-format reports to select *.txt. Use this Edit Report Criteria icon to edit the time frame or sensors you want a selected report to cover.
The snapshot report views have one icon and Go to arrow icons you can use to browse through a multiple-page report, with a box that identifies the page being viewed.
Icon
Description Use this Export icon to export a copy of the snapshot report as an *.html file. Note: You must use the chevron icon included with this Export icon to select *.csv (comma-delimited) or *.pdf
136
Element
List
Description
Lists the export configurations for saved reports, and provides the following information about each:
Saved Sensor Report: the name of the report scheduled for export. Scheduled Days: the day or days of the week for the exports. Scheduled Time: the time of day for the exports. Scheduled: whether or not the report export is enabled. Summarized Export: whether the export is summary-report data only. Export Name: the name of the export configuration. Export Type: the type of the export configuration.
Export Action Configuration Click to access the display used to manage actions used to export saved reports from the StruxureWare Central server. Click to access the display used to modify report criteria for the selected report. Click to access the display used to modify or schedule data export for the selected report. Click to remove the saved report from the StruxureWare Central server.
Element
List
Description
Lists the saved export action configurations, and provides the following information about each:
Export Name: the name defined for the export action. Export Type: the type of export used (Email, FTP, etc.). Server Hostname: the hostname or IP address of the server used, if any. Username: the username used to access the server, if any. 137
Click to use the "Add Export" wizard to add an export configuration action. Click to use the "Edit Export" display to edit the settings of a selected export action configuration. Click to delete a selected export action configuration.
138
Option
E-mail Export FTP Export HTTP Export NFS Export Windows Export
Description
Click to add e-mail settings. Click to add FTP settings. Click to add HTTP settings. Click to add NFS settings. Click to add Windows settings.
Description
Define the name for the e-mail export settings. Define the subject of the e-mail message that will be generated and sent. Define the body of the e-mail message that will be generated and sent. Lists the e-mail addresses to which reports will be sent. Click to add an e-mail address to the list. Click to remove a selected e-mail address from the list. Click to test the export settings. Note: Verify an e-mail message actually was received.
139
Element
Export Name Server Hostname or IP Port Use Passive Transfer
Description
Define the name for the FTP export settings. Identify the hostname or IP address of the FTP server at which reports can be saved. The port the server uses for FTP communication ( 21, by default). Select to use passive FTP transfers when communicating with the FTP server. Note: Passive FTP transfers can be useful if your StruxureWare Central server is communicating across a firewall. Identify the name used to access the FTP server. Identify the password used to access the FTP server. Retype the password. Identify the path to be used for storing reports at the defined server. This path should always be relative to the default directory associated with the username that accessed the server. Note: If the directories you define for the path do not exist, they will be created automatically. Click to test the export settings. Note: Verify the test data actually was saved at the target directory on the FTP server.
Test Export
Element
Export Name Target URL Server Requires Authentication
Description
Define the name for the HTTP export settings. Identify the full URL to where reports will be posted at the target server. Activate the Username, Password, and Verify Password settings used for authenticated HTTP server access. Identify the name needed to post data to the HTTP server at the specified Target URL.
Username
140
Identify the password needed to post data to the HTTP server at the specified Target URL. Retype the password. Select No verification, Verify certificate, or Verify certificate and hostname. Click to test the export settings. Note: Verify the test data actually was posted and saved at the target server.
Element
Export Name Server Hostname or IP
Description
Define the name for the NFS export settings. Identify the hostname or IP address of the UNIX server running NFS that you want to receive the exported report data. Identify the name of the directory used for file sharing on the server. Identify the subdirectory to be used to store reports. Note: The subdirectory field is optional: if no subdirectory is specified, data will be stored in the Share root directory. Click to test the export settings. Note: Verify the test data actually was saved at the NFS server, in the correct Share and subdirectory (if used).
Share Subdirectory
Test Export
Element
Export Name Server Hostname or IP Username Password Verify password
Description
Define the name for the Windows export settings. Identify the hostname or IP address of the Windows share server. Identify the name needed to connect to the share at the Windows server. Identify the password needed to connect to the share at the Windows server. Retype the password.
141
Identify the domain to which the Windows share is connected. Identify the name of the shared folder at the Windows server. Identify the subdirectory to be used to store reports. Note: The subdirectory field is optional: if no subdirectory is specified, data will be stored in the Share root directory. Click to test the export settings. Note: Verify the test data actually was saved in the proper folder on the Windows server.
Test Export
142
Find the device associated with the selected alarm in the Navigation view. Expand the list when there is more than one device alarm in the selection.
You can create and configure thresholds, alarm actions, and notification policies, or modify device alarm configurations, at any time, in any order. For example, you can create alarm actions first, create thresholds, then add selected actions, thresholds, and devices, as needed, to the Default notification policy. Alternatively, you can create new notification policies first, then create actions or thresholds, and add them to any notification policy.
"Search" field
Use the Search field to filter the list based on text you type.
You can broaden or narrow your search using the Boolean operators AND, OR and NOT. For example, you can search for UPS AND On Battery; PDU NOT Phase 1; Humidity OR Temperature; Humidity OR Temperature NOT UPS. Only items that contain the text you specify in the Search field are displayed. When the results of a search are displayed, the background of the search field is shaded. When you clear the search field, the background shading is removed and all items are displayed. Note: Search fields support the Boolean operators AND, OR, and NOT only.
144
Navigation View
This view in the Alarm Configuration perspective shows the device groups and devices for which thresholds and device alarms can be configured on SNMP and Modbus devices. You can select a device group or device in the Navigation view to display the thresholds or device alarms that can be configured or added to a notification policy for that selection. Thresholds are displayed in the Threshold Alarm Configuration view; device alarms are displayed in the Device Alarm Configuration view. The number of thresholds or device alarms associated with each device group or device is shown next it, in parentheses. You can use the Search fields to filter the list based on text you enter in the Navigation, Threshold Alarm Configuration, and Device Alarm Configuration views; only items that contain the text you type are listed. When the results of a search are displayed, the background of the search field is shaded. When you clear the search field, the background shading is removed and all items are displayed. Note: You can hold the Ctrl key down to select multiple items. You can use the right-click options and the button icons at the top of the view to do the following: Create thresholds for any sensor value reported for any device group or device ( Create Thresholds option). Edit the thresholds for the device group or device selected ( Edit Thresholds option). Access the "View Device Sensors" display to see current sensor data for the selected device ( View Device Sensors option). Prevent alarm notifications from occurring for the device groups or devices selected ( Enter Maintenance Mode option). Re-enable alarm notifications for the device groups or devices selected ( Exit Maintenance Mode option). Add the thresholds for the selected device group or device to a specified notification policy ( Add Thresholds to Notification Policy option). Remove the thresholds for the selected device group or device from a specified notification policy ( Remove Thresholds from Notification Policy option). Enable or disable, modify the severity and recommended action, and add a custom description on one or more alarms for the device group or device selected ( Edit Device Alarm Configuration option). Change the notification policy associated with the device alarms in the device group or device selected ( Change Device Alarm Notification Policy option). Note: All device alarms for all devices are added to the Default notification policy at device discovery. Access the "Configure Navigation Tree Labels" display to select up to three labels to specify how monitored devices appear in the navigation tree ( Configure Navigation Tree Labels icon ( )).
145
Icon
Description Use this Configure Navigation Tree Labels icon to identify up to three labels that appear in the navigation tree. The device type and hostname are displayed by default.
Use this display to select up to three labels to specify how monitored devices appear in the navigation tree. This affects the navigation tree in the Navigation view and the Choose Thresholds display in the Notification Policies view. Note: The device type and hostname are displayed by default. Label
Groups Type Model Hostname
Description
The names of any device groups a device belongs to, including Unassigned. The type of device. The device model, if known. For example, Symmetra PX, for an APC/MGE UPS. The hostname, or IP address, if no hostname is defined, for a monitored SNMP or Modbus device. The serial number assigned to a device, if known. The IP address used by a monitored SNMP or Modbus device. The location associated with a device, if known. The application or firmware version number for a device, if known. For example, v3.5.8, for a Smart-UPS 3000 RM device. The label of the device. Indicates whether notifications have been disabled for the device. All custom property keys, identified by name. The name of the contact associated with the device.
Numeric thresholds: Air Flow Audio Current (Amps) Dew Point Energy (kWh) Humidity Other Numeric Sensors Power (VA) Power (kVA) Power (Watts) Power (Kilowatts) Temperature Voltage State thresholds: Door Dry Contact Motion Sensor Other State Sensors Both types of thresholds allow you to do the following: Create thresholds at one time for multiple sensors of the same type (for example, all are Humidity sensors, or all are Door sensors). Specify the severity and return-to-normal parameters for any defined threshold. Provide a custom URL and custom description for any defined threshold. Configure Threshold Scheduling to specify when any defined threshold is active. Add any defined threshold to one or more StruxureWare Central notification policies. Five menus provide access to create alarm thresholds: Create Thresholds , an option in the Alarm Configuration menu. Right-click menu Create Thresholds in the navigation tree in the Navigation view. Right-click menu Create Thresholds in the Device Groups view in the Monitoring perspective. Right-click menu Create Thresholds in the Device View in the Monitoring perspective. Right-click menu Create Thresholds in the Map View in the Monitoring perspective. Each threshold option allows you to search the sensors monitored by the StruxureWare Central server that match the selection. You can add a threshold to one of those sensors, or add thresholds with the same settings to any number of those sensors simultaneously. Using the right-click menus to add thresholds to one or more sensors allows you to focus threshold management to the sensors at a single device, or at a set of devices.
Creating numeric and state thresholds
All numeric and state thresholds use the same basic procedure and displays to create threshold settings. Note: The same displays are used to create thresholds when you select the Create Thresholds option in any of the following: The Alarm Configuration menu. The right-click menu in the navigation tree in the Navigation view of the Alarm Configuration perspective. The right-click menu in the Device Groups, Device View, or Map View of the Monitoring perspective.
147
Threshold settings for all monitored devices are available when you use the Alarm Configuration menu options. Threshold settings for only the device group or device selected are available when you use the right-click menu in the Navigation view, Device Groups, Device View, or Map View. 1. Select the sensor type on which you want to add a threshold from the Create Thresholds option in the Alarm Configuration menu. Alternatively, select a device group or device in the Alarm Configuration or Monitoring perspective views, and right-click to select the Create Thresholds option. 2. In the "Select Threshold Type" display, select the threshold type you want to add, and click Next. 3. In the "Select Sensors" display, select the sensor or sensors for which you want to add thresholds, and click Next. 4. In the "Create Threshold" display, define the settings, and, if desired, configure when the StruxureWare Central server will generate notifications if the threshold becomes active using the Threshold Scheduling button, and click Next. 5. In the "Select Notification Policies" display, select the notification policies to which you want to add the alarm threshold, and click Finish to exit the wizard.
Thresholds and supported devices
Which thresholds can be used for sensors at the monitored devices depends on the type of device. For a full SNMP support device or Modbus device monitored by the StruxureWare Central server, all threshold options except Dew Point can be used to define threshold settings the StruxureWare Central server will monitor for that device. These thresholds are created using the Create Thresholds option.
NetBotz Appliances:
When you create alert thresholds for a NetBotz Appliance, its sensor pods, camera pods, and monitored SNMP devices (using Alert Settings, a NetBotz Appliance Configuration option in the Device menu), the threshold settings are set at the NetBotz Appliance. It is the NetBotz appliance that stores the settings and sends the alerts to the StruxureWare Central server. Note: Because NetBotz Appliance alert profiles are device-specific, you will not be able to configure the profile for a threshold setting when configuring that setting for multiple appliances.
148
Numeric alarm thresholds are thresholds defined for sensors that report numeric values. There are nine specific types of numeric thresholds that can be set on numeric sensors.
Value
Description
Settings for sensors that measure air movement as feet per minute. Note: Sensors that use a different measurement, such as cubic feet per minute (CFM) will be displayed under the Other Numeric Sensors option. Settings for sensors that measure the volume of sound. Settings for sensors that measure current as total amperage (amps). Settings for sensors that measure dew point as degrees Fahrenheit (F) or Celsius (C). Settings for sensors that measure energy consumption as kilowatt hours (kWh). Settings for sensors that measure relative humidity as a percentage (%). Settings for sensors that measure numeric settings not reported for other Thresholds options. Settings for sensors that measure power as total Voltamperes (VA) or kiloVoltamperes (kVA). Note: Sensors that measure power as a percentage of VA will be displayed under the
Dew Point
Energy (kWh)
Humidity
% (0 - 95)
Varied
Power (VA)
VA and kVA
149
Other Numeric Sensors option. Power (Watts) W and kW Settings for sensors that measure power as total watts (W) or kilowatts (kW). Settings for sensors that measure temperature as degrees Fahrenheit (F) or Celsius (C). Settings for sensors that measure either AC or DC voltage as total volts (V).
Temperature
Voltage
Description
An alarm occurs when the sensor's value is below the Minimum setting. An alarm occurs when the sensor's value is above the Maximum setting. An alarm occurs when the sensor's value is outside the range defined by the Minimum and Maximum settings. An alarm occurs if the sensor value is below the Minimum setting for longer than the delay in the Time Allowed Below Minimum setting. An alarm occurs if the sensor value is above the Maximum setting for longer than the delay in the Time Allowed Above Maximum setting. An alarm occurs if the sensor value increases by more than the Maximum Increase setting since the last time the sensor value was sampled. For example, at a sensor that measures amps, 1 would result in an alarm when the amps measured by the sensor increases by one amp. An alarm occurs if the sensor value decreases by more than the Maximum Decrease setting since the last time the sensor value was sampled. For example, at a sensor that measures total watts (W), 100 would result in an alarm when the watts measured by that sensor goes down 100 watts.
The Other Numeric Sensors option allows you to set thresholds for numeric sensors that monitor values not covered by the nine threshold-specific numeric options. The following lists identify some common examples of numeric sensors you can configure using the Other Numeric Sensors option. The actual sensors will depend on the device types managed by the StruxureWare Central server. Note: You can configure multiple sensors discovered for the Other Numeric Sensors option, when the sensors you select can all use the same threshold settings. For example, 150
battery and UPS age sensors use the same units of measure, and can be configured at the same time, as can utility, input, and output voltage sensors.
UPS Battery Sensors: Battery Age Battery Runtime Remaining Battery Capacity Remaining Time Running on Battery
Other UPS Sensors: UPS Age Input Frequency Output Frequency Output Load Output Power Percent VA
Other Sensors: Max Number of Output Relays Max Number of Input Contacts Runhours of Fan Air Flowrate of Fan (in cfm) Total Air Flow (in cfm) RPM Speed of Fan
State thresholds are thresholds defined for sensors that report state values. There are three specific types of state thresholds that can be set for state sensors.
Value
Open or Closed
Description
Settings for sensors that determine whether a door is open or closed.
Dry Contact
Unknown, No Fault, or Fault Settings for sensors that determine the fault status of dry contacts. No Motion or Motion Detected Settings for sensors that detect motion. Varied Settings for sensors that measure state settings not reported for other Thresholds options.
Description
An alarm occurs when the sensor state matches the Alarm State setting. An alarm occurs when the sensor state does not match the Normal State setting. Note: This threshold setting is useful for sensors that can report more than two states. An alarm occurs when the sensor state matches the Alarm State setting for longer than the delay in the Time Allowed in Alarm State setting.
151
An alarm occurs when the sensor state does not match the Normal State setting for longer than the time defined by the Time Allowed in Alarm State setting. Note: This threshold setting is useful for sensors that can report more than two states.
The Other State Sensors option allows you to set thresholds for state sensors that monitor operational states not covered by the three threshold-specific, state options. The following lists identify some common examples of state sensors you can configure using the Other State Sensors option. The actual sensors will depend on the device types managed by the StruxureWare Central server. These options use the same set of four threshold settings as the other state threshold options. Note: You can configure multiple sensors discovered for the Other State Sensors option, when the sensors you select use the same alarm states settings. For example, all sensors that use On and Off states can be configured at the same time, as can all sensors that use Up and Down.
Active/Inactive: Button Temperature Override Status Open/Closed: Input Contact Output Relay Bypass On/Off: Switch Outlet Alarm Device Test Relay Other Settings: Ethernet Link UPS Input Voltage (line neutral) Current Output Phase
Fault/No Fault: Contact Input State Connected/ Disconnected: Speakers External Microphone Yes/No: UPS on Bypass UPS on Battery Audio Alarm Battery Low Overload Inverter Off UPS Over Temperature Utility Power Failure Battery Needs Replacement Battery Fault
Multiple Statuses:: Online Device Status Battery Status UPS Status Communication Status Alarm State Self-Test Runtime Calibration Reason for Last Transfer to Battery Battery Charge Fault Rack ARU Operating Status of Fan ARU Primary Power Present
This display allows you to select the type of threshold for which you want to create an alarm. You use this display to choose the type of threshold you want to create on any available sensors for the device group or device you select. The types of thresholds available depend on the type of sensor you select.
152
Note: Once you access this display, you must select a threshold type and click Next or click Cancel to exit the wizard.
"Select Sensors" display
Use this display to select the sensors on which you want to create an alarm threshold.
When you access this display from the Alarm Configuration menu Create Thresholds option, all the sensors monitored by the StruxureWare Central server for the selected threshold type are listed. When you access this display from the right-click menu in the Navigation view of the Alarm Configuration perspective, only the sensors for the selected device group or device are listed. You can select the Configure Columns icon to identify the columns that appear in the display. You can click the column headers to sort the list in ascending or descending order. Column
Sensor Current Reading Hostname Unit of Measure Device Type
Description
Identifies the sensors that can be configured for the threshold selected. The most recent value reported by the sensor. Identifies a device by its hostname, or IP address when no hostname is defined. Defines the unit of measure for numeric sensors only. Identifies a device by its type, or by SNMP Device, if the StruxureWare Central server cannot determine the device type. Identifies a device by its model number, when known. Identifies a device by its label, or IP address. <server_name> (StruxureWare Central) for devices monitored by the StruxureWare Central server. A custom property key, identified by name.
Use this display to configure the settings for the identified threshold. In addition to the settings provided, the display also identifies the name of the sensor ( Sensor Name), the type of sensor ( Sensor Type) and value currently read by the sensor ( Current Reading), and allows you to define a name for the threshold setting ( Threshold Name). You can use the Threshold Scheduling button to access the Threshold Schedule display to configure when the threshold alarm action will be active. Note: When more than one sensor is selected, the name of the sensor is identified in the display as <Multiple>, and value currently read by the sensor is identified as <Multiple Values>.
Threshold settings :
153
Element
Threshold value
Description
Define the criteria for the threshold. Note: The available value fields will depend on the type of numerical or state threshold selected. Select to enable the threshold, if it is disabled. Note: Thresholds are enabled by default. Select the severity you want associated with the threshold: Information, Warning, Error, Critical, or Failure. Select to clear a threshold violation only when a user with Administrator privileges marks the alarm condition as resolved. Define a delay, in seconds, that will occur after a threshold is no longer violated before the alarm condition clears. This delay helps prevent multiple alarms for values that may rapidly switch between alarm and non-alarm conditions before a problem finally clears. Provide a description you want included in a threshold's alarm notifications. Identify an Internet address you want included in an alarm notification for the threshold.
Enabled Severity
Return-to-Normal Delay
This display allows you to select the notification policies to which to add the selected threshold. You can add the threshold to one or more existing notification policies, or none. Note: The Default notification policy is selected by default and can be deselected.
Voltage State thresholds: Door Dry Contact Motion Sensor Other State Sensors Communication threshold Communication status All types of thresholds allow you to do the following: Edit thresholds at one time for multiple sensors of the same type (for example, all are Humidity sensors, or all are Door sensors) at the devices monitored by the StruxureWare Central server. Specify the severity and return-to-normal parameters for any defined threshold. Provide a custom description for any defined threshold. Configure Threshold Scheduling to specify when any defined threshold is active. Three menus provide access the Edit Thresholds option: Right-click menu Edit Thresholds in the navigation tree in the Navigation view: each option allows you to simultaneously edit the thresholds for one or more sensors that match that option, for the selected device group or device. Right-click menu Edit Thresholds in the Threshold Alarm Configuration view: allows you to edit only the threshold selected, or when multiple thresholds are selected, each option allows you to simultaneously edit the thresholds for all the sensors that match that option. Right-click menu Edit Alarm Configuration in the Active Alarms view of the Monitoring perspective: allows you to edit only the threshold selected. Note: You can use the Filter Thresholds icon ( ) to modify the Threshold Alarm Configuration view to prevent communication link status, user-created thresholds, thresholds with 'Enabled' set to 'No', and thresholds of any severity from appearing in the view.
"Edit thresholds" display
Use this display to configure the settings for the identified thresholds. In addition to the settings provided, the display also identifies the number of sensors to be modified, the name of the sensor ( Sensor Name), the type of sensor ( Sensor Type) and value currently read by the sensor ( Current Reading), and allows you to define a name for the threshold setting ( Threshold Name). Note: When more than one sensor is selected, the name of the sensor is identified in the display as <Multiple>, and value currently read by the sensor is identified as <Multiple Values>.
Threshold settings :
Element
Threshold value
Description
Define the criteria for the threshold. Note: The available value fields will depend on the type of numerical or state threshold selected. Select to enable the threshold, if it is disabled. Note: Thresholds are enabled by default.
Enabled
155
Severity
Select the severity you want associated with the threshold: Information, Warning, Error, Critical, or Failure. Define a delay, in seconds, that will occur after a threshold is no longer violated before the alarm condition clears. This delay helps prevent multiple alarms for values that may rapidly switch between alarm and non-alarm conditions before a problem finally clears. Select Yes to clear a threshold violation only when a user with Administrator privileges marks the alarm condition as resolved. Provide a description you want included in a threshold's alarm notifications. Identify an Internet address you want included in an alarm notification for the threshold.
Return-to-Normal Delay
Use this display to define the specific periods of time, for each day of the week, during which an associated threshold will be disabled (by default, scheduling is enabled 24 hours a day, seven days a week). Note: This display is used to schedule when a threshold will be enabled and disabled, using the threshold's settings display. Two menus in the Alarm Configuration perspective provide access to the Threshold Schedule display: The threshold settings display in the Create Thresholds option. The threshold settings display in the Edit Threshold option. The table provides cells for 15-minute increments, and columns for every day of the week. You can do all of the following to schedule when an alarm threshold is enabled: Click a column title to enable or disable all of that day's cells. Drag your mouse from one cell to another cell in a column, to enable or disable a set of cells. Drag your mouse from a cell in one column to a cell in another column, to enable or disable an identical set of cells for each of the selected days. Click a single cell.
"Edit Thresholds" display
Use this display to edit existing thresholds for the selected device. The display lists all the settings currently defined for each option. Element
Threshold Types Search
Description
Select the threshold type you want to view in the display. Filter the list based on text you enter in this box; only existing thresholds that contain the text you type are listed. You can broaden or narrow your search using the Boolean operators AND, OR and NOT only.
156
When the results of a search are displayed, the background of the search field is shaded. When you clear the search field, the background shading is removed and all items are displayed.
List Check-mark the previously defined thresholds that you want to edit or delete.
The following information is provided for the listed threshold. Threshold: the sensors that can be configured for the threshold selected. Current Value: the most recent value reported by the sensor. Parameters: the settings defined for the threshold. Alarmed State: whether the threshold is in an alarm state. Hostname: the hostname, or IP address when no hostname is defined. Unit of Measure: the unit of measure. Name: the name of the threshold. Severity: the severity of the threshold. Label : the device label, or IP address when no label is defined. Device Model : the model, when known. IP Address: The IP address of the device. Device Type: the type of device. Notification Policy: the policy or policies with which the threshold is associated.
Edit Click to edit a selected threshold.
Five menus provide access to the "View Device Sensors" display: Right-click menu View Device Sensors in the Device View and Map View of the Monitoring perspective. Right-click menu View Device Sensors in the Active Alarms view in the Monitoring perspective: view the most recent sensor data available for the device on which the selected alarm occurred. Note: Camera clips are not displayed when more than one active alarm is selected. Right-click menu View Device Sensors in the navigation tree in the Navigation view of the Alarm Configuration perspective. Right-click menu View Device Sensors in the Alarm History view, accessed from the Window menu.
When one or more device groups or devices are selected, all the thresholds for that selection will be removed from the selected notification policy. Two menus in the Alarm Configuration perspective provide access to the Remove Thresholds from Notification Policy option: Right-click menu Remove Thresholds from Notification Policy in the Navigation view. Right-click menu Remove Thresholds from Notification Policy in the Threshold Alarm Configuration view.
159
You can use the right-click options and the button icons at the top of the view to do the following: Edit the thresholds for the device group or device selected ( Edit Thresholds option). Remove one or more thresholds from the list ( Delete Thresholds option). Create a new notification policy and add one or more thresholds for the selected device group or device ( Add Thresholds to New Notification Policy option). Add one or more thresholds for the selected device group or device to an existing notification policy ( Add Thresholds to Notification Policy option). Remove one or more thresholds from a notification policy for the selected device group or device ( Remove Thresholds from Notification Policy option). Show the notification policy to which a threshold is assigned ( Show Notification Policy option). Locate a device in the navigation tree from the thresholds list ( Find Device in Navigation Tree option). Access the "Configure Columns" display to select the attribute columns that appear in the list ( Configure Columns icon ( )). Enable filters that hide various threshold types and attributes. ( Filter Thresholds icon ( )).
Modifying thresholds
All thresholds use the same basic procedure and displays to modify threshold settings. Note: The same displays are used to modify the threshold settings regardless of whether you select: Edit Threshold, a right-click option in the Alarm Configuration perspective. Edit Alarm Configuration, a right-click option in the Active Alarms view in the Monitoring perspective.
160
Icon
Description Use this Configure Columns icon to identify the attribute columns that appear in the Threshold Alarm Configuration view. Use this Filter Thresholds icon to enable filters that prevent communication link status and user-created thresholds, thresholds with 'Enabled' set to 'No', and thresholds of any severity, from appearing in the list.
Use this display to identify the columns that appear in the Threshold Alarm Configuration view. Section
Threshold Attribute Columns
Description
Lists all possible threshold attribute columns that can appear in the view.
Threshold: Identifies the threshold. Severity: The severity associated with the threshold. Label: The label of the device
161
Hostname: The hostname, or IP address, if no hostname is defined. Enabled: Whether or not the threshold is enabled. Device Model: The device model, if known. For example, Symmetra PX, for an APC/ MGE UPS. Device Type: The type of device Name: The name of the threshold. IP Address: The IP address of the device. Notification Policy: The name of the notification policy or policies to which the alarm is added. Sensor: Identifies the sensor associated with the alarm. Sensor Type: The type of sensor. Parameters: The settings defined on the sensor.
Use this display to select the types of thresholds to exclude from the Thresholds view.
When the results of a search are displayed, the background of the search field is shaded. When you clear the search field, the background shading is removed and all items are displayed. Note: You can hold the Ctrl key down to select multiple items. You can use the right-click options and the button icons at the top of the view to do the following: Enable or disable, modify the severity and recommended action, and add a custom description on one or more alarms for the device group or device selected ( Edit Device Alarm Configuration option). Locate a device in the Navigation view from the device alarm list ( Find Device in Navigation Tree option). Show all the device alarms for the alarm type selected ( Expand Selection option). Access the "Configure Columns" display to select the attribute columns that appear in the list ( Configure Columns icon ( )). Enable filters that hide various device alarm attributes. ( Filter Device Alarms icon ( )).
163
You access the display from the right-click menu in the Device Alarm Configuration view or the Navigation view in the Alarm Configuration perspective. When you access the display from the Navigation view, all the device alarms associated with the device groups or devices selected are configured simultaneously. When you access the display from the Device Alarm Configuration view, you can specify which device alarms associated with the device groups or devices you selected in the Navigation view to configure. You can expand the selection to view and configure device alarms by alarm type, alarm name, or by one or more devices reporting that alarm. Note: With the exception of the Enabled option, device alarm settings you modify do not apply to active alarms. The modified settings will apply the next time the alarm is triggered. Element
Enabled Severity
Description
Select to enable the device alarm, if it is disabled. Note: Device alarms are enabled by default. Select the severity you want associated with the device alarm: Information, Warning, Error, Critical, or Failure. The alarm description provided by the device. You cannot modify this description. Provide a description you want included in the device alarm notifications. The recommended action provided by the device. You can modify the recommended action to include instructions you want in the device alarm notifications. Reset the recommended action to default, if it has been modified.
Reset to default
Icon
Description Use this Configure Columns icon to identify the attribute columns that appear in the Device Alarm Configuration view.
164
Icon
Description Use this Filter Device Alarms icon to enable filters that prevent device alarms with 'Enabled' set to 'No', and device alarms of any severity, from appearing in the list.
Use this display to select the types of device alarms to exclude from the Device Alarm Configuration view.
Use this display to identify the columns that appear in the Device Alarm Configuration view. Section
Device Alarm Attribute Columns
Description
Lists all possible device alarm attribute columns that can appear in the view.
Device Alarm: Identifies the device alarm. Severity: The severity associated with the device alarm. Label: The label of the device. Hostname: The hostname, or IP address, if no hostname is defined. Enabled: Whether or not the device alarm is enabled. Device Model: The device model, if known. For example, Symmetra PX, for an APC/ MGE UPS. Device Type: The type of device. IP Address: The IP address of the device. Notification Policy: The name of the notification policy or policies to which the alarm is added. Device Definition File: The file the StruxureWare Central server uses to access information about the environmental, power, and cooling alarms at supported SNMP and Modbus devices.
This view in the Alarm Configuration perspective shows the default and user-created notification policies. You can create your own custom notification policies for the StruxureWare Central server, and edit existing policies used to generate alarm notifications. A Default notification policy exists for the StruxureWare Central server. This default notification policy cannot be deleted, but it can be edited and renamed. Note: A notification policy must include at least one threshold or device and one alarm action before it can be used to generate alarm notifications. You can use the button icons and the right-click options at the top of the view to perform the following functions: Create a new notification policy, and add one or more alarm actions, and one or more thresholds and devices, for the selected device group or device ( Create option and icon ). Edit the thresholds, devices, and alarm actions for the selected notification policy ( Edit option and icon ).
). Delete the selected notification policy ( Delete option and icon Add, edit, delete, and test alarm actions for the selected notification policy using the "Manage Alarm Actions" display ( Manage Alarm Actions ).
Icon
Description Use the Create Notification Policy icon to create a new notification policy. Note: A notification policy must include at least one threshold or device and one alarm action before it can be used to generate alarm notifications. Use the Edit Notification Policy icon to choose thresholds or devices to add or remove, and to add, edit, or remove alarm actions in the notification policy selected. Use the Delete Notification Policy icon to delete the notification policy selected. Use the Manage Alarm Actions icon to add, edit, delete, or test alarm actions for the notification policy selected.
This option allows you to create a policy used by the StruxureWare Central server to generate alarm notifications. In the Notification Policies view of the Alarm Configuration perspective, you can create a new notification policy, and choose the thresholds, and SNMP and Modbus devices, to include in the new policy; view the thresholds and devices you have added, and add alarm actions and configure options for those actions. Note: A notification policy must include at least one threshold or device and one alarm action before it can be used to generate alarm notifications. The right-click menu Create in the Notification Policy Name list, and the Create Notification Policy icon ( ) in the Notification Policies view, provide access to the "Create New Notification Policy" display.
Creating a New Notification Policy
In the Alarm Configuration perspective, you can create a new notification policy in the Notification Policies view. You select any existing notification policy, or use the Create Notification Policy icon , to create a new notification policy.
A notification policy must include at least one threshold or device, and one alarm action before it can be used to generate alarm notifications. No thresholds or actions are included by default in a new notification policy. 1. Select the Create Notification Policy icon or right-click option in the Notification Policies view. 2. In the "Create New Notification Policy" display, identify a policy name, choose the thresholds, devices, and actions to add to the notification policy. a. Click Add to configure the alarm actions to add to the notification policy. Click Manage Actions to create alarm actions, or modify or remove existing alarm actions on the StruxureWare Central server. Check-mark one or more actions to configure their notification options, check-mark the actions you want to add to the notification policy, and click OK . b. On the Thresholds tab, click Choose Thresholds to identify the thresholds you want to add to the notification policy. In the "Choose Thresholds" display, you select a device group or device, select the thresholds you want to add to the notification policy, and click the Add Selected Thresholds button. Use the Remove Selected Thresholds to refine the list. Click OK to exit the display. Note: You can modify thresholds in the Threshold Alarm Configuration view in the Alarm Configuration perspective. c. On the Devices tab, click Choose Devices to identify the devices you want to add to the notification policy. In the "Choose Devices" display, you select a device group or device you want to add to the notification policy, and click OK. Note: All device alarms reported by the device or device group selected will be added to the notification policy. You can modify the alarm configuration for alarm types or individual device alarms in the Device Alarm Configuration view in the Alarm Configuration perspective. 3. Modify the alarm actions, thresholds, or devices you have added to the notification policy, if necessary, or click OK to exit the display.
"Create New Notification Policy/Edit Notification Policy" display
Use this display to create a new notification policy or edit an existing notification policy used by the StruxureWare Central server to generate alarm notifications.
167
A Default notification policy exists for the StruxureWare Central server. This default notification policy cannot be deleted, but it can be edited and renamed. Note: A notification policy must include at least one threshold or device and one alarm action before it can be used to generate alarm notifications. Three menus and one button icon in the Alarm Configuration perspective provide access to the Create New Notification Policy display: Right-click menu Create in the Notification Policy Name pane of the Notification Policies view. Button icon Create Notification Policy in the Notification Policies view. Right-click menu Add Thresholds to Notification Policy in the Navigation view. Right-click menu Add Thresholds to Notification Policy in the Threshold Alarm Configuration view. One menu and one button icon in the Notification Policies view provide access to the Edit Notification Policy display: Right-click menu Edit in the Notification Policy Name pane. ). Button icon Edit Notification Policy ( Element
Policy Name Actions
Description
Identify the name of the notification policy. Displays the actions and action options included in the notification policy.
You can click on any column head ( Action, Delay (min), Repeat, or Interval (min) ) to sort the list.
Add Click to add actions to the notification policy. Note: To add alarm actions, use the "Manage Alarm Actions" display, accessed by the Manage Actions button. Click to edit the options for the selected alarm action. Note: To edit alarm actions, use the "Manage Alarm Actions" display, accessed by the Manage Actions button. Click to delete an action from the notification policy. Note: The action is deleted from the notification policy only, and remains on the StruxureWare Central server for future use. To delete alarm actions from the StruxureWare Central server, use the "Manage Alarm Actions" display, accessed by the Manage Actions button in the Add and Edit Alarm Action displays, or the Manage Alarm Actions option in the Alarm Configuration menu. Displays the thresholds included in the notification policy. Click to select thresholds to include in the notification policy.
Edit
Remove
168
Displays the devices included in the notification policy. Click to select devices to include in the notification policy
This display allows you to create or modify alarm actions for the notification policy selected.
Element
List Manage Actions
Description
The alarm actions on the StruxureWare Central server. Accesses the "Manage Alarm Actions" display to create, modify, or delete alarms from the StruxureWare Central server.
Options
Delay (minutes): Define how long the StruxureWare Central server will wait to generate a notification after it becomes aware of an alarm. Repeat (number of times): Specify how often the notification policy will repeat the alarm action. Repeat Until Alarm Clears: Select to repeat the notification until the alarm condition is resolved. Interval (minutes): Define how long the notification policy will wait before it repeats the alarm action. Include graph (if supported): Select to include graphs in the notification, available for threshold alarms only.
This display allows you to select the thresholds that will be part of a new or existing notification policy.
You select a device group or device in the navigation tree to display the thresholds that can be added to the notification policy for the selection. You can add all the thresholds, or choose only those thresholds you want to add to the notification policy. Note: You can hold the Ctrl key down to select multiple items in both the navigation tree and the thresholds list. The number of thresholds in the notification policy is displayed. You must click OK in the "Choose Thresholds" display, and the "Create or Edit Notification Policy" display to apply your changes. You can use the search feature, table columns, and button icons to do the following: 169
Type text in the Search field to filter the navigation tree or the thresholds list. You can broaden or narrow your search using the Boolean operators AND, OR and NOT. Only items that contain the text you specify in the Search field are displayed. When the results of a search are displayed, the background of the search field is shaded. When you clear the Search field, the background shading is removed and all items are displayed. Note: Search fields support the Boolean operators AND, OR, and NOT only. Access the "Configure Navigation Tree Labels" display to select up to three labels to specify how monitored devices appear in the navigation tree ( Configure Navigation ). Tree Labels icon Note: Changes to the navigation tree labels in this display affect the navigation tree in the Navigation view. Access the Configure Columns display to select the attribute columns that appear in the list. ( Configure columns icon ). Note: Changes to the columns in this display affect the columns in the Thresholds view. Enable filters to specify the threshold attributes that appear in the list ( Filter Thresholds icon ). Click a column title to sort the list in ascending or descending order based on that column's information. The Add Selected Thresholds and Remove Selected Thresholds buttons are used to add thresholds to or remove thresholds from the notification policy. When you add thresholds to the notification policy, a 'plus-sign' icon ( ) indicates which thresholds were added. When you remove a threshold from the notification policy, the icon is removed. Note: When you remove thresholds from the notification policy, the thresholds remain in the list for the device group or device, and can be readded, if desired.
"Choose Devices" display
This display allows you to select the devices that will be part of a new or existing notification policy. You checkmark the device groups or devices in the navigation tree to add all the alarms reported by the devices for that selection to the notification policy. You can then modify the configurations for individual device alarms in the Device Alarm Configuration view. Note: All the devices monitored by the StruxureWare Central server are added to the Default notification policy at device discovery. Note: You must click OK in the "Choose Devices" display, and the "Create or Edit Notification Policy" display to apply your changes. You can use the search feature to do the following: Type text in the Search field to filter the navigation tree or the thresholds list. You can broaden or narrow your search using the Boolean operators AND, OR and NOT. Only items that contain the text you specify in the Search field are displayed. When the results of a search are displayed, the background of the search field is shaded. When you clear the Search field, the background shading is removed and all items are displayed. Note: Search fields support the Boolean operators AND, OR, and NOT only.
170
171
Description
Displays the alarm actions currently configured on the StruxureWare Central server.
You can click any column head ( Action or Action Type ) to sort the list.
Create Edit Delete Test Click to create a new alarm action. Click to edit the selected alarm action. Click to delete the selected alarm action from the StruxureWare Central server. Click to test the selected alarm action.
172
You must create at least one alarm action, and add it to a notification policy, before your StruxureWare Central server can generate alarm notifications.
All alarm actions are created using the same basic procedure. 1. Select Manage Alarm Actions in the Alarm Configuration menu. 2. Click Create to access the Alarm Action wizard. 3. In the "Choose Alarm Action Type" display, select the type of alarm action you want to create, and click Next. 4. In the "Configure Alarm Action" display for the selected action, define the settings you want the action to use, and click Finish to exit the wizard. Note: For information about the settings for the action you are creating, see the help section for that action and its settings display.
All alarm actions are modified using the same basic procedure. 1. Select Manage Alarm Actions in the Alarm Configuration menu. 2. Select the alarm action you want to modify, and click Edit to access the configuration display for that action. 3. Define the settings you want the action to use, and click Finish to exit the wizard. Note: For information about the settings for the action you are creating, see the help section for that action and its settings display.
All alarm actions are deleted using the same basic procedure. 1. Select Manage Alarm Actions in the Alarm Configuration menu. 2. Select the alarm action you want to remove, and click Delete . 3. Click Finish to exit the wizard. Note: Deleting an alarm action in the Manage Alarm Actions display removes the action from the StruxureWare Central server.
All alarm actions are tested using the same basic procedure. 1. Select Manage Alarm Actions in the Alarm Configuration menu. 2. Select the action you want to test, click Test, and then click OK.
173
Note: You will need to verify the test was successful. For example, for a Send SNMPv1 Trap, verify the trap was received at the trap receiver; for a Send E-mail, verify the e-mail was received.
Description
Sends a message that uses the standard e-mail format. Sends a message that uses the short-message e-mail format. Sends data to an FTP server. Sends an HTTP POST. Sends an SNMPv1 trap. Sends an SNMPv3 inform.
Every alarm action type allows you to select up to five severities. The alarm action will only trigger when used in a notification policy that is tied to an alarm threshold with a matching severity.
In the following example, User1 will only receive an sms message if a critical severity threshold is violated. An alarm action named "send_user1_sms is created, and defined to send User1 an SMS e-mail for critical events only. The send_user1_sms action is added to a notification policy called sms messaging. The "sms messaging" notification policy includes various thresholds and device alarms. The alarms are of varying severity - some are set for critical, and some are set for warning. If an alarm occurs, User1 will only receive an SMS message for those thresholds and device alarms defined as critical. You must select at least one severity. Severity Description
174
Information
Typically used to set up an alarm action to respond to events considered to be unimportant, but important enough to require alert notifications when they occur. Typically used by SNMP devices to indicate a condition exists that may require attention to make sure it does not deteriorate into a critical state. For example, a UPS that is running on battery power during a power failure will shut down its load equipment if its battery power is depleted before power returns to normal. Typically used to indicate a sensor threshold violation requires immediate attention. For example, a high temperature violation that could lead to equipment damage. Typically used by SNMP devices to indicate an operational failure requires immediate attention. For example, a battery that needs to be replaced can result in the loss of data at the UPS load equipment if a power failure occurs. Typically used to indicate an operational failure requires immediate attention. For example, communication with a camera pod was lost which could lead to an undetected security violation.
Warning
Error
Critical
Failure
Use this display to define the specific periods of time, for each day of the week, during which an associated activity will be disabled (by default, scheduling is enabled 24 hours a day, seven days a week). Note: This display is used to schedule when an alarm action will be enabled and disabled, using the action's settings display. The table provides cells for 15-minute increments, and columns for every day of the week. You can do all of the following to schedule when an alarm action is enabled: Click a column title to enable or disable all of that day's cells. Drag your mouse from one cell to another cell in a column, to enable or disable a set of cells. Drag your mouse from a cell in one column to a cell in another column, to enable or disable an identical set of cells for each of the selected days. Click a single cell.
175
E-mail tab
Element
Add Remove Server E-mail Settings Locale
Description
Click to add an e-mail address to the address list. Click to remove a selected e-mail address from the address list. Select to define the SMTP settings on the StruxureWare Central server. Select to specify the locale to be used when sending email messages or Use Server Locale (the default).
Provides elements that further define what an e-mail can include, as well as an Alarm Action Scheduling button that allows you to select when an alarm action is enabled (all time periods are enabled, by default). Element
Do Not Send Return-to-Normal Messages
Description
Select if you do not want to receive an e-mail when the threshold violation or alarm condition returns to normal. Select to minimize the size of the e-mail headers.
Element
Add Remove Subject Message Server E-mail Settings Locale
Description
Click to add an e-mail address to the address list. Click to remove a selected e-mail address from the address list. Enter a subject for the message; macros can be used. Enter a message; macros can be used. Select to define the SMTP settings on the StruxureWare Central server. Select to specify the locale for email messages or Use Server Locale (the default).
176
Advanced tab
Provides elements that further define what an e-mail can include, as well as an Alarm Action Scheduling button that allows you to select when an alarm action is enabled (all time periods are enabled, by default).
Element
Do Not Send Return-to-Normal Messages
Description
Select if you do not want to receive an e-mail when the threshold violation or alarm condition returns to normal. Select to minimize the size of the e-mail headers. Select to include HTML formatted messages in addition to plain text messages. Identify the maximum number of bytes used for a message.
Minimize Header Usage Send both HTML and Plain Text Message Message Size Limit (bytes)
A name field, severity selections, and the "Alarm Action Scheduling" display that all alarm action types share, are also available.
Primary and Backup tabs
You must define at least the Primary tab elements. Note: The only difference between the two tabs is that the Backup tab includes backup settings. Setting
FTP Server Hostname User ID Password Verify Password Target Directory
Description
Identify the hostname or IP address of the FTP server that will receive the data. Identify the user identification needed to log on to the FTP server. Identify the password needed to log on to the FTP server. Retype the password. Identify the relative directory path to be used to store the data at the FTP server. This should always be a path relative to the default directory associated with the user ID used to log on to the FTP server.
If the directories on the path do not exist they will be created automatically.
Note: This Target Directory field accepts macros.
177
Base Filename
Identify the base filename to be used for storing the data at the FTP server.
Alarm data will be stored in a file with this name, followed by the *.nbalert.xml file extension. Note: This Base Filename field accepts macros.
A name field, severity selections, and the "Alarm Action Scheduling" display that all alarm action types share, are also available.
Primary and Backup tabs
You must define at least the Primary tab elements. Note: The only difference between the two tabs is that the Backup tab includes backup settings. Element
Target URL
Description
Identify the web address, port and parameters of the system to which HTTP POST data will be posted. Identify the user identification needed to post HTTP data to the server at the specified Target URL. Identify the password needed to post HTTP data to the server at the specified Target URL. Retype the password.
Target User ID
Advanced tab
Provides elements that further define what an HTTP POST can include, as well as an Alarm Action Scheduling button that allows you to select when an alarm action is enabled (all time periods are enabled, by default). Setting
SSL Verify Options
Description
Select No verification, Verify certificate, or Verify certificate and hostname for HTTP POSTs.
A name field, severity selections, and the "Alarm Action Scheduling" display that all alarm action types share, are also available. Element
Target Host Address
Description
Identify the hostname or IP address of the Network Management System (NMS) to which traps will be sent. Identify the community string that will be used when sending traps to the target NMS. Select the number of the port the target NMS uses to receive SNMP traps. Select to specify the locale to be used when sending SNMP traps or Use Server Locale (the default).
A name field, severity selections, and the "Alarm Action Scheduling" display that all alarm action types share, are also available. Element
Target Host Address
Description
Identify the Hostname or IP address of the Network Management System (NMS) to which informs will be sent. Identify the user identification to be used when sending SNMPv3 informs to the target NMS. Select SHA-1 or MD5 as the protocol used when sending SNMPv3 informs to the target NMS. Type in the password to be used when sending SNMPv3 informs to the target NMS. Select whether encryption will be used with the SNMPv3, and if used, which protocol: None, DES, or AES-128. Identify the encryption password to be used to send SNMPv3 informs. Identify the number of the port that the target NMS identified in the Primary tab uses to receive SNMPv3 informs. Select to specify the locale to be used when sending SNMP v3 informs or Use Server Locale (the default).
Locale
Three basic types of macros can be used for Send Short Message E-mail and Send Data to FTP Server alarm action settings.
Location macros
One location macro is available for use when defining alarm action settings for SNMP and Modbus devices monitored by the StruxureWare Central server. Macro
${LOCATION}
Definition
The location for a Test Lab StruxureWare Central SNMP or Modbus device.
Example
Identification macros
Identification macros are available for use when defining alarm action settings for SNMP and Modbus devices monitored by the StruxureWare Central server.
Macro
${SERIAL} ${IP} ${HOSTNAME} ${MODEL} ${SERVERIP}
Definition
The dotted-decimal IP address of the device. The hostname of the device. The model of the device. The dotted-decimal IP address of the StruxureWare Central server.
Example
192.168.2.23 device.apc.com Symmetra 80K 192.168.2.10
${SERVERHOSTNAME} ${SERVERMODEL} ${TIMESTAMP} ${DATE} ${YEAR} ${MONTH} ${DAY} ${TIME} ${HOUR} ${MIN} ${SEC}
isxc.apc.com The hostname of the StruxureWare Central server. The model of the StruxureWare Central StruxureWare Central server. The current UTC time (seconds 998885130 since 1/1/1970). The current date (year-monthday). The current year. The current month (2-digit number, January=01). 2010-03-27 2010 03
The current day of the month (2- 27 digit number). The current time (24-hour, hour- 23-30-01 minute-second). The current hour of the day (2digit, 24-hour time). 23
The current minute of the hour. 30 The current second of the minute. 01
180
Alarm macros
Alarm macros are available for use when defining alarm action settings on the StruxureWare Central server.
Macro
${ALERTTYPE} ${ALERTTYPENAME}
Definition
The type of alarm. The ${ALERTTYPE} value, displayed in the language appropriate for the StruxureWare Central server locale. The type of sensor generating the alarm. The value reported by the sensor that is generating the alarm. HIGHERR
Example
Value Too High
${SENSORTYPE} ${SENSORVAL}
TEMP 60
${ALERTTIME}
The date and time at which the Apr 2, 2009 13:01:45 alarm notification was generated. The severity value reported by ERR, WARN-RTN the sensor that is generating the alarm (such as ERR, WARN, INFO). If the alarm state has returned to normal, the severity value will be followed by "-RTN" (for example WARN-RTN). The ${ALERTSEV} value, displayed in the language appropriate for the StruxureWare Central server locale. The name of the sensor associated with the alarm. ERROR, WARN (returned to normal)
${ALERTSEV}
${ALERTSEVNAME}
${SENSORNAME} ${NOTIFPOLICY}
Bldg. 3 Door
The name of the notification Default, Policy #1 policy that was used to generate the alarm. The alarm title. Replacement Battery Needed
${ALERTTITLE} ${ALERTDESC}
The description, and At least one faulty battery recommended action, if any, for exists. the alarm.
Recommended Action: Replace all faulty batteries. You can use the APC Selectors (http:// www.apc.com/go/direct/ index.cfm?tag=selectors) page to order new batteries.
${ISACTIVE?yes?no}
Specifies custom active vs. active and cleared return to normal text. The strings yes and no can be replaced with user-specified strings. For example, if you specify active and cleared for
181
the yes and no values and the macro is translated, if the alert is still active the word "active" would appear and when it has returned to normal, the word "cleared" would appear. ${USERURL} The user-specified URL that can be defined within the threshold configuration. The user-specified description value which can be defined within the threshold configuration. http://www.mysite.com
${USERDESC}
Too high
The time at which the alarm 13:01:45 condition was initially detected. The time at which the alarm condition returned to normal. The locally unique ID of the sensor generating the alarm. The globally unique ID of the sensor generating the alarm. 13:07:13 TEMP1 B000113_TEMP1
The unique 16 character 3E4512C0FE03440F identifier shared by all messages generated as a result of a single alarm notification event. For example, if an appliance generates an alarm notification when the internal temperature sensor threshold is exceeded, and then generates a "return to normal" message when the temperature drops below the high threshold, both of these messages will have the same Event ID number. However, if the temperature rises again and a second threshold exceeded alarm is generated, the second alarm will have a new Event ID. The label of value of the device My Device that either contains the sensor that reported the alarm or to which the sensor is connected. The label of value of the pod that My Pod either contains the sensor that reported the alarm or to which the sensor is connected. The serial number of the pod NB007100730114 that either contains the sensor that reported the alarm or to which the sensor is connected. The label value for the external Ext1 sensor port to which the external sensor that reported the alarm is connected.
${DEVICELABEL}
${ALERTPOD}
${ALERTPODSERIAL}
${ALERTPORT}
182
${CURRENT_ALERT_NUM}
The number of times the alarm 0, 1, 2 action has been repeated, from 0 up to the Repeats value for the alarm action. The user ID that is responsible joeuser for manually resolving an alarm (when this option applies). The text entered into the user- Turned on the A/C; Fixed the specified description field leak whenever an alarm needs to be manually returned to normal (an option which can be selected whenever a threshold is configured).
${RESOLVEUSERID}
${RESOLVECOMMENT}
183
You must create at least one alert action before your NetBotz Appliance can generate alert notifications.
All alert actions are created using the same basic procedure. 184
1. Select Alert Actions in the Alert Settings option in the NetBotz Appliance Configuration option in the Device menu. 2. In the "Select Alert Action Type" display, highlight the type of alert you want to create, and click Next. 3. In the "Select Next Action" display, select to create a new action, and click Next. 4. In the "Select Devices" display, select the parent device or devices you want associated with the alert action, and click Next. Creating an alert action on a NetBotz Appliance will make the alert action available to all profiles on the selected NetBotz Appliance. 5. In the "Alert Action" display for the selected action, define the settings you want the action to use, and click Next. Note: For information about the settings for the action you are creating, see the help section for that action's settings display. 6. In the "Test Action" display, click Finish without testing the action, or select the action you want to test, click Test Action, and then click Finish. Note: You will need to verify the test was successful. For example, for a Send SNMPv1 Trap, verify the trap was received at the trap receiver; for a Send E-mail, verify the e-mail was received. 7. In the "Choose Next Action" display, select whether you want to configure additional actions, add actions to alert profiles, or exit the "Alert Actions" wizard, and click OK, or click Cancel, to exit the wizard.
Modifying an alert action
You can use the same basic procedure to modify any type of alert action. 1. Select "Alert Actions" in the Alert Settings option in the NetBotz Appliance Configuration option in the Device menu. 2. In the "Select Alert Action Type" display, highlight the type of alert you want to modify, and click Next. 3. In the "Select Next Action" display, select to modify an action, and click Next. 4. In the "Select Devices" display, select the parent device or devices associated with the alert action you want to modify, and click Next. 5. In the "Select Alert Actions" display, select only the alert action you want to edit. CAUTION: If you select multiple alert actions, the changes you make will result in those alert actions using the same settings and name. 6. In the "Alert Action" display for the selected action, edit the settings, as needed, and click Next. 7. In the "Test Action" display, click Finish without testing the action, or select the action you want to test, click Test Action, and then click Finish. Note: You will need to verify the test was successful. For example, for a Send SNMPv1 Trap, verify the trap was received at the trap receiver; for a Send E-mail, verify the e-mail was received. 8. In the "Choose Next Action" display, select whether you want to configure additional actions, add actions to alert profiles, or exit the "Alert Actions" wizard, and click OK.
Deleting an alert action
You can use the same basic procedure to delete any type of alert action. 1. Select "Alert Actions" in the Alert Settings option in the NetBotz Appliance Configuration option in the Device menu. 2. In the "Select Alert Action Type" display, highlight the type of alert you want to delete, and click Next. 3. In the "Select Next Action" display, select to modify an action, and click Next.
185
4. In the "Select Devices" display, select the parent device or devices associated with the action you want to delete, and click Next. 5. In the "Select Alert Actions" display, select the action or actions you want to delete, and click Delete. 6. Click Cancel, to exit the "Alert Actions" wizard.
Use this display to select the type of action you want to create, modify, or delete. Alert Action
Send E-mail Activate Button Output Send SNMPv3 Inform Send SNMPv1 Trap Send Short Message E-mail Send HTTP POST Send Data to FTP Server Send Wireless SMS Message Set Switch Output State
Description
Sends a message that uses the standard e-mail format. Activates a button output on a device managed by a NetBotz Appliance. Sends an SNMPv3 inform. Sends an SNMPv1 trap. Sends a message that uses the short-message e-mail format. Sends an HTTP POST. Sends data to an FTP server. Sends a wireless SMS message from a wireless modem connected to a NetBotz Appliance. Sets the state of an output switch on a device managed by a NetBotz Appliance.
Use this display to select whether you want to edit an existing action, or create a new one.
"Select Devices" display
Use this display to select an alert action's parent devices. Note: Each NetBotz Appliance is the parent device for its camera pods, sensor pods, and other devices it monitors. Parent Device
NetBotz Appliance
Description
Select one or more NetBotz Appliance options to create, edit, or delete an alert action that can be used with their monitored camera pods, sensor pods, and other devices.
186
Use this display to select the alert action or actions you want to modify or delete, then click Next, to modify your selections, or Delete, to delete them. Note: If you select to modify multiple actions, those actions will all use the same settings and name.
"Alert Action" displays
In the following example, User1 will only receive an sms message if a critical severity threshold is violated. An alert action named "send_user1_sms is created, and defined to send User1 an SMS e-mail for critical events only. The send_user1_sms alert action is added to an alert profile called sms messaging. The "sms messaging" alert profile is selected on various alert thresholds. The alert thresholds are of varying severity - some are set for critical, and some are set for warning. If an alarm occurs, User1 will only receive an SMS message for those alert thresholds defined as critical. You must select at least one severity. Severity
Information
Description
Typically used to set up an alert action to respond to events considered to be unimportant, but important enough to require alert notifications when they occur. Typically used to indicate a condition exists that may require attention to make sure it does not deteriorate into a critical state. Typically used by NetBotz Appliances to indicate a sensor threshold violation requires immediate attention. For example, a high temperature violation that could lead to equipment damage. Typically used to indicate an operational failure requires immediate attention. Typically used by NetBotz Appliances to indicate an operational failure requires immediate attention. For example, communication with a camera pod was lost which could lead to an undetected security violation.
Warning
Error
Critical Failure
187
E-mail tab:
Element
Add Remove Include Threshold-specific Addresses
Description
Click to add an e-mail address to the address list. Click to remove a selected e-mail address from the address list. Select to send e-mails to e-mail addresses defined at the NetBotz Appliance alert thresholds.
188
The generic_send_email alert action is added to an alert profile called alert_profile1. The alert_profile1 profile is specified for two thresholds, temp_too_high and humidity_too_high. The temp_too_high threshold has Threshold-Specific Addresses for User1 and User2, and the humidity_too_high threshold has Threshold-Specific Addresses for User3 and User4. When temp_too_high triggers, only User1 and User2 will receive e-mails. When humidity_too_high triggers, only User3 and User4 will receive e-mails.
Advanced tab:
Provides elements that further define what an e-mail can include, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default). Element
Maximum Camera Pictures Include a Graph with the Alert Include Related Maps with the Alert Include a Sound Clip with the Alert
Description
Select the maximum number of pictures that can be included in e-mails. Select to include graphs in e-mails. Select to include related maps in e-mails. Select to include related sound clips in e-mails, for NetBotz Appliances only. Note: Disabled for NetBotz Appliances that have no audio support. Select if you do not want to receive an e-mail when the threshold violation returns to normal. Select to minimize the size of the e-mail headers. Select the format used for pictures sent with emails. Note: The export options will depend on how the NetBotz Appliance is configured.
Do Not Send Return-to-Normal Messages Minimize Header Usage Picture Export Format
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available. Element
Button Output Device
Description
Select the button-output device that will be activated at the NetBotz Appliance. Note: When no devices that support a button output are monitored by the NetBotz Appliance, N/A is the only choice. Select to activate the button output when the threshold state returns to normal.
Activate on Return-to-Normal
189
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available. Element
Target Host Address
Description
Identify the hostname or IP address of the Network Management System (NMS) to which traps will be sent. Identify the community string that will be used when sending traps to the target NMS. Select the number of the port the target NMS uses to receive SNMP traps.
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available.
Primary tab:
Element
Target Host Address
Description
Identify the Hostname or IP address of the Network Management System (NMS) to which informs will be sent. Identify the user identification to be used when sending SNMPv3 informs to the target NMS. Type in the password to be used when sending SNMPv3 informs to the target NMS. Retype the password. Select SHA-1 or MD5 as the protocol used when sending SNMPv3 informs to the target NMS.
Advanced tab:
Provides elements that further define how SNMPv3 informs are sent, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default). Element
Inform Port Number
Description
Identify the number of the port that the target NMS identified in the Primary tab uses to receive SNMPv3 informs.
190
Encryption Protocol
Select whether encryption will be used with the SNMPv3, and if used, which protocol: None, DES, or AES-128. Identify the encryption password to be used to send SNMPv3 informs. Type in the password, again.
E-mail tab:
Element
Add Remove Include Threshold-specific Addresses Subject Message
Description
Click to add an e-mail address to the address list. Click to remove a selected e-mail address from the address list. Select to send e-mails to e-mail addresses defined for NetBotz Appliance alert thresholds. Enter a subject for the message; macros can be used. Enter a message; macros can be used.
Advanced tab:
Provides elements that further define what an e-mail can include, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default). 191
Element
Do Not Send Return-to-Normal Messages Minimize Header Usage Send both HTML and Plain Text Message Message Size Limit (bytes)
Description
Select if you do not want to receive an e-mail when the threshold violation returns to normal. Select to minimize the size of the e-mail headers. Select to include HTML formatted messages in addition to plain text messages. Identify the maximum number of bytes used for a message.
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available.
Description
Identify the web address, port and parameters of the system to which HTTP POST data will be posted. Identify the user identification needed to post HTTP data to the server at the specified Target URL. Identify the password needed to post HTTP data to the server at the specified Target URL. Retype the password.
Target User ID
Advanced tab:
Provides elements that further define what an HTTP POST can include, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default). Setting
Maximum Camera Pictures Include a Graph with the Alert Include Related Maps with the Alert Include a Sound Clip with the Alert
Description
Identify the maximum number of pictures that can be included in an HTTP POST. Select to include a graph with the HTTP POST. Select to include a related maps with the HTTP POST. Select to include related sound clips in the HTTP POST.
192
Note: Disabled for NetBotz Appliances that have no audio support. SSL Verify Options Select No verification, Verify certificate, or Verify certificate and hostname for HTTP POSTs.
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available.
Description
Identify the hostname or IP address of the FTP server that will receive the data. Identify the user identification needed to log on to the FTP server. Identify the password needed to log on to the FTP server. Retype the password. Identify the relative directory path to be used to store the data at the FTP server. This should always be a path relative to the default directory associated with the user ID used to log on to the FTP server.
If the directories on the path do not exist they will be created automatically.
Note: This Target Directory field accepts macros. Base Filename Identify the base filename to be used for storing the data at the FTP server. Pictures from alerts will be stored in files with this name, followed by the *.n.jpg file extension, where n is the picture number (1, 2, 3, etc.).
Alert data will be stored in a file with this name, followed by the *.nbalert file extension. Pictures include in the data will be stored in files with this name, followed by the *.n.jpg file extension, where n is the picture number (1, 2, 3, etc.). 193
Advanced tab:
Provides elements that further define what an e-mail can include, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default). Setting
Maximum Camera Pictures Include a Graph with the Alert Include Related Maps with the Alert Include a Sound Clip with the Alert
Description
Identify the maximum number of pictures that can be included in the data sent to an FTP server. Select to include graphs with data sent to an FTP server. Select to include related maps with data sent to an FTP server. Select to include related sound clips in the data sent to an FTP server. Note: Disabled for NetBotz Appliances that have no audio support. Select the format used for pictures sent with the data sent to an FTP server. Note: The export options will depend on how the NetBotz Appliance is configured.
Basic tab:
Element
Add
Description
Click to add a destination address of the recipients to whom the wireless SMS message alert notification will be sent, in the following format.
sms:sms_device_address where sms:sms_device_address is the telephone number or e-mail address associated with the SMS-enabled device. For example: sms:5123334444 or sms:[email protected]
194
Remove
Include Threshold-specific SMS Destinations Select to send wireless SMS messages to the destination addresses added to the E-mail tab for NetBotz Appliance alert thresholds. Note: If the destination addresses list is empty, and Include threshold-specific SMS destinations is not selected, no wireless SMS messages can be sent; if the destination addresses list is empty, and Include thresholdspecific SMS destinations is selected, wireless SMS messages can be sent only for thresholds that have an SMS destination address identified in their Threshold-specific address list. Message Enter a message for the alert; macros can be used.
Advanced tab:
Provides elements that further define what a wireless SMS message can include, as well as an Alert Action Scheduling button that allows you to select when an alert action is enabled (all time periods are enabled, by default).
Element
Do Not Send Return-to-Normal Messages Message Character Size Limit (1 - 160) Message Validity Period
Description
Select if you do not want to send SMS messages when the threshold state returns to normal. Identify the number of characters that can be used in the messages. Select how long a period of time the messages will be valid, from 5 Minutes through 3 Days.
195
A name field, severity selections, and the "Alert Action Scheduling" display that all alert action types share, are also available. Note: All time periods are enabled for an alert action, by default, in its "Alert Action Scheduling" display. Element
Switch Output Device
Description
Select the switch relay device that will be triggered by the alert action from the list of all switch relay devices defined for use with the selected NetBotz Appliance. Note: When no devices that support a switch output are monitored by the NetBotz Appliance, N/A is the only choice. Select the state ( On or Off) to which the selected switch relay device will be set when an alert occurs. Select the state ( Unchanged, On, or Off) to which the selected switch relay device will be set when the violated threshold returns to a normal state.
Identification macros:
Identification macros are available for use when defining alert action settings for NetBotz Appliances.
Macro
${SERIAL} ${IP} ${HOSTNAME} ${MODEL} ${TIMESTAMP} ${DATE} ${YEAR} ${MONTH}
Definition
The dotted-decimal IP address of the device. The hostname of the device. The model of the device.
Example
192.168.2.23 isxc.apc.com WallBotz 500
The current UTC time (seconds 998885130 since 1/1/1970). The current date (year-monthday). The current year. The current month (2-digit number, January=01). 2009-03-27 2009 03
196
The current day of the month (2- 27 digit number). The current time (24-hour, hour- 23-30-01 minute-second). The current hour of the day (2digit, 24-hour time). 23
The current minute of the hour. 30 The current second of the minute. 01
Location macros:
Location macros are available for use when defining alert action settings for NetBotz Appliances. Macro
${LOCATION} ${ENCLOSURE} ${SLOT} ${ENCRELLOC} ${ROOM} ${ROOMROW} ${ROOMCOL} ${HEIGHT} ${BLDG} ${FLOOR} ${COMPANY} ${ADDRESS1} ${ADDRESS2} ${CITY} ${STATE} ${COUNTRY} ${CONTACT} ${SITE} ${NOTES} ${LATITUDE} ${LONGITUDE} ${GPSLOC}
Definition
The Location setting at a NetBotz device. Enclosure ID Slot in Enclosure Position in Enclosure Room Number Row in Room Column in Room Height above Floor Building Floor Number Company Name Address 1 Address 2 City State/Province Country Primary Contact Site Name Notes Latitude (for units to which a GPS pod is connected) Longitude (for units to which a GPS pod is connected) The current longitude and latitude data when the alert occurred (for units to which a GPS pod is connected) Test Lab
Example
RACK1234 A23 ATUPS C-100 AA 25 60 205 3 APC 132 Fairgrounds Road Building 1 W. Kingston RI USA J. Smith West Campus IT Closet, Server Room 30 18 N 97 42 W 30 18 N / 97 42 W
197
Alert macros:
Alert macros are available for use when defining alert action settings on the NetBotz Appliances.
Macro
${ALERTTYPE} ${SENSORTYPE} ${SENSORVAL}
Definition
The type of alert. The type of sensor generating the alert. The value reported by the sensor that is generating the alert. HIGHERR TEMP 60
Example
${ALERTTIME} ${ALERTSEV}
The date and time at which the Apr 2, 2009 13:01:45 alert notification was generated. The severity value reported by ERR, WARN-RTN the sensor that is generating the alert (such as ERR, WARN, INFO). If the alert state has returned to normal, the severity value will be followed by "-RTN" (for example WARN-RTN). The name of the sensor associated with the alert. Bldg. 3 Door
The name of the alert profile that Default, Profile #1 was used to generate the alert. The name of the specific alert First Alert Level, Second Alert sequence that caused the alert Level to be generated. Corresponds with the Label value of the alert sequence. Specifies custom active vs. active and cleared return to normal text. The strings yes and no can be replaced with user-specified strings. For example, if you specify active and cleared for the yes and no values and the macro is translated, if the alert is still active the word "active" would appear and when it has returned to normal, the word "cleared" would appear. The user-specified URL that can be defined within the threshold configuration. The user-specified description value which can be defined within the threshold configuration. http://www.mysite.com
${ISACTIVE?yes?no}
${USERURL}
${USERDESC}
Too high
${START_TIME}
The time at which the alert 13:01:45 condition was initially detected.
198
The time at which the alert condition returned to normal. The locally unique ID of the sensor generating the alert. The globally unique ID of the sensor generating the alert.
The unique 16 character 3E4512C0FE03440F identifier shared by all messages generated as a result of a single alert notification event. For example, if an appliance generates an alert notification when the internal temperature sensor threshold is exceeded, and then generates a "return to normal" message when the temperature drops below the high threshold, both of these messages will have the same Event ID number. However, if the temperature rises again and a second threshold exceeded alert is generated, the second alert will have a new Event ID. The label of value of the pod that My Pod either contains the sensor that reported the alert or to which the sensor is connected. The serial number of the pod NB007100730114 that either contains the sensor that reported the alert or to which the sensor is connected. The label value for the external Ext1 sensor port to which the external sensor that reported the alert is connected. The number of times the alert 0, 1, 2 sequence has been repeated, from 0 up to the Repeats value for the alert sequence. The user ID that is responsible for manually resolving an alert (when this option applies). joeuser
${ALERTPOD}
${ALERTPODSERIAL}
${ALERTPORT}
${CURRENT_ALERT_NUM}
${RESOLVEUSERID}
${RESOLVECOMMENT}
The text entered into the user- Turned on the A/C; Fixed the specified description field leak whenever an alert needs to be manually returned to normal (an option which can be selected whenever a threshold is configured).
199
Note: You need to verify the test was successful: the display does not report test failures. For example, for Send SNMPv1 Trap, verity the trap was received at the trap receiver, or for Send E-mail, verify the e-mail was received.
"Choose Next Action" display
Use this display to choose whether you want to use the "Alert Actions" wizard to create, modify, or delete another alert action, access the "Alert Profiles" wizard to manage alert profiles, or exit the wizard.
Note: An alert profile must include at least one alert action before it can be used to generate alert notifications.
200
An alert profile can include multiple alert sequences which allow you to customize which alert actions are triggered, and when. For example, if sending e-mails to user 1 has not resulted in an alarm returning to its normal condition within 20 minutes, you can start sending e-mails to user 2, and start sending data to an FTP server. How many alert profile sequences you use, and what actions they use, will depend on exactly what you want to happen, and when, for alarm conditions, including alert threshold violations, associated with the alert profile.
Use this display to select the parent device that can use the alert profile. Note: Each NetBotz Appliance is the parent device for the sensor, camera, and other serial devices, as well as for the SNMP devices it monitors. Parent
NetBotz Appliance
Description
Associates the alert profile with the selected NetBotz Appliance for use with its alert thresholds.
201
Use this display to select the profile you want to manage. Element
List Add profile Remove profile
Description
Lists the existing alert profiles on the selected parent device. Click to add a new profile. Click to delete a profile. The default profile, indicated by an asterisk, can never be deleted. Note: If you delete a profile that is associated with an alert threshold, the alert threshold will then use the default profile.
Each alert sequence allows you to add a new set of alert actions. Alert sequences allow you to stagger notifications based on the duration of an alarm condition. Note: The alert profile must be associated with an alert threshold in order for it to operate. Element
Profile name List
Description
Identify a name for the profile. Identifies the alert sequences associated with the profile, by Sequence Name, and their Delay (minutes), Repeats, and Interval (minutes) values. Click to add a new alert sequence. Click to edit a selected alert sequence. Click to remove a selected alert sequence. Select to suppress notifications for a defined period of time for the alert thresholds that use the profile.
Use this display to add or edit the alert sequences you want a profile to use. Note: Alert notifications will cease as soon as the triggering event clears; a cleared notification is sent for each alert action, unless the alert action has Do Not Send Returnto-Normal Messages selected in the Advanced tab of the alert action's configuration display. Element
Label Delay (minutes)
Description
Identify a name for the sequence. Define how long the NetBotz Appliance will wait after it becomes aware of a threshold violation, or other alarm, associated with the alert profile, before it generates an alert notification.
202
Interval (minutes) Repeat (number of times) Repeat until Alert Cleared Capture Settings
Define how long the sequence will wait before it repeats the alert notification. Identify how many times the sequence will repeat itself. Select to have the sequence repeat itself continuously. Select the capture settings for Graphs, Pictures, and Maps that may be included with the sequence's alert notifications: Capture if Requested, Always Capture, or Never Capture. Add Action: click to add an available alert action to the actions list for the alert sequence. Note: Only alert actions available for the parent device selected for the alert profile will be shown.
Actions
Remove Action: click to permanently remove a selected alert action from the alert sequence. View Action: click to review or modify a selected alert action's configuration. Test Action: click to test a selected alert action.
203
Create alert thresholds at one time for multiple sensors that monitor the same value (for example, all are Humidity sensors, or all are Door sensors) at the NetBotz Appliances monitored by the StruxureWare Central server. Assign a NetBotz Appliance alert profile to the specific sensor at the NetBotz Appliance the profile was created on, and to all the sensors on the devices it monitors. Specify the severity for any defined threshold. The Alert Settings menu in the NetBotz Appliance Configuration option of the Device menu provides access to the alert thresholds. Each Alert Threshold option allows you to search some or all of the NetBotz Appliances monitored by the StruxureWare Central server for sensors that match the selected option. You can then edit or add thresholds for one of those sensors, or configure the same threshold for any number of those sensors, simultaneously.
When you create alert thresholds for a NetBotz Appliance, its sensor pods, camera pods, and monitored SNMP devices, the threshold settings are set at the NetBotz Appliance. It is the NetBotz appliance that stores the settings and sends the alerts to the StruxureWare Central server. Note: Because NetBotz Appliance alert profiles are device-specific, you will not be able to configure the profile for a threshold setting when configuring that setting for multiple appliances.
All alert threshold options, except Power (VA) and Power (Watts), can be used to set threshold settings at a NetBotz Appliance for itself, its sensor and camera pods, and other devices it manages. The Other Numerical Sensors and Other State Settings options, and for some third-party devices, Voltage, can be used to set threshold settings at a NetBotz device for the full SNMP support devices it monitors. Threshold
Air Flow <n> ft/min
Value
Description
Settings for sensors that measure air movement as feet per minute. Note: Sensors that use a different measurement, such as cubic feet per minute (CFM) will
204
be displayed under the Other Numeric Sensors option. Audio Current (Amps) Relative number (0 - 100) Amps (0.0 - 100.0) Settings for sensors that measure the volume of sound. Settings for sensors that measure current as total amperage (amps).
Dew Point
F (-40.0 - 122.0)/ C (4.5 - 50.0) Settings for sensors that measure dew point as degrees Fahrenheit (F) or Celsius (C). % (0 - 95) Settings for sensors that measure relative humidity as a percentage (%). Settings for sensors that measure numeric settings not reported for other Alert Thresholds options. Settings for sensors that measure power as total Voltamperes (VA). Note: Sensors that measure power as a percentage of VA will be displayed under the Other Numeric Sensors option. Settings for sensors that measure power as total watts (W).
Humidity
Varied
Power (VA)
VA
Power (Watts)
Temperature
F (-40.0 - 122.0)/ C (4.5 - 50.0) Settings for sensors that measure temperature as degrees Fahrenheit (F) or Celsius (C). V Settings for sensors that measure either AC or DC voltage as total volts (V).
Voltage
Setting
Minimum Value Threshold Maximum Value Threshold Range Threshold
Description
An alarm occurs when the sensor's value is below the Minimum setting. An alarm occurs when the sensor's value is above the Maximum setting. An alarm occurs when the sensor's value is outside the range defined by the Minimum and Maximum settings. An alarm occurs if the sensor's value is below the Minimum setting for longer than the Time Allowed Below Minimum setting's delay. An alarm occurs if the sensor's value is above the Maximum setting for longer than the Time Allowed Above Maximum setting's delay.
205
An alarm occurs if the sensor value increases by more than the Maximum Increase setting since the last time the sensor's value was sampled. For example, at a sensor that measures amps, 1 would result in an alarm when the amps measured by the sensor increases by one amp. An alarm occurs if the sensor value decreases by more than the Maximum Decrease setting since the last time the sensor's value was sampled. For example, at a sensor that measures total watts (W), 100 would result in an alarm when the watts measured by that sensor goes down 100 watts.
UPS Battery Sensors: Battery Age Battery Runtime Remaining Battery Capacity Remaining Time Running on Battery
Other UPS Sensors: UPS Age Input Frequency Output Frequency Output Load Output Power Percent VA
Other Sensors: Max Number of Output Relays Max Number of Input Contacts Runhours of Fan Air Flowrate of Fan (in cfm) Total Air Flow (in cfm) RPM Speed of Fan
Threshold
Value
Description
206
Door
Open or Closed
Settings for sensors that determine whether a door is open or closed. Settings for sensors that determine whether a door handle is up or down. Settings for sensors that determine whether a door lock is locked or unlocked.
Door (Handle)
Up or Down
Door (Lock)
Locked or Unlocked
Dry Contact
Unknown, No Fault, or Fault Settings for sensors that determine the fault status of dry contacts. No Motion or Motion Detected Settings for sensors that detect motion. Varied Settings for sensors that measure state settings not reported for other Alert Thresholds options.
Setting
Alert State Threshold State Mismatch Threshold
Description
An alarm occurs when the sensor's state matches the Alert State setting. An alarm occurs when the sensor's state does not match the Normal State setting. Note: This threshold setting is useful for sensors that can report more than two states. An alarm occurs when the sensor's state matches the Alert State setting for longer than the Time Allowed in Alert State setting's delay. An alarm occurs when the sensor's state does not match the Normal State setting for longer than the time defined by the Time Allowed in Abnormal State setting. Note: This threshold setting is useful for sensors that can report more than two states.
Setting
Door Forced Entry Threshold
Description
An alert occurs when the door is open while the handle is down and the lock is locked, enabled by default. Note: When the Allow handle down while door open option is selected, returning the handle to the down position while the door is open will not generate an alert. An alert occurs when the handle is up while the lock is locked, enabled by default. An alert occurs when unscheduled rack access is attempted using a card, key, or remote command, enabled by default.
207
Note: If any of the other Unscheduled access thresholds are used (Card, Key, or Remote), this threshold should be removed from the lock sensor. Unscheduled Remote Access Threshold An alert occurs when unscheduled rack access is attempted using a remote command issued from the NetBotz Appliance Advanced View or Basic View, or the StruxureWare Central console. Note: To allow remote access without generating an alert, you must modify the threshold schedule, disable the threshold for the desired time frame, and disable the default Unscheduled Access Threshold. An unlock event will still be generated in the NetBotz Appliance event log. An alert occurs when unscheduled rack access is attempted using a card, or a door is opened with a card, and left open past that cards access schedule. An alert occurs when unscheduled rack access is attempted using a key. Note: To allow key access without generating an alert (for example, during normal work hours), you must modify the threshold schedule, disable the threshold for the desired time frame, and disable the default Unscheduled Access Threshold. A key unlock event will still be generated in the NetBotz Appliance event log.
Active/Inactive: Button Temperature Override Status Open/Closed: Input Contact Output Relay
208
Bypass On/Off: Switch Outlet Alarm Device Test Relay Other Settings: Ethernet Link UPS Input Voltage (line neutral) Current Output Phase
External Microphone Yes/No: UPS on Bypass UPS on Battery Audio Alarm Battery Low Overload Inverter Off UPS Over Temperature Utility Power Failure Battery Needs Replacement Battery Fault
Communication Status Alarm State Self-Test Runtime Calibration Reason for Last Transfer to Battery Battery Charge Fault Rack ARU Operating Status of Fan ARU Primary Power Present
209
Use this display, which appears when you select the Alert Thresholds option in the Alert Settings option in the NetBotz Appliance Configuration option in the Device menu, to select the devices on which you want to create, edit, or remove an alert threshold. The display lists all the devices monitored by the discovered NetBotz Appliances. You can click the column headers to sort the list in ascending or descending order. Column
Parent Device
Description
The IP address or hostname for a NetBotz Appliance monitored by the StruxureWare Central server. Identifies a device by its hostname or IP address, when no hostname is defined. Identifies a device by its type. Identifies a device by its model number, when known. Identifies the location of a device, when known.
Use this display to edit or delete existing alert thresholds, or to add a new alert threshold. The display lists all the settings currently defined for the Thresholds selection. Element
Thresholds Filter
Description
Select the alert threshold you want to view in the display. Filter the list based on text you enter in this box: only existing thresholds that contain the text you type are listed. Select the previously defined threshold settings that you want to edit or delete.
List
The following information is provided for the listed threshold setting. Threshold Name: the name of the threshold setting. Parent Device: the IP address of hostname of the NetBotz Appliance that monitors a camera pod, sensor pod, or other device. Monitored Device: the device for which the alert thresholds are displayed. Sensor: the sensor with the defined setting.
Add Edit Remove Selected Click to add an alert threshold for the selected sensor. Click to edit a selected alert threshold. Click to delete a selected alert threshold from the list.
210
Use this display to select the sensor or sensors on which you want to configure the alert threshold. Element
Filter
Description
Filter the list based on text you enter in this box: only sensors that contain the text you type are listed. Select the sensors at which you want to define the alert threshold.
List
The following information is provided for the listed sensors. Parent Device: indicates the device is monitored by a NetBotz Appliance. Monitored Device: the device that reports the sensor values. Current Reading: the current sensor value. Sensor: the name of the sensor.
This display appears when there are no sensors that use the selected alert threshold setting. Click Cancel, to return to the "Select Thresholds" display.
"Configure Settings" display
Use this display to configure the Basic tab settings for the identified threshold. The Advanced, and E-mail tab settings are optional. In addition to the settings provided by the three tabs, the display also identifies the name of the sensor ( Sensor Type) and value currently read by the sensor ( Current Reading), and allows you to define a name for the threshold setting ( Threshold Name).
Element
Threshold value
Description
Define the criteria for the alert threshold. Note: The available value fields will depend on the type of numerical or state threshold selected. Select to enable the alert threshold, if it is disabled. Note: Thresholds are enabled by default. Select the severity you want associated with the alert threshold: Information, Warning, Error, Critical, or Failure. Select the Alert Profile you want to use for notifications generated in response to violations of the alert threshold. Click to view or edit the selected Alert Profile.
Enabled
Severity
Profile
View Profile
211
Note: Any edits you make to an Alert Profile will take affect everywhere that profile is used.
Element
Return-to-Normal Delay
Description
Define a delay, in seconds, that will occur after a threshold setting is no longer violated before the alarm condition clears. This delay helps prevent multiple alarms for values that may rapidly switch between alarm and non-alarm conditions before a problem finally clears. Select to clear a threshold violation only when a user with Administrator privileges marks the alert condition as resolved. Allows you to define the specific periods of time, for each day of the week, during which an associated threshold will be disabled. Select the camera pod or pods you want to have capture images that a NetBotz Appliance can include in alert notifications. Note: This only applies to alert thresholds created on NetBotz Appliance pods and devices. Identify an Internet address you want included in an alert notification for the alert threshold. Provide a description you want included in a threshold's alert notifications.
Threshold Scheduling
Cameras to Trigger
Element
Threshold-specific Addresses
Description
Manage a list of e-mail or wireless SMS destination addresses you want to associate with the alert threshold.
All e-mail addresses use the standard email format: [email protected] The wireless SMS destinations can be used by any NetBotz Appliance that has an SMScapable modem installed in, or connect to, that appliance, to send messages to SMSenabled devices. The addresses used for wireless SMS must use the following format: sms:sms_device_address where sms_device_address is the telephone number or e-mail address
212
associated with the SMS-enabled device. For example: sms:5123334444 or sms:[email protected] Note: The e-mail and SMS destination addresses can be used only by Send Email, Send Short-message E-mail, and Send Wireless SMS Message alert actions that are enabled to use threshold-specific addresses: the alert action has Include Threshold-specific Addresses selected. For example: A generic_send_email alert action is created with no e-mail addresses included. Include Threshold-specific Addresses is selected for this "generic_send_email" action. The generic_send_email alert action is added to an alert profile called alert_profile1. The alert_profile1 profile is specified for two thresholds, temp_too_high and humidity_too_high. The temp_too_high threshold has Threshold-specific Addresses for User1 and User2, and the humidity_too_high threshold has Threshold-specific Addresses for User3 and User4. When temp_too_high triggers, only User1 and User2 will receive e-mails. When humidity_too_high triggers, only User3 and User4 will receive e-mails.
Add Remove Click to add a new e-mail or SMS address to the list. Click to delete a selected address from the list.
The Advanced tab of each threshold's "Configure Settings" display, accessed from the Alert Threshold options in NetBotz Appliance Configuration > Alert Settings provides access to the "Threshold Schedule" display. The table provides cells for 15-minute increments, and columns for every day of the week. You can do all of the following to schedule when an alarm threshold is enabled:
213
Click a column title to enable or disable all of that day's cells. Drag your mouse from one cell to another cell in a column, to enable or disable a set of cells. Drag your mouse from a cell in one column to a cell in another column, to enable or disable an identical set of cells for each of the selected days. Click a single cell.
214
List
Element
Description severity level indicates, see Alarm action severity settings. Click to access the "Add Trap Receiver" wizard. Click to delete a selected trap receiver from the list. Click to access the "Edit Trap Receiver" wizard for a selected trap receiver. Click to send a test trap or inform to a selected trap receiver. Note: The StruxureWare Central server cannot determine if a trap or inform was received. You must verify its receipt at the trap receiver. For information about what can cause a trap test to fail, see Test trap failures.
Use this display to define the SNMPv1 settings for a new trap receiver, or to edit the SNMPv1 settings for an existing trap receiver.
Element
IP Address Port
Description
Identify the IP address of the Network Management System console. Select the port number the Network Management System console uses to receive SNMPv1 traps. Identify the read community string that will be used when sending SNMPv1 traps to the Network Management System console. Select (check-mark) at least one severity for which you want the StruxureWare Central server to send SNMPv1 traps to the Network Management System console when that severity level is reported by a monitored SNMP device, NetBotz Appliance, or devices associated with those appliances. Note: For information about what each severity level indicates, see Alarm action severity settings.
Severities
216
Use this display to define the SNMPv3 settings for a new trap receiver, or to edit the SNMPv3 settings for an existing trap receiver.
Element
IP Address Port
Description
Identify the IP address of the Network Management System console. Select the port number the Network Management System console uses to receive SNMPv3 informs. Identify the user identification to be used when sending SNMPv3 informs to the Network Management System console. Select SHA-1 or MD5 as the authentication protocol used for the SNMPv3 informs, and type in the password for the selected protocol. Note: No password is needed for None, the default selection. Select DES or AES-128 as the encryption protocol used for the SNMPv3 informs, and type in the password for the selected protocol. Note: No password is needed for None, the default selection. Select (check-mark) at least one severity for which you want the StruxureWare Central server to send SNMPv3 informs to the Network Management System console when that severity level is reported by a monitored SNMP device, NetBotz Appliance, or devices associated with those appliances. Note: For information about what each severity level indicates, see Alarm action severity settings.
Username
Authentication Type/Password
Encryption Type/Password
Severities
A Network Management System listed as a trap receiver in the "Network Management System Integration" display can fail to receive a test trap if there are problems with the settings used, or with the network. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ). Problem Settings Recommended Actions Make sure the "SNMPv1 Trap Settings" display or "SNMPv3 Inform Settings" display settings associated with the target Network Management console are properly defined. Make sure the SNMP settings have not changed at the target Network Management
217
Problem
Recommended Actions System console, and that the appropriate SNMP service is enabled at that console. Make sure the device was not turned off or disconnected from the network when the test trap was sent. Correct any network connection problem.
Network
218
Description
Click to register an RMS customer for the StruxureWare Central server, or to edit the settings for an existing RMS customer. Select to enable RMS, or deselect to disable RMS, after the server is registered for this support. Note: RMS is disabled, by default. Click to send an event to the user account associated with the RMS registration, to ensure that the StruxureWare Central server is communicating with RMS. Click to access the RMS web site for more information about this feature, or to log on as a registered RMS customer.
Enable RMS
http://rms.apc.com
Element
List
Description
Identifies the devices the StruxureWare Central server monitors, by Hostname, Label, Serial Number, RMS Identifier, Model, and Location. A Monitored column identifies which devices are monitored by RMS.
219
Click to re-register the devices with RMS. Click to refresh the device list when changes have been made to the devices monitored by RMS.
220
221
Element List
Description Lists the access settings the StruxureWare Central server can use for FTP or SCP access to its monitored devices. Username: The username used for access to a device. Note: By default, the StruxureWare Central server can download firmware only to devices that use apc (lowercase) for the username and password (the actual password used for device access is identified in the "Edit Device File Transfer Settings" display). IP or IP Range: The IP address, or range of addresses, at which the access settings support FTP or SCP communication.
222
Element
Description FTP Port: The port used for FTP access to a device. SCP Port: The port used for SCP access to a device. Timeout: How long the server will wait before it considers that an attempt to access a device has failed. Retry Limit: How many times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default). Protocol: The protocol the transfer settings set will use to access devices ( FTP only, SCP only, or Try SCP, fall back to FTP).
Click to add an access setting to the list. Click to edit a selected access setting. Click to delete a selected access setting.
Use this display to add or edit the settings the StruxureWare Central server uses for File Transfer Protocol (FTP) or Secure Copy (SCP) access to APC SNMPv1 and SNMPv3 devices. Note: Functionally identical versions of this display can be accessed from the "Device File Transfer Settings" displays used by the "Apply Firmware Updates," "SNMPv1/SNMPv3 Device Discovery," and "APC SNMP Device Configuration" wizards, and by Device File Transfer Settings, an SNMP Device Communication Settings option in the Device menu. Element
Username Password Verify Password IP or IP Range
Description
Identify the name used for access to a device. Identify the password used for access to a device. Retype the password. Identify The IP address, or range of addresses, at which the access settings support FTP or SCP communication ( *.*.*.*, by default). Identify whether the transfer settings will use FTP ( FTP only), SCP ( SCP only), or attempt to use SCP, but fall back to using FTP if SCP fails ( Try SCP, fall back to FTP). Select the port the server will use for FTP access to devices ( 21, by default). Select the port the server will use for SCP access to devices ( 22, by default).
Protocol
223
Timeout
Identify how long the server will wait before it considers that an attempt to access a device has failed ( 3000, by default). Select the number of times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default).
Retry Limit
You can edit the Notification Policy, Port, Timeout, and Retries settings, as well as settings not identified in the list, by selecting one or more of the listed devices and clicking Edit Device Scan Settings. The following editable settings are not identified in the list. Scan Interval (minutes) Priority Scanning Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices at which the StruxureWare Central server is defined as a trap receiver. SNMPv1: Read and Write Community names SNMPv3: User, Authentication Protocol, Encryption Algorithm, and Authentication and Encryption Passwords Note: If you select to edit SNMPv1 and SNMPv3 devices at the same time, no Priority Scanning, SNMPv1-specific, or SNMPv3-specific settings will appear in the "Edit Device Scan Settings" display.
Shared Element
Hostname
Description
When only one device is selected, identifies the hostname or IP address of that SNMP device. Note: No Hostname is provided when multiple devices are selected. Select how much time will pass between StruxureWare Central server scans of a selected SNMP device for status information: from 1 through 60 minutes, and Default, the minutes for which is defined by the Global SNMP Settings option's Scan Interval setting. Note: Setting the scan interval below the default value of five minutes can adversely affect performance when the StruxureWare Central server is managing a large number of devices. The number of the port used for SNMP communications with a selected SNMP device. Select how long the StruxureWare Central server will wait for a response before it considers an attempt to communicate with a selected SNMP device has failed: from 1 through 60 seconds. Define how many times the StruxureWare Central server will attempt to communicate with a selected SNMP device, after the initial attempt failed, before it stops trying to access that device during the current scanning process.
Retries
Element
Priority Scanning
Description
Select this option to register the StruxureWare Central server as a trap receiver at a selected APC SNMPv1 device. This allows for faster reporting of errors at that device by the server.
As a trap receiver for an APC SNMPv1 device, the server will poll the device as soon as it receives a trap from that device. As a non-trap receiver, the server reports device alarms during normal scan intervals only. Note: Priority scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices.
Read Community Write Community Edit the community name that the server uses to read information from the SNMPv1 device. Edit the community name that the server uses to define itself as a trap receiver at a selected SNMPv1 device.
225
Element
Priority Scanning
Description
Select this option to register the StruxureWare Central server as a trap receiver at a selected APC SNMPv3 device. This allows for faster reporting of errors at that device by the server.
As a trap receiver for an APC SNMPv3 device, the server will poll the device as soon as it receives an inform from that device. As a non-trap receiver, the server reports device alarms during normal scan intervals only.
Note: Priority Scanning is a trap-based polling process that only occurs in response to traps from APC SNMPv1 devices or informs from APC SNMPv3 devices. User Authentication Protocol Identify the username the server uses for secure communication with a selected SNMPv3 device. Change the protocol ( MD5 or SHA-1), if necessary, selected for the server to use for communication with a selected SNMPv3 device. Type in and verify a new password, if necessary, for the selected Authentication Protocol. Change the encryption method ( None, DES, or AES128), if necessary, selected for the server to use for communication with a selected SNMPv3 device. Type in and verify a new password, if necessary, for the selected Encryption Algorithm.
Encryption Password/Verify
Description Lists the DDFs already installed at the StruxureWare Central server. Click to delete a selected DDF from the list.
226
Element
Description Note: Deleting a DDF will affect what sensors the SNMP devices related to that DDF will report. Click to access the wizard used to add or update DDF files, when available from APC.
Add/Update Definitions
Use this display to select the source of new or updated DDF files.
Element
Check APC Website Local File
Description
Click to see if any new or updated DDF files are available from APC. Click to download a DDF file stored on a local computer.
227
Browse
Use this display to select the DDF files you want to download from APC.
Element
List
Description
Select the DDF files that you want to download from APC from the list of available DDFs.
Each listing shows the currently installed version and whether a new or updated version is available. Installed: The DDF version matches the server's file. Updated: The DDF is an updated version of the server's file.
New: The DDF file is not installed at the server. Next Click to download the selected DDF files.
Use this display to verify that all DDF files were downloaded successfully.
Element
Scan Interval
Description
Select how much time will pass between StruxureWare Central server scans for status information at a monitored SNMP device, when the Device Settings option in the "SNMP Device Communication Settings display" has Default selected for that device's Scan Interval (minutes) setting. Note: Setting the scan interval below the default value of five minutes can adversely affect performance when the StruxureWare Central server is managing a large number of devices.
Use this option to add supplemental OIDs that define sensors for monitored SNMP devices.
Once a supplemental OID has been added, the StruxureWare Central server will request it for every SNMP device, with the supplemental OID value reported only by SNMP devices that can report the sensor associated with that OID. This allows the server to monitor and provide alert notifications for the supplemental OID the same way it does for any other sensor for SNMP devices. You use either the Other Numeric Sensors or Other State Sensors threshold option, depending on the nature of the data provided by the supplemental OID, to configure alert threshold settings for an SNMP device that has the type of sensor associated with the supplemental OID. Note: To add a supplemental OID, you need access to the Management Information Base (MIB) that defines the OIDs available to the SNMP device. Elements
OIDs
Description
Identifies the existing supplemental OIDs.
Sensor Type: The type of sensor (temperature, humidity, air flow, etc.) that best matches the data reported by the OID. Unit of Measure (only available when Generic is the Sensor Type): The appropriate unit or measurement (degrees, seconds, volts, etc.) used when reporting the sensor data. OID: The definition of the OID to be monitored for an SNMP device (for example, .1.3.6.1.4.1.318.1.1.1.2.2.2). Description: A description of the OID (for example, UPS Temperature).
Add Remove Click to add a new supplemental OID. Click to delete a selected supplemental OID.
Description
Select the sensor type. Select the unit of measure, when Generic is the Sensor Type. Identify the OID. For example:
Description
Identify the description for the OID that will appear in the display for the View Device Sensors right-click option in the Device View and Map View. For example, UPS Temperature.
230
Description Lists the DDFs already installed at the StruxureWare Central server. Click to delete a selected DDF from the list. You cannot delete a DDF that is preinstalled on the StruxureWare Central server. Note: Deleting a DDF will affect what sensors at devices related to that DDF will report. Click to access the wizard used to add or update DDF files, when available from APC, or stored on a local computer.
Add/Update Definitions
Use this display to select the source of new or updated DDF files.
Element
Check APC Website
Description
Click to see if any new or updated DDF files are available from APC.
231
Click to download a DDF file stored on a local computer. Click to browse to the DDF file on the local computer.
Use this display to select the DDF files you want to download from APC.
Element
List
Description
Select the DDF files that you want to download from APC from the list of available DDFs.
Each listing shows the currently installed version and whether a new or updated version is available. Installed: The DDF version matches the server's file. Updated: The DDF is an updated version of the server's file.
New: The DDF file is not installed at the server. Next Click to download the selected DDF files.
Use this display to verify that all DDF files were downloaded successfully.
You can edit the Notification Policy, Port, and Timeout settings, as well as settings not identified in the list, by selecting one or more of the listed devices and clicking Edit Device Scan Settings. The following editable settings are not identified in the list. Scan Interval (minutes)
232
Shared Element
Hostname
Description
When only one device is selected, identifies the hostname or IP address of that Modbus device. Note: No Hostname is provided when multiple devices are selected. Select the slave address you want associated with the selected Modbus device. Note: When more than one device is selected, the slave address may not be configured. The device definition file (DDF) associated with the device. Note: The DDF associated with a Modbus device cannot be modified. Select how much time will pass between StruxureWare Central server scans of a selected Modbus device for status information: from 1 through 60 minutes, and Default, the minutes for which is defined by the Global Scan Settings option's Scan Interval setting. Note: Setting the scan interval below the default value of five minutes can adversely affect performance when the StruxureWare Central server is managing a large number of devices. The number of the port used for Modbus communications with a selected Modbus device. Select how long the StruxureWare Central server will wait for a response before it considers an attempt to communicate with a selected Modbus device has failed.
Slave Address
Element
Scan Interval (minutes)
Description
Select how much time will pass between StruxureWare Central server scans for status information at a monitored Modbus device, when the "Device Scan Settings" display in the Modbus Device Communication Settings option has Default selected for that device's Scan Interval (minutes) setting.
233
Note: Setting the scan interval below the default value of five minutes can adversely affect performance when the StruxureWare Central server is managing a large number of devices.
234
Description
Lists the available credentials, and identifies Username, Password, IP Range, and Port Range values for each. Note: A default NetBotz credential is provided, as well as a default APC credential used to communicate with NetBotz Appliances on the private LAN. Click to add a new credential. Click to edit a selected credential. Click to remove a selected credential.
This display is accessed from the NetBotz Appliance Credentials option in the NetBotz Appliance Communication Settings option of the Device menu. Element
Username Password Verify Password IP Range
Description
Identify the username a credential will use to access NetBotz Appliances. Identify the password a credential will use to access NetBotz Appliances. Retype the password. Define the range of IP addresses at which the credential can be used to communicate with NetBotz Appliances. For example:
235
xxx.xxx.12.6: assigns a credential to a single IP address. xxx.xxx.10-13.20-80: assigns a credential to a specific set of IP addresses (20 through 80) at the 10, 11, 12, and 13 subnets. xxx.xxx.14.*: assigns a credential to all IP addresses at subnet 14.
Port Range Define the range of ports that a credential uses to access NetBotz Appliances. For example:
80: uses port 80 only (the default value). 60-80: uses ports 60 through 80, inclusive.
236
237
Note: For information about the possible status results, see the "Results" display description.
"Results" display
Use this display to review the result of a configuration activity for the selected NetBotz Appliance Configuration option.
Four results can be reported for each NetBotz Appliance you configured. Note: If an invalid password is used during an attempt to restore a NetBotz Appliance that is in Post-only mode, the status will go to Completed, with no restore or error occurring. Result In Progress Completed Unknown Description The configuration is being performed. The configuration was successful. Unable to provide a known result. Recommended Action: Try configuring the NetBotz Appliance, again. If the problem persists, log on to the NetBotz Advanced View at the appliance to see if the settings were applied successfully, and to configure the settings, if needed. Unauthorized An incorrect password was provided for the restore activity. Note: Unauthorized can be reported only when attempting to restore the configuration at an appliance.
Backup/Restore option
Use this option to store a configuration backup file in the StruxureWare Central server database for a selected NetBotz Appliance or Appliances, or to use those backup files to restore selected NetBotz Appliance configurations. The "Backup/Restore" wizard has three displays, two of which are shared with other NetBotz Appliance Configuration options, and a password pop-up display. 238
1. Use the "Select Backup or Restore" display to select whether you want to backup or restore NetBotz Appliances. 2. Use the "Select NetBotz Appliance" display, which is shared with every NetBotz Appliance Configuration option except Camera Settings, to select the appliances you want to backup or restore. 3. Use the "Backup/Restore Password" pop-up display to define a password used to encrypt backup configurations, or to access the backup files used to restore configurations. Note: If you use an invalid password during an attempt to restore a NetBotz Appliance in Post-only Mode, the restore will not occur, and no error will be reported. You will need to repeat the restore procedure using the valid password. 4. Use the shared "Results" display to view the results of the backup or restore activity.
239
Note: When a single camera device is selected, the "Camera Settings" display is accessed directly; when no selected NetBotz Appliance has an associated camera, the Camera Settings option is not available. NetBotz Appliance Camera Settings, a right-click option in the Thumbnails view: all cameras for the selected thumbnails. Note: When the thumbnail for only one camera is selected, the "Camera Settings" display is accessed directly.
Use this option to define when the selected camera will begin to capture data during an alarm, as well as the quality of the clip generated by the camera for alarms. Note: The Alarm Capture Data settings have nothing to do with how clips are generated for normal surveillance activities. For information about the settings that affect surveillance clips, see Surveillance Settings options under Surveillance feature. Element
Camera Resolution
Description
Sets the resolution of the images captured by the camera. The available sizes depend on the capabilities of the selected camera. Larger image resolutions will require increased amounts of disk space. Sets the maximum number of frames per second recorded to the disk when a clip is captured. This setting defaults to 1 frame per second.
Maximum Rate
Image Quality
Specifies the amount of compression that will be applied to captured images. As compression is increased, file sizes decrease but the quality of the image decreases as well. The available values, from highest image quality/largest file size to lowest image quality/ smallest file size are: High Quality, Normal Quality, Normal Compression and High Compression. Note: Actual frame rate available from image processor depends on the resolution and image quality of generated images. A maximum frame rate of 30 frames per second is available only at Normal Quality or lower and only at resolutions up to 640x480. The maximum frame rate for 800x600, 1024x768, and 1280x1024 (if available) at
240
Normal Quality or lower is 10 frames per second. For example, if you configure a Camera Pod 120 to capture images in High Quality, the Maximum Rate for some resolutions changes: At 640x480 and lower resolution the maximum frame rate drops from 30 frames per second to 20 frames per second. In 800x600 the maximum frame rate is unchanged (stays at 10 frames per second). In 1024x768 and 1280x1024 the maximum frame rate drops from 10 frames per second to 8 frames per second.
Post Alert Capture Time (seconds)
Specifies the total number of seconds after the alert triggering event for which images will be included in alert notifications. The number of post-alert images that are captured is equal to the Post-Alert Capture Time multiplied by the Rate value. Note that the individual alert actions may specify a Maximum Camera Pictures setting that is less than the total number of images captured in response to an alert. If the total number of pictures captured by the camera (including both post-alert captures and pre-alert captures) is larger than the Maximum Camera Pictures setting for an alert action then the most recent images captured are given preference and included in the alert notification. Note: Three alert actions have the Maximum Camera Pictures setting: Send E-mail, Send HTTP POST, and Send Data to FTP Server.
Specifies the total number of seconds prior to the alert triggering event for which images will be included in alert notifications. The number of pre-alert images that are captured is equal to the Pre-Alert Capture Time multiplied by the Maximum Rate value. Note that the individual alert actions may specify a Maximum Camera Pictures setting that is less than the total number of images captured in response to an alert.
241
If the total number of pictures captured by the camera (including both post-alert captures and pre-alert captures) is larger than the Maximum Camera Pictures setting for an alert action then the most recent images captured are given preference and included in the alert notification. Note: Three alert actions have the Maximum Camera Pictures setting: Send E-mail, Send HTTP POST, and Send Data to FTP Server.
Time delay before capturing (seconds) Include Audio Specifies the number of seconds between the triggering of the alert and the first picture capture.
Specifies whether the device should also use either the integrated microphone or an external microphone (if one has been plugged into the external microphone jack on the pod) to capture audio and include it with the alert for the duration of time covered by the alert notification. Note: This option is available only when configuring NetBotz Appliances that are capable of capturing audio.
Specifies the volume at which audio will be captured. Shows a variety of information about the files that will be generated by the camera using the currently selected Capture Settings. The information in this field will update automatically as new settings are specified or selected.
Image Settings
Use this option to configure the image quality and other settings (such as Timestamp Location) used for the selected camera during alarm and surveillance activities.
Element
Brightness (0-255) Gamma Correction
Description
Sets the brightness of the captured image. The value can be set from 0 to 255. Use this control to adjust the overall brightness of the camera image. Gamma Correction enables you to display captured image more accurately on your computer screen. Images which are not properly corrected can look bleached out or too dark. Select to rotate the image captured by the camera 180 degrees. This is useful for correctly orienting the image captures included in alert notifications and in the NetBotz Advanced View when the device has been mounted upside down due to installation location restrictions.
242
Note: This option is not available for use when configuring Capture Settings for CCTV Adapter Pods. Type of Lighting
Use this control to specify the color balance settings that will be used by the camera. The four pre-configured color balance selections are: Fluorescent: best color balance settings for locations with fluorescent lighting. Incandescent: best color balance settings for locations with incandescent lighting. Daylight: best color balance settings for locations with natural lighting. Auto-detect: analyzes the current lighting conditions and automatically selects the best. Custom: use the Red balance and Blue balance controls to fine tune the image to your specifications.
Adjusts the color balance of the image to counteract the effect of the lighting in the clip. Adjusts the color balance of the image to counteract the effect of the lighting in the clip.
Use this control to specify the location of the timestamp within the image capture: None, Bottom right, Bottom center, Bottom left, Top right, Top center, and Top left.
Masking
Use this option to create masks that will cause motion in user-specified image areas to be ignored ( Motion Mask), or prevent user-specified regions of the image from being seen ( Blockout Mask) for the selected camera during alarm and surveillance activities.
Note: When switching between the Motion Mask and Blockout Mask tabs, you may notice a difference in the size or resolution of the displayed Camera view. The Blockout Mask shows the entire field of view of the camera, while the Motion Mask shows the current cropped area of the Camera view. If you have limited the view of the camera by zooming in on the displayed image (through the device web interface or the NetBotz Advanced View application), the Motion Mask tab will show only the cropped area.
Motion Mask:
Use this tab to configure the camera's motion sensor to ignore movement that is detected in specified regions of the image capture. Note: A motion mask causes the camera to ignore any detected motion in the masked area. If detected motion would normally cause a clip to be generated, the motion mask prevents any action from being taken. These masks are useful if you want to restrict the 243
camera to movement only in a certain area: for example, monitoring an entryway next to a busy corridor. Using a motion mask, you can block off the corridor, so that only motion through the entryway causes a clip to be generated. Element
Drawing Mode
Description Select the Drawing Mode. Mask: dragging the mouse across the displayed Camera view draws a green masking rectangle. After you release the mouse button, the masking rectangle turns light blue. Any motion that takes place behind the blue rectangle will not trigger a clip. Unmask: dragging the mouse across the displayed Camera view draws a purple rectangle. After you release the mouse button, the rectangle disappears, along with any portion of a masking rectangle that intersects the purple rectangle. You can flip back and forth between modes as many times as you like until the motion mask is defined to your liking. Once you are finished, click Apply to save your changes. If you want to remove the current mask, click Revert Masks. This does not affect masks that you have already saved with the Apply button. If you want to remove an applied mask, use the Unmask mode.
Area of Motion
Use this setting to specify how large an area of the image must change (as determined by the Sensitivity value) before the changed image is considered movement. A lower Area of Motion value indicates a smaller area and therefore a smaller amount of movement is required to flag a change.
Sensitivity
Use this setting to specify how much change in a portion of the image will be tolerated before the changed image is considered movement. A lower Sensitivity value indicates less tolerance for change between images. More subtle movements will be marked as a change.
Select to enable the camera motion sensor. Select to have a dotted-line outline surround any region of a captured image that is determined to be indicative of motion.
244
Blockout Mask:
Use this tab to configure a selected camera so that specified areas of the image cannot be seen, when that camera is monitored by a NetBotz Appliance that has the Premium Software Module.
Element
Drawing Mode
Description Select the Drawing Mode. Mask: drag the mouse across the displayed Camera view to draw a green masking rectangle. After you release the mouse button, the masking rectangle turns light blue. When the surveillance feed is viewed, the masked area will be covered with a light grey rectangle. Any motion that takes place behind the gray rectangle will not trigger a clip. Unmask: drag the mouse across the displayed Camera view to draw a purple rectangle. After you release the mouse button, the rectangle disappears, along with any portion of a masking rectangle that intersects the purple rectangle. You can flip back and forth between modes as many times as you like until the motion mask is defined to your liking. Once you are finished, click Apply to save your changes. If you want to remove the current mask, click Revert Masks. This does not affect masks that you have already saved with the Apply button. If you want to remove an applied mask, use the Unmask mode.
Element
Enable NTP Server
Description
When selected, a Network Time Protocol (NTP) server provides the date and time values at a selected appliance; otherwise, these values are defined by the other Date and Time elements. Identify the IP address or hostname of at least one NTP server, when Enable NTP Server is selected.
NTP Server 1 - 3
245
Click to use the StruxureWare Central server's time and date settings at a selected appliance, when Enable NTP Server is not selected. Define the date a selected appliance will use, when Enable NTP Server is not selected. Define the time a selected appliance will use, when Enable NTP Server is not selected. Displays the date currently defined at a selected appliance, and can be used to define that date, when Enable NTP Server is not selected.
Description
Allows you to select a listed device or sensor for which you want to edit the Location Data.
When a single appliance is selected, the list has the following entries:
NetBotz Appliance Sensor pods Output relay pods Camera pods, with individual sensors Ethernet link status
When multiple appliances are selected, this list provides the following entries, only: NetBotz Appliances Sensor pods Camera pods, without individual sensors
246
Note: No listing is provided for output relay pods, or Ethernet link status.
Location Data Allows you to select the value you want to edit from a wide variety of standard, location-based values. Note: By default, pods, and the Ethernet link status, inherit their NetBotz Appliance settings, and sensors inherit their pod's settings. Click to edit a selected location value.
Edit
Description
Identify the remote devices you want to have share their pods with a selected NetBotz 500 or 550 Appliance by using the "Update Remote Device" display to add a new remote device, or edit or delete an existing one. With a remote device selected in the Remote Devices list, highlight one or more of its pods in this Shared Pods list. Then click Share Remote Pod, to share the selected pods with the NetBotz 500 or 550 host, or Stop Sharing Pod, to stop sharing those pods. Note: The NetBotz Appliance entry allows you to select whether you want to share the integrated pods at that appliance.
Shared Pods
247
shared pods or devices, providing alert and sensor data exactly as if they were directly connected to the NetBotz 500. It is important to note the following concerning pod sharing. The Pod Sharing task can be run only on one device at a time. A NetBotz 500 v2.6 or later, or a NetBotz 550, can host remote pods without using the optional Premium Software Module that must be used with earlier NetBotz 500 versions for pod sharing. Pods that are not physically connected to a device do not count against the total number of USB-connected devices allowed for the NetBotz Appliance model. A NetBotz 420 supports an additional camera pod and up to four additional noncamera pods. A NetBotz 500 or 550 supports up to four camera pods and up to 17 non-camera pods. Frame rate from remotely hosted camera pods is limited to 10 frames per second. The camera image resolution available from a hosted camera pod is determined by the maximum resolution available to the device to which the pod is physically connected. For example, for a Camera Pod 120 connected to a NetBotz 500, the maximum resolution is 1280x1024. However, if the Camera Pod 120 is connected to a NetBotz 420, the maximum is 640x480.
Element
Host/IP Address
Description
Identify the hostname or IP address of the remote device that has pods you want it to share with the host NetBotz Appliance. Identify the port used for the communication: default is 80 for HTTP, and 443 for HTTPS. Select how the Secure Sockets Layer (SSL) protocol will be used for the communication with the remote device: None, Require SSL - No verification, Require SSL - Verify certificate, or Require SSL - Verify certificate and hostname. Type in the User ID to be used to access the remote device. Note: Some remote pod functionality may be unavailable if the user ID is for a user account that does not have Administrator privileges. Type in the password to be used with the User ID to access the remote device. Retype the password. Define how long, in seconds, the host NetBotz Appliance will wait for a response before it considers an attempt to communicate with a remote device has failed.
User ID
248
When a NetBotz Appliance is discovered by StruxureWare Central, the hostname of the StruxureWare Central is added to the NetBotz Appliance. This enabled the StruxureWare Central to receive alert postings from the NetBotz Appliance. If your server does not use DNS, you will need to change the alert post entry on the NetBotz Appliance to the IP Address of the StruxureWare Central server. Note: This display also can be accessed when using Network Settings, a Server Administration Settings option in the System menu, to change the Public (LAN1) tab's Hostname or IP Address settings: when asked if you want to update the NetBotz Appliance post settings, click Yes. Element
Current Current StruxureWare Central Hostname
Description
The Hostname defined in the Network Settings option's Public (LAN1) tab.
StruxureWare Central IP Address The IP Address defined in the Network Settings option's Public (LAN1) tab. Select an IP address or hostname from the dropdown list, or type in the hostname or IP address you want the monitored NetBotz Appliances to use to post alert data. Note: If any of the NetBotz Appliances you want the StruxureWare Central server to monitor have no DNS service available, select to use the server's IP address. Otherwise, those appliances will be unable to post data to the server, and status will only be available in response to polling.
can modify the Auto Lock Timeout only. To modify the supported card type, you must first remove all the cards associated with the appliance. The Show Unregistered Cards link is displayed when one or more rack access cards swiped at a Rack Access Pod 170 device have not been registered to the associated NetBotz Appliance. You access the "Unregistered Cards" display from the link to select the rack access cards you want to register, or remove cards you do not want to register from the list. You can add up to 200 rack access cards to the list for the device group, or NetBotz Appliance or Appliances selected. You identify the Card ID #, the user name, a description, and whether the card requires an authorization card swipe from another card to access the door. You can modify the settings for each card, remove cards from the list one at a time, or copy the scheduled access of one card to another. Note: When you remove cards from the list, you must press Apply or OK to save the changes. You select a card in the left pane to display its card ID #, user name, description, and authorization requirement, if any, above the right pane. The right pane allows you to select the doors on which to enable or disable access for that card, 24 hours a day, 7 days a week by default. You can select a NetBotz Appliance, a Rack Access Pod 170, or a door, and press Edit Access to modify the weekly access schedule. Note: When you enable or disable door access, you must press Apply or OK to save the changes. You must configure door access for one card at a time. You can then copy the scheduled access of one card to another. Four menus provide access to the Rack Access Settings: NetBotz Appliance Configuration option, accessed from the Device menu. Right-click menu NetBotz Appliance Configuration in the Device View and Map View of the Monitoring perspective. Right-click menu in the Device Groups view. When you access the "Rack Access Settings" display from the right-click menu NetBotz Appliance Configuration in the Device View and Map View of the Monitoring perspective, the NetBotz Appliance you selected, and its associated Rack Access Pod 170 devices, are displayed in the right pane. When you access the "Rack Access Settings" display from the NetBotz Appliance Configuration option, accessed from the Device menu, the device groups that contain NetBotz Appliances monitoring Rack Access Pod 170 devices, and their associated appliances and devices, are displayed in the right pane. When you access the "Rack Access Settings" display from the right-click menu NetBotz Appliance Configuration in the Device Groups view of the Monitoring perspective, the device group you selected that contains NetBotz Appliances monitoring Rack Access Pod 170 devices, and its associated appliances and devices, are displayed in the right pane.
You use the left pane in this display to add up to 200 rack access cards for the selected device group, or NetBotz Appliance or Appliances, and assign users to those cards. You 250
then select a card in the left pane, and select a device group, NetBotz Appliance, Rack Access Pod 170, or door in the right pane to enable, disable, or schedule the rack access for that card. When no HID cards proximity cards have been registered for the selected NetBotz Appliance, the "NetBotz Appliance Settings" display appears when you access the Rack Access Settings option. This display allows you to specify the supported card type and auto lock timeout for the selected appliance. You can access the "NetBotz Appliance Settings" display from the NetBotz Appliance Settings link to modify the Auto Lock Timeout only. To modify the supported card type, you must first remove all the cards associated with the appliance. When one or more rack access cards swiped at a Rack Access Pod 170 device have not been registered to the associated NetBotz Appliance, the Show Unregistered Cards link is displayed. You can access the "Unregistered Cards" display from the link to select the rack access cards you want to register, or remove cards you do not want to register from the list. Left pane: Element
List
Description Card ID#: The identification number assigned to the card. User name: The user name assigned to the card.
Select to add a rack access card to the list. Select to modify the username, description, or authorization level for the selected card. Select to remove a card from the list. Note: You must press Apply or OK to save the changes. Select to copy the scheduled access of the selected card to one or more additional cards.
Copy
Description
Displays the card ID # selected in the table at left, the associated user name, description, and whether a swipe from an additional card is required to authorize rack access. Note: The additional card must not require an authorization card swipe.
List
Door: Select a device group, NetBotz Appliance, or Rack Access Pod 170 device, or check mark one or more doors to schedule access for the card selected. Scheduled Access: Icons for each door indicate whether access is scheduled 24 hours a day, 7 days a week ( full green icon),
251
Disable
Edit Access
You can use the right-click options in the right pane to do the following: Enable or disable rack access 24 hours a day, 7 days a week for the selected device group, NetBotz Appliance, Rack Access Pod 170 device, or door ( Enable or Disable option). Schedule weekly rack access for the selected device group, NetBotz Appliance, Rack Access Pod 170 device, or door ( Edit option). Expand or collapse the list for the selected device group, NetBotz Appliance, or Rack Access Pod 170 device ( Expand or Collapse option). Select every door for every NetBotz Appliance in the list ( Select All Doors option). Select every Door 1 door for the selection ( Select All Door 1 Doors option). Select every Door 2 door for the selection ( Select All Door 2 Doors option). Note: To lock and unlock the doors, you use the Rack Access Control option, available in the right-click menu of the Device View or Map View for the selected controllable NetBotz Appliance or NetBotz Rack Access Device.
"NetBotz Appliance Rack Access Settings" display
Use this display to identify the HID proximity card type used for the selected NetBotz Appliance, and specify the auto lock timeout. All cards registered to the NetBotz Appliance must use the same card type. The "NetBotz Appliance Rack Access Settings" display appears the first time you access the Rack Access Settings option for a selected NetBotz Appliance. You can specify one of four supported HID proximity card types: H10301 - Standard 26-bit H10302 - 37-bit without a facility code H10304 - 37-bit with a facility code CORP1000 - Corporate 1000 You can access the display again, if needed, from the NetBotz Appliance Settings link in the "Rack Access Settings" display. You can modify the Auto Lock Timeout only. To modify the supported card type, you must first remove all the cards associated with the appliance. The Auto Lock Timeout determines how long the device will wait (10 - 60 seconds) until it automatically locks the rack door after a card, a key, or a remote command is used to unlock it. If the door is open or the handle is up after the timeout expires, the device will issue the lock command until the door is closed and the handle is down.
252
Additionally, the Auto Lock Timeout limits the time the device will wait for a second authorizing card swipe after a rack access card that requires authorization is swiped. Element
Card Type
Description
The type of HID proximity card registered to the NetBotz Appliance selected. You can specify the card type once only. Specify the time the device will wait until it automatically locks the rack door after a card, a key, or a remote command is used to unlock it (10 - 60 seconds).
Use this display to register one or more rack access cards swiped at a Rack Access Pod 170 device, and not registered to the associated NetBotz Appliance. Note: You access this display from the "Rack Access Settings" display Show Unregistered Cards link, available only when a rack access card swiped at device for the selection has not been registered. Element
List
Description Card ID#: The identification number assigned to the card. Timestamp: The date and time the rack access card was swiped.
Select to register the selected rack access cards. Select to remove the selected unregistered rack access cards from the list. Select to remove all unregistered rack access cards from the list.
Use this display to add a rack access card, and specify its authorization level.
Element
Card ID # User Name Description Requires Authorization Card Swipe
Description
Identify the number assigned to the card, in the format shown. Identify the user name assigned to the card Provide a description for the card, if desired. Specify whether a swipe from an additional card is required to authorize rack access.
Use this display to modify the settings, with the exception of the card ID #, for a rack access card.
253
Element
Card ID #
Description
The number assigned to the rack access card cannot be modified. Note: You can use the "Add Rack Access Card" display to add another card and copy settings to it. Modify the user name assigned to the card. Modify the description. Specify whether a swipe from an additional card is required to authorize rack access.
Use this display to copy the weekly access schedule from the selected rack access card to one or more cards.
Element
Source Card Include Authorization Card Swipe Attribute List
Description
The Card ID # and user name of the card from which the weekly access schedule will be copied. Check-mark to require a swipe from an additional card to authorize rack access.
Check-mark one or more rack access cards on which to copy the weekly access schedule.
Use this display to define the specific periods of time, for each day of the week, during which rack access will be enabled or disabled for the card selected, and the device group, NetBotz Appliance, Rack Access Pod 170 device, or door selected, in the "Rack Access Settings" display.
The table provides cells for 15-minute increments, and columns for every day of the week. You can do all of the following to schedule when rack access is enabled: Click a column title to enable or disable all of that day's cells. Drag your mouse from one cell to another cell in a column, to enable or disable a set of cells. Drag your mouse from a cell in one column to a cell in another column, to enable or disable an identical set of cells for each of the selected days. Enable or disable all cells ( Enable All or Disable All button icons). Double-click or right-click a disabled cell to schedule access for the day selected ( New Schedule option). Double-click or right-click an enabled cell to modify scheduled access for the day selected ( Edit Schedule option). Right-click an enabled cell to disable scheduled access for the day selected ( Remove Schedule option).
254
Element
Locale
Description
Select the locale that best identifies where a selected appliance is physically located, to match a selected NetBotz Appliance's measurements (metric or US standard) and date/time formats to the formats commonly used at that location. Select to have a selected appliance use a 24hour clock. Select the time zone in which a selected appliance is located.
Basic tab
Element
SIM PIN
Description
For modems that use a SIM (subscriber identification module), identify the PIN (personal identification number) used to unlock that SIM. Note: For modems that do not have a SIM, this field must be blank. Identify the SIM PIN, again. Identify the address of the Short Message Service Center (SMSC) used by your SMS service.
The SMSC is essentially an SMS server that is used to send the messages. The address for the SMSC is typically programmed into 255
the SIM and, therefore, you can typically leave this field blank.
Note: Entering a value in this field will override automatic SMSC selection. Destination Identify the address used to send an SMS to an e-mail destination.
When an SMS message needs to be sent to an e-mail destination address, the NetBotz Appliance puts the e-mail address at the beginning of the message and sends it to the Destination address. The SMSC receives the message, pulls out the e-mail address, and sends the remainder of the message to that address.
Note: The default value for this field is 0000000000, the value that works with AT&T Wireless. Interrupt PPP When an SMS Alert Occurs Select this option if your modem supports both SMS and Point-to-Point Protocol (PPP) communications, to allow SMS communication to override PPP communication when necessary.
If PPP dial-out is active when the NetBotz Appliance needs to send an SMS alert, PPP will be interrupted while the SMS message is sent. Once the SMS message has been sent, the PPP connection will be reestablished.
Advanced tab
Element
Send Debug Messages to Syslog Use Default SMS Settings
Description
Select to have debug messages forwarded to the syslog host. Select to use the default SMS values for your SMS-capable modem. Note: To use custom settings, disable this option and use Use Protocol Descriptor Unit (PDU), Character Set, and Initialization Commands to specify those customs settings. Select to use the PDU mode when communicating with the modem to send an SMS message. Note: PDU mode is more versatile than the default SMS text settings mode, and some modems do not support both modes. Identify the character set to be used when communicating with the modem to send an SMS message.
Character Set
256
Initialization Commands
Identify the initialization string to be used for the modem that will send SMS messages.
Description
Select to enable the SNMP agent settings. Define the community name used for read-only SNMP requests. Confirm a new or edited Read-only Community Name definition. Define the community name used for read and write SNMP requests. Confirm a new or changed Read/Write Community Name definition. Identify the number of the port used for SNMP agent communication.
Version 3 tab
Use this tab to identify the settings that an NMS can use for SNMPv3 communication with a NetBotz Appliance. Element
Users
Description
Select the user accounts an NMS can use to connect to the SNMPV3 Agent on a selected NetBotz Appliance. Select SHA-1 or MD5 as the protocol used when sending SNMPv3 informs to the target device. Select whether encryption will be used with the SNMPv3, and if used, which protocol: None, DES, or AES-128.
257
Users
A Users list identifies the users by Name, Username, and Privilege Set., and Add, Edit, and Delete buttons allow you to manage that list. The "Add User" and "Edit User" displays have standard account Name and logon values ( Username, Password, and Verify Password). They also have a Privilege Set dropdown menu used to select the access a user will have at the selected NetBotz Appliances. Note: You cannot delete the Guest Account, and can only edit its Privilege Set; you can edit the Name, Username, and Password values for the default administrator, but you cannot delete it, or change its Privilege Set. Privilege
None Administrator Sensor (No camera)
Description
Allows no access to any features. Allows access to all information and configuration tasks at a selected appliance. Allows access to the Navigation pane, Sensor Data pane, Map View (if enabled), and selected portions of the NetBotz Advanced View information and action views, as well as the ability to view the Graphs View and About view.
This Privilege Set does not allow access to the Cameras View, Alerts View, or Configuration view.
Sensor In addition to Sensor ( No Camera) access, allows access to the Cameras View.
This Privilege Set does not permit access to the Alerts View or Configuration view.
Application Allows access to the Navigation pane, Sensor Data pane, Map View (if enabled), and selected portions of the NetBotz Advanced View information and action views. Also allows viewing the Camera View, Graphs View, Alerts View, and About view.
This Privilege Set does not permit access to the Configuration view, or the ability to resolve alert conditions for thresholds configured with the Return-To-Normal Requires User Input setting selected for their Advanced Settings.
Application (with Alert Update)
In addition to Application access, allows the ability to resolve alert conditions for thresholds configured with the Return-To-
258
Normal Requires User Input setting selected for their Advanced Settings.
This Privilege Set does not permit access to the Configuration view.
Logon alerting
Provides two drop-down menus, one which selects the alert profile you want a selected NetBotz Appliance (greyed out when multiple appliances are selected) to use for alert notifications for logon failures, and one which selects the severity you want assigned to logon failures at the selected appliance or appliances: Informational, Warning, Error, Critical, and Failure. Note: Default, for Logon Failure Alert Profile, and Failure, for Logon Failure Alert Severity, are the default settings.
259
260
3. Use the "Configure Device Settings" display to select, and edit, as needed, the settings you want to store in the template, and click Next. 4. Use the "Save Configuration Template" display to name the template, and to save it when you click Finish.
The action selected in the "Select a Configuration Action" display affects what elements are available in the "Select Configuration Source" display.
261
Use this version of the "Select Configuration Source" display to select the APC SNMP device you want to use to configure other APC SNMP devices (Configure Devices action) or to create a template (Create a Template action).
Description Filter the table to list only entries that include the text you type, exactly as typed. Select the APC SNMP device you want to use to create the new template, or to configure other APC SNMP devices directly from its settings. All APC SNMP devices monitored by the StruxureWare Central server are listed. Note: In addition to standard identification information ( Hostname, Type, Model, Location, and IP Address), the list also identifies when the settings for a device were last retrieved by the StruxureWare Central server ( Last Retrieved column), if at all ( Not Retrieved).
Click to access the "Device File Transfer Settings" display used to manage the File Transfer Protocol (FTP) or Secure Copy (SCP) access values for APC SNMPv1 and SNMPv3 devices. Click to force the StruxureWare Central server to retrieve the most recent settings for a selected device. Tip: You must retrieve the settings for a device that reports Not Retrieved as its Last Retrieved status before you can use that device. Note: If a pop-up status message appears, you can click Status messages: Configuration Status view, a related information link provided below, for information about that message. Click to access the "Select Destination Devices" display ( Configure Devices action), or the "Configure Device Settings" display ( Create a Template action). Click to return to the "Select a Configuration Action" display.
Next
Back
Description Filter the table to list only entries that include the text you type, exactly as typed. Select the template you want to rename, delete, or edit. Click to rename a selected template. Click to delete a selected template. Click to edit a selected template using the "Configure Device Settings" display. Click to return to the "Select a Configuration Action" display. Click to save your Rename or Delete changes, and exit the "APC SNMP Device Configuration" wizard. Note: Only enabled when you finish renaming or deleting at least one listed template.
Description Filter the table to list only entries that include the text you type, exactly as typed. Select the template you want to use. Click to select the APC SNMP devices you want to configure using the "Select Destination Devices" display. Click to return to the "Select a Configuration Action" display.
Back
263
Description Filter the table to list only entries that include the text you type, exactly as typed. Select (check-mark) the devices you want to configure from the list of all APC SNMP devices monitored by the StruxureWare Central server. You can select devices that are all the same model (Smart-UPS 750), all the same type (UPS), or any set of devices (Symmetra 80K, Integrated EMU, and APC Rack Manager, for example). Note: In addition to standard identification information ( Hostname, Type, Model, Location, and IP Address), the list also identifies when the settings for a device were last retrieved by the StruxureWare Central server ( Last Retrieved column), if at all ( Not Retrieved). Click to access the "Device File Transfer Settings" display used to manage the File Transfer Protocol (FTP) or Secure Copy (SCP) access values for APC SNMPv1 and SNMPv3 devices. Click to force the StruxureWare Central server to retrieve the most recent settings for the device that is highlighted (actively selected) in the list. Tip: You must retrieve the settings for any device that reports Not Retrieved as its Last Retrieved status before you can configure that device using the selected configuration source (APC SNMP device or template). However, when multiple devices of the same model and firmware, are listed as Not Retrieved, retrieving the settings for one of those devices updates the Last Retrieved status for all of those devices: the StruxureWare Central server recognizes that identical devices (same model and firmware version) have identical available settings. Note: If a pop-up status message appears, you can click Status messages: Configuration Status view, a related information link provided below, for information about that message. Click to access the "Configure Device Settings" display. Click to return to the "Select Configuration Source" display.
Next Back
264
Edit
Back Finish
265
Description Edit the template's name ( Edit a Template action), if desired, or type in a new name ( Create a Template action). Filter the table to list only entries that include the text you type, exactly as typed. Select a listed template to save the edited settings to that template rather than to the template you selected to edit ( Edit a Template action) or to a new template ( Create a Template action). Click to return to the "Configure Device Settings" display. Click to save your changes, and exit the "APC SNMP Device Configuration" wizard. Note: When creating a new template, Finish is disabled until you provide some information in the Configuration Name text box .
Filter List
Back Finish
Element List
Description Lists the access settings the StruxureWare Central server can use for FTP or SCP access to its monitored devices. Username: The username used for access to a device. Note: By default, the StruxureWare Central server can download firmware only to devices that use apc (lowercase) for the username and password (the actual password used for device access is
266
Element
Description identified in the "Edit Device File Transfer Settings" display). IP or IP Range: The IP address, or range of addresses, at which the access settings support FTP or SCP communication. FTP Port: The port used for FTP access to a device. SCP Port: The port used for SCP access to a device. Timeout: How long the server will wait before it considers that an attempt to access a device has failed. Retry Limit: How many times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default). Protocol: The protocol the transfer settings set will use to access devices ( FTP only, SCP only, or Try SCP, fall back to FTP).
Click to add an access setting to the list. Click to edit a selected access setting. Click to delete a selected access setting.
Description
Identify the name used for access to a device. Identify the password used for access to a device. Retype the password. Identify The IP address, or range of addresses, at which the access settings support FTP or SCP communication ( *.*.*.*, by default).
267
Protocol
Identify whether the transfer settings will use FTP ( FTP only), SCP ( SCP only), or attempt to use SCP, but fall back to using FTP if SCP fails ( Try SCP, fall back to FTP). Select the port the server will use for FTP access to devices ( 21, by default). Select the port the server will use for SCP access to devices ( 22, by default). Identify how long the server will wait before it considers that an attempt to access a device has failed ( 3000, by default). Select the number of times the server will try to access a device, after the initial attempt failed, before it stops trying to access that device ( 1, by default).
Retry Limit
Configuration Progress
Configuration Results
268
Note: No information is provided for the three progress messages ( Retrieving configuration, Transferring configuration, and Waiting for configuration to load), or for the Configuration successful message. Message Incomplete configuration Description The configuration finished, but not all settings were applied successfully. Either the destination device doesn't support the applied setting, or the configuration process failed to overwrite an existing setting value. Recommended Action: This can occur when different types of devices are selected for the source and destination devices (for example, a Rack PDU and Smart-UPS). Select devices that match, and try again. This can also occur when an applied value does not fall into the allowed values range/ list (such as a string that exceeds the maximum length, False rather than Enabled, etc.). Note: You can select the device and click Configuration Results to access the "Configuration Results" display and review the settings that failed to be configured. Failed: Unable to connect A network or file transfer protocol communication problem exists. Recommended Action: Make sure the device is turned on and online, the appropriate file transfer protocol is enabled at the device, and that the "Device File Transfer Settings" display settings used to access the device include the device's correct port number. Correct any network connection problem. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ). Failed: Unable to log on The StruxureWare Central server does not have the appropriate file transfer protocol settings needed to log on to the device, or communication was lost after the connection was successful. Recommended Action: Make sure the access settings needed to log on to the device are defined in the "Device File Transfer Settings" display, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network.
269
Message
Description Correct any network connection problem. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ).
A problem occurred, after the server logged on to the device successfully, that prevented the server from transferring the configuration. Recommended Action: Make sure the access settings have not changed at the server or device, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ).
A problem occurred, after the StruxureWare Central server transferred the configuration to the device successfully, that prevented the server from verifying that the configuration was successful by retrieving a copy of the configuration from the device. Recommended Action: Make sure the access settings have not changed at the server or device, and the appropriate file transfer protocol is still enabled at the device. Make sure the device has not been turned off or disconnected from the network. Correct any network connection problem. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ).
A network or file transfer protocol communication problem prevented the StruxureWare Central server from logging on before the Timeout identified in the "Device File Transfer Settings" display expired. Recommended Action: Make sure the device is turned on and online, and the appropriate file transfer protocol is enabled at the device. Also, make sure the "Device File Transfer Settings" display includes the correct access settings needed to access the device, and that the Timeout value is 270
Message
Description appropriate for the network traffic requirements. Correct any network connection problem. Note: If the problem persists, contact APC Support ( http://www.apc.com/support ).
Actual Value
271
Note: You can change the protocol only on APC SNMPv1 devices that support SNMPv3. For information about whether an APC SNMP device supports SNMPv3, consult the device documentation. Before you begin, it is recommended you view and confirm the devices you want to convert from SNMPv1 to SNMPv3 in the "Device Scan Settings" display, accessed from the SNMP Device Communication Settings option in the Device menu. 1. Select the APC SNMP Device Configuration option in the Device menu. 2. Select Configure Devices. 3. Select the APC SNMPv3 device you want to use as the source. 4. Click Retrieve Device Settings. 5. Click Next to select the devices you want to convert to SNMPv3. To ensure only the devices you want to convert to SNMPv3 are selected, you can checkmark Select/Deselect All to clear the list, then checkmark the devices to include. Expand SNMPv1 Settings and checkmark the Access option. Double-click the Access option under SNMPv1 Settings, or select the Access option and click Edit, to change its setting to Disabled, if necessary. Uncheck Authentication options 1 - 4, if necessary. Expand the SNMPv3 Settings option. Double-click the Access option under SNMPv3 Settings, or select the Access option and click Edit, to change its setting to Enabled, if necessary. Expand the Authentication options 1 - 4 you want to use, select the Access option under each option, and click Edit, to change its setting to Enabled, if necessary. Checkmark other available options to change their settings, if necessary.
The security settings on some target devices might require setting user passwords, authentication phrases, and encryption phrases manually at the device user interface. 13. Click Finish. You can monitor progress applying the settings to the selected devices in the Device Configuration Status view, accessed from the Device option in the Window menu.
272
273
You can choose to display a new custom property key as a column in the Device View, or select it later in the Configure Columns display. Element
Add Edit Remove
Description
Specify the name of the custom property key. Note: The property key cannot be blank. Modify the name of the selected property key. Remove one or more selected property keys.
274
You use this display to identify settings to access PowerLogic ION Enterprise WebReach and Web Reporter on your ION Enterprise server. After you test the ION Enterprise settings, and enable ION Enterprise integration, the StruxureWare Central client must restart to display the Power Management button on the application bar. The Power Management perspective provides access to the ION Enterprise view. Direct access to WebReach version 5.6 is provided in the ION Enterprise view. WebReach version 6.0 requires you to log in. The WebReach display in both versions is read-only. Web Reporter, available in version 6.0 only, allows read-write access to your reports only if you log in as a user with write access. Element
Enable ION Enterprise Integration
Description
Check-mark to enable ION Enterprise integration with the StruxureWare Central server, unchecked by default. Note: When ION Enterprise integration is enabled or disabled, the StruxureWare Central client must restart. Select Version 5.6 to access WebReach.
Select Version 6.0 to access PowerLogic ION Enterprise WebReach and Web Reporter.
ION Enterprise Hostname Test The hostname of the ION Enterprise server. Click to contact the ION Enterprise server to test integration settings before they are applied. Note: If you modify the configuration, you must test the settings before they are applied
275
Three icons are specific to the ION Enterprise server; one icon, the ION Enterprise Settings icon, is specific to StruxureWare Central. Icon Description
Use this back icon to navigate through tabbed reports, or open displays. Use this ION Enterprise Home icon to navigate to the home page for ION Enterprise integration with the StruxureWare Central server. Use this forward icon to navigate through tabbed reports, or open displays. Use this ION Enterprise Settings icon to access the StruxureWare Central "ION Enterprise Settings" display.
276
Element
Description Location, Device Type, or Model) to sort the list. Note: All monitored devices are listed, unless filtered, but only a maximum of 247 devices can have slave addresses assigned.
Select (check-mark) or deselect all devices. Click to access the "Modify Device Settings" display for a selected device. Note: Disabled when more than one device is selected. Click to assign a Slave Address to a selected device or devices. Note: Any device with an existing Slave Address assignment will be unaffected. Click to unassign a Slave Address for a selected device or devices.
Description Filter the table to list only entries that include the text you type, exactly as typed. Select a new slave address for the device, if needed. Note: Only slave addresses, from 1 through 247, which are not mapped to another device are listed; No Slave Mapping is selected when the device has no slave address assigned, and can be used to change the device's slave address to unmapped. Select a sensor or sensors, to map Register values for those sensors or remove them from the list, or select a single sensor, to modify its Register value. You can click on any column head ( Register, Sensor, Units, or Details) to sort the list. Note: All sensors for the selected device are listed, unless filtered. 278
List
Description Select (check-mark) or deselect all sensors. Click to edit or delete the Register value for a selected sensor. Note: Disabled when more than one sensor is selected. Click to remove the Register value for a selected sensor or set of sensors. Click to map a Register value for the selected sensor or set of sensors. You can use any value between 31000 to 39999 for a single sensor; for a set of sensors, you can use any value that is at least 31000 for the start of the Register value range, as long as that value allows for mapping all of the sensors within the maximum range of 39999. If you select a single sensor, whether that sensor is mapped already, its value will map to the new value unless that value is assigned to another register. In that case, the next highest available value will be used. For example, if you define 31009 as the value, 31009 through 31058 are assigned to other sensors, 31059 will be assigned to the sensor. Note: To map a sensor to a value that is assigned to another register, you must either change or remove that value at the other register. If you select multiple sensors, the sensors are mapped sequentially from the sensor at the top of the list through to the sensor at the end of the list, except as follows: Any values assigned to unselected sensors will be skipped. If the starting value is assigned to an unselected sensor, the mapping will start at the next highest available value. For example, if you select 31005, and 31005 through 31050 are already assigned, 31051 will be the first Register value assigned.
Click to apply the contents of a *.csv file for a previously saved register map to the list. Click to save a copy of the register map, as configured, as a *.csv file. Note: Do not edit the .csv file for an exported register map. Any errors made during editing can affect the MODBUS TCP
279
Element
Description Output Module support when that file is imported. Click to copy the register map, as configured, to one or more devices using the "Copy Register Map to Device" display.
280
Ensure the connection speed and the system running the StruxureWare Central client meet the minimum requirements necessary to perform the migration: a. Network speed of 100 Mb/s or higher b. 2 GHz CPU or higher c. 2 GB RAM or higher Ensure the node license on the StruxureWare Central server is adequate for devices to be migrated from InfraStruxure Manager v4.7. The StruxureWare Central MODBUS TCP Output Module is a separately licensed feature. If this feature is required, ensure there is a Building Management Systems license on the StruxureWare Central server. Note: The Building Management System used to monitor StruxureWare Central devices must support Modbus TCP. Support for Modbus RTU provided by InfraStruxure Manager is not available on the StruxureWare Central server. InfraStruxure Operations, a separately-licensed application, provides functionality similar to the Power Zones, Physical Layout, and Rack Properties features in InfraStruxure Manager, and the ability to import StruxureWare Designer solutions. If this functionality is required, ensure there is an InfraStruxure Operations license on the StruxureWare Central server. Ensure there are no IP conflicts between the InfraStruxure Manager private LAN and the StruxureWare Central server private LAN: a. The StruxureWare Central server and the InfraStruxure Manager must be on the same physical and logical private network. b. The StruxureWare Central server private LAN IP address must not conflict with the InfraStruxure Manager private LAN IP address. c. The StruxureWare Central server private LAN IP address must not conflict with any device on the InfraStruxure Manager private LAN IP. d. DHCP on the StruxureWare Central server private LAN must be disabled. If migration includes devices on the InfraStruxure Manager public LAN, you must connect to the StruxureWare Central server using its public LAN to perform the migration. The StruxureWare Central server does not support RADIUS. If secure logon is required, prepare to use OpenLDAP or Active Directory authentication. Ensure the SNMP community names for APC Protocol devices you want to migrate are in the InfraStruxure Manager Device Access list. Note: When migration includes devices on the private LAN, the InfraStruxure Manager will be turned off when migration is complete. NetBotz Appliances monitored by the InfraStruxure Manager will not be migrated to the StruxureWare Central server. Prepare a list of the hostnames or IP Addresses of the NetBotz Appliances to be monitored by the StruxureWare Central server. You can use the StruxureWare Central Device Discovery wizard in the Device menu to specify the NetBotz Appliances to discover. Prepare to create alert thresholds and notification settings for NetBotz Appliances that will be monitored by the StruxureWare Central server. You can use the StruxureWare Central NetBotz Appliance Configuration options in the Device menu. Ensure the StruxureWare Central client can remain open during the migration. Note: When the "Applying stored settings" message appears in the InfraStruxure Manager Migration Utility Status view, the client can be closed. Create a StruxureWare Central server backup if the StruxureWare Central server to which you are migrating InfraStruxure Manager data and settings is already in use.
Central server. When migration is complete, devices managed by the InfraStruxure Manager will be managed by the StruxureWare Central server. When migration includes devices on the private LAN, the InfraStruxure Manager will be turned off.
283
Note: You select this option if you have a recent backup file for your StruxureWare Central server, or if the StruxureWare Central server is new and contains no data or settings to migrate. You can select Do not show me this again to bypass the message in the future, and access the InfraStruxure Manager Migration Utility directly. Note: See Server Backup/Restore option under Server Administration Settings (System menu) for more information.
Description
The hostname or IP address for the InfraStruxure Manager from which you want to migrate settings and data. The administrator user name for the InfraStruxure Manager. The administrator password for the InfraStruxure Manager.
Element
Devices and Groups
Description
Specify whether to migrate public devices and device groups, private devices and device groups, the data log, or all, from the InfraStruxure Manager to the StruxureWare Central server. Note: If the license keys installed on the StruxureWare Central server are not adequate for all the devices you want to migrate, a message will be displayed. You can purchase additional node license keys, if needed, and add them to the StruxureWare Central server before you continue the migration. Specify whether to migrate SNMP, FTP, Users, Server Proxy, SOCKS proxy settings, or all, from
Server Settings
284
the InfraStruxure Manager to the StruxureWare Central server. Time Settings Specify whether to migrate NTP, Time Zone settings, or all, from the InfraStruxure Manager to the StruxureWare Central server. Specify whether to migrate Notification settings from the InfraStruxure Manager to the StruxureWare Central server. Note: If no public or private devices are migrated, only notification recipients will be migrated. Export the event log as a *.csv file to a location you specify on the local drive. Accesses the "License Keys" display, a Server Administration Settings option in the System menu, to add additional license keys, if necessary, to manage nodes migrated from the InfraStruxure Manager, or to access the functionality available in separately-licensed applications. Note: Adding license keys for separatelylicensed applications, such as InfraStruxure Operations, InfraStruxure Change, or InfraStruxure Capacity, may cause the StruxureWare Central server to reboot. APC recommends adding any necessary license keys before using the InfraStruxure Manager Migration Utility.
Notification Settings
Provides more information about selecting settings and data to migrate from the InfraStruxure Manager v4.7 to the StruxureWare Central server in the "Migration Options" display.
Element
Devices and Groups
Description
When the license keys installed on the StruxureWare Central server are not adequate for all the devices you want to migrate, a message will be displayed. You can purchase additional node license keys, if needed, and add them to the StruxureWare Central server before you continue the migration. When devices on the private LAN are migrated, the InfraStruxure Manager will be turned off when migration is complete. Devices on the public or private LAN must be migrated in order to migrate notification settings. Otherwise, only recipients are migrated. Devices on the public or private LAN must be migrated in order to migrate the data log.
285
Note: If a device is already monitored by the StruxureWare Central server, the data log for that device will not be migrated. Server Settings Server Settings > Users Users must be migrated in order to migrate SOCKS Proxy. InfraStruxure Manager users enabled after migration will be created in the Migrated from InfraStruxure Manager user group on the StruxureWare Central server, with view access to all device groups. InfraStruxure Manager local users disabled after migration will be created in the Unassigned Users group on the StruxureWare Central server. The passwords are not migrated. You can specify a password when you enable the user. InfraStruxure Manager RADIUS users are not migrated to the StruxureWare Central server. When an InfraStruxure Manager SOCKS Proxy user is not also a Local user, a StruxureWare Central Local User is created and enabled during migration. When a SOCKS Proxy user is also a Local user on InfraStruxure Manager, a StruxureWare Central Proxy user is created. The password is not migrated, and the user will be disabled.
InfraStruxure Manager administrator user credentials you provide to the InfraStruxure Manager Migration Utility: When the InfraStruxure Manager authentication method is RADIUS Only, the administrator user credentials are not migrated. When the InfraStruxure Manager authentication method is RADIUS, then Local, a StruxureWare Central Administrator user is created during migration if the local administrator credentials do not already exist on the StruxureWare Central server. The password is not migrated, and the user will be disabled. When the InfraStruxure Manager authentication method is Local Only, a StruxureWare Central Administrator user is created during migration if those credentials do not already exist on the StruxureWare Central server. The password is migrated, and the user will be enabled.
Time Settings When NTP is disabled on the StruxureWare Central server and enabled on the InfraStruxure Manager, NTP and Time Zone settings on InfraStruxure Manager are available for migration.
286
When NTP is enabled on both the StruxureWare Central server and InfraStruxure Manager, only the Time Zone settings on InfraStruxure Manager are available for migration. When NTP is enabled on the StruxureWare Central server and disabled on the InfraStruxure Manager, only the Time Zone settings on InfraStruxure Manager are available for migration. When NTP is disabled on both the StruxureWare Central server and InfraStruxure Manager, Time and Time Zone settings on InfraStruxure Manager are available for migration. The time on the StruxureWare Central is set to match the time on the InfraStruxure Manager. Note: When the time on the StruxureWare Central server and InfraStruxure Manager is less than one minute apart, time is not available for migration. Notification Settings Devices on the public or private LAN must be migrated in order to migrate notification settings. Otherwise, only recipients are migrated. A StruxureWare Central notification policy is created for each device group migrated from InfraStruxure Manager. An alarm action is then created for each recipient with its notification settings. Note: Notification policies are not created for groups containing no devices. Credentials for the APC Remote Monitoring Service (RMS) are not migrated. You must manually enter your RMS credentials in the StruxureWare Central client. The event log feature is not available on the StruxureWare Central server. You can export the InfraStruxure Manager event log as a *.CSV or *.txt file to a location you specify on the local drive. You can add additional license keys, if necessary, to manage nodes migrated from the InfraStruxure Manager, or to access the functionality available in separately-licensed applications. Note: Adding license keys for separatelylicensed applications, such as InfraStruxure Operations, InfraStruxure Change, or InfraStruxure Capacity, may cause the StruxureWare Central server to reboot. APC recommends adding any necessary license keys before using the InfraStruxure Manager Migration Utility.
Use this display to modify InfraStruxure Manager SMTP email settings to meet StruxureWare Central server requirements. The InfraStruxure Manager Migration Utility validates the SMTP settings you want to migrate to the StruxureWare Central server. The "From" address that appears in email from the InfraStruxure Manager must be in a valid format to migrate to the StruxureWare Central server, for example, [email protected].
You click each tab to view the settings and data, and the reason the settings and data will not migrate from InfraStruxure Manager to the StruxureWare Central server. You can click Back to modify your selections, if necessary, or select I understand to continue. Items that will not migrate from InfraStruxure Manager to the StruxureWare Central server include: NetBotz Appliances. Devices that have lost communication with the InfraStruxure Manager. InfraStruxure Protocol devices that do not have SNMP community names in the InfraStruxure Manager Device Access list. These devices must be manually added to the list of devices the StruxureWare Central server monitors. Disable Notifications for Maintenance settings. Devices with notifications disabled for maintenance will be migrated to the StruxureWare Central server with notifications enabled. Historic data from devices monitored by both InfraStruxure Manager and the StruxureWare Central server, or from devices no longer monitored by InfraStruxure Manager. For example, the data log from a sensor that is unplugged will not be migrated. APC Remote Monitoring Service credentials. Existing (RMS) customers must manually enter their RMS credentials in the StruxureWare Central client when migration is complete in order to update RMS with the devices now monitored by the StruxureWare Central server. Note: Devices monitored by the InfraStruxure Manager and RMS that were not migrated must first be added to the list of devices the StruxureWare Central server monitors using the StruxureWare Central Device Discovery wizard.
"Confirmation" display
Use this display to review the details and begin the migration from InfraStruxure Manager to the StruxureWare Central server.
You click each option to confirm the settings and data to migrate from InfraStruxure Manager to the StruxureWare Central server. You can click Back to modify your selections, if necessary.
An InfraStruxure Manager migration status view is available using the InfraStruxure Manager Migration Status option accessed from the Window menu.
Data in the InfraStruxure Manager Migration Status view pertains to the last performed migration. This data remains in the view, and cannot be exported. Subsequent attempts at migration erase the data displayed in InfraStruxure Manager Migration Status view. Element
List
Description
Provides information about the InfraStruxure Manager migration status for an ongoing process.
Message: progress information about the migration. Status: status of the migration.
Minor Differences
In the user interface, the main view, "Device Status" in InfraStruxure Manager, is the Monitoring perspective in the StruxureWare Central client. Device Discovery: Device discoveries are stored on the StruxureWare Central server. Port, timeout, retries, read / write community names, and whether to register for priority scanning are set in the discovery entry. Discoveries can be scheduled to run at a specific time, with any combination of days of the week. Separate discovery processes exist for each of the following types of devices: SNMPv1 devices: APC or third-party devices that use basic SNMP communications. SNMPv3 devices: APC or third-party devices that use secured SNMP communications. NetBotz Appliances (except for the 300, 303, 310, 400, and 410 models). Modbus TCP Firmware Update: The StruxureWare Central server provides firmware updates for APC SNMP devices with Network Management Cards and NetBotz Appliances. The StruxureWare Central server does not automatically check for available updates. A schedule is available to check for firmware updates on a regular basis. You can download a copy of the APC updates catalog (for SNMP devices and NetBotz Appliances) to the StruxureWare Central client, and then import that catalog to the 289
StruxureWare Central server, when that server does not have internet access to the APC updates server. Minor Difference
Column Names
InfraStruxure Manager
System Name Model Name Agent Firmware Contact
StruxureWare Central
Label Model Application Version Contact Name Parent Device Device Groups Type Maintenance Mode
Trap Receiver Model Number Manufacture Date Firmware Hardware Agent Model Name Agent Model Number Agent Serial Number Agent Hardware Agent Manufacture Date Rack
Event Severity
Information, Warning, Critical, Failure, Error Note: The user can customize event severity.
Enable/Disable, including a Enable/Disable only reason and a duration to define how long notifications are disabled before they are enabled automatically. Configuration required Automatic trap forwarding on private LAN, cannot be disabled. Three Note: The StruxureWare Central server can be enabled as an NTP server. Can be configured as an SNMPv1 agent, disabled by default. Supported Any user
Trap Forwarding
Two
SNMPv1 Agent
290
Server Proxy
Enable/disable only
Enable, with an option to disable on addresses you specify, and disable. Manage File Transfer Protocol (FTP) or Secure Copy (SCP) access values for APC SNMPv1 and SNMPv3 devices. No longer required. Configured on individual SNMP devices. No longer available. Replaced by Alarm History view.
FTP Settings
Significant Differences
Product Updates: Product updates for the StruxureWare Central server require a support contract. You must contact APC Support to get the URL for the update file, then use the StruxureWare Central client to perform the update. Localization: The StruxureWare Central server and client are localized to ten languages. BMS Support: The StruxureWare Central server requires a license key to enable Building Management Systems (BMS) support. Port 502 is used to connect a BMS to the MODBUS TCP Output Module. Direct serial connection via MODBUS RTU is not supported. The BMS registers are remapped, with many values using a different scale. For example, in InfraStruxure Manager, divide value by 100; in StruxureWare Central , divide value by 10. Additionally, register maps can be customized.
Notification: Alarm notification is not a separately-licensed StruxureWare Central server feature. The Alarm Configuration perspective provides options used to configure how the StruxureWare Central server reports alarms and threshold violations, and manages alarm actions, for monitored SNMP and MODBUS devices. Notification policies replace the escalation policies available in InfraStruxure Manager, with a significant difference: the ability to escalate and acknowledge alarms is not available. Note: Alert notification for monitored NetBotz Appliances is configured in NetBotz Appliance Configuration, a Device menu option. Reports: Rather than the thirteen pre-defined reports available in InfraStruxure Manager, the Reports perspective in the StruxureWare Central client provides five pre-defined snapshot reports, eighteen sensor-specific sensor history reports, and the ability to create custom sensor history reports. The Reports perspective allows you to do the following: Generate and view snapshot reports and sensor history reports. View sensor history report data in graph-format, summary-format, or table-format. Save sensor history reports and the report criteria. Configure export actions, such as email, FTP, HTTP, NFS, and Windows share. Manage data export scheduling. Alarm History: Rather than the alarm history available in the InfraStruxure Manager Event Log, the Alarm History view in the StruxureWare Central client provides a more detailed view of alarms by device, and allows you to do the following:
291
Specify a date range to broaden or narrow the list, or use the Search feature with the Boolean operators AND, OR and NOT. Export alarm history as a *.txt or *.CSV file. Generate a sensor history report based on the device reporting the selected alarm. APC SNMP Device Configuration: The StruxureWare Central client provides mass configuration of devices in the APC SNMP Device Configuration option of the Device menu. You can copy a configuration from one monitored device, and push it to others, with the ability to select or deselect specific parts of the configuration to send. Alternatively, you can pull the configuration from a device, and create a saved configuration template. The template resides on the StruxureWare Central server, and can be pushed to devices at a later time, with the ability to select some, or all settings you wish to apply. InfraStruxure Proprietary Protocol devices: The StruxureWare Central server supports InfraStruxure Proprietary Protocol devices as SNMP devices, with the exception of first generation power distribution units (PDUs) and AP76xx outlet strips. InfraStruxure Manager uses an APC Proprietary Protocol, also known as the InfraStruxure Protocol, to monitor power distribution units (PDU) and rack PDUs on its APC LAN (private LAN), or to authenticate access to newer rack PDU versions on its User LAN (public LAN). Except for the newer rack PDU versions, APC Proprietary Protocol devices typically reside on the private LAN only. Note: If the SNMP community names for InfraStruxure Protocol devices are not in the InfraStruxure Manager Device Access list, these devices will not successfully migrate to the StruxureWare Central server. Significant Difference
Server Backup/Restore User Authentication Administrator Accounts LAN Settings - Public
InfraStruxure Manager
Backup to FTP site only RADIUS; Local users One Administrator LAN
StruxureWare Central
Backup to NFS or Windows share OpenLDAP, Active Directory; Local users Multiple Administrator users LAN1 Note: Allows a tertiary DNS server. Does not allow configuration with a DHCP server. LAN2 A second private network (LAN 2 Network B) is available for devices on the private LAN with static IP addresses. Configure the IP address, subnet mask, and IP address range. Enable/Disable DHCP Enable/Disable DHCP discovery. Apply timezone offset to private devices via DHCP. Modify read/write community names.
APC LAN
292
Reset APC devices manually. Email, SMS, Data to FTP server, HTTP post, SNMPv1 trap, or SNMPv3 Inform Alarm action is scheduled as enabled or disabled to send notifications.
293
Surveillance feature
Surveillance is a license key-based upgrade designed for use with the StruxureWare Central server. This feature enhances your ability to use the Camera Pods and CCTV Adapter Pods associated with monitored NetBotz Appliances for surveillance purposes. Note: The help for this feature assumes a Surveillance license is registered with the StruxureWare Central server, and the license has been enabled for each camera. Users must be assigned Device Group Monitoring View Access or higher to view NetBotz Appliance camera images and clips in active and historical alarms. Users must be assigned Device Group Surveillance View Access or higher to view and export surveillance clips. With the Surveillance feature and cameras licensed, you can do the following: View live feeds in the Thumbnails view for all cameras associated with the NetBotz Appliances in a group selected in the Device Groups view. View live feeds in a Camera view for a camera selected in the Thumbnails view. Retrieve, view, and export recorded clips. Configure the capturing and recording of clips. Stream audio to and from properly configured cameras.
294
Surveillance perspective
This perspective provides ready access to the surveillance views, features, and configuration settings. It is accessed by clicking the Surveillance button located directly below the Alarm Configuration menu.
295
Note: All surveillance functions can be performed from the Monitoring perspective, by adding the Thumbnails view to that perspective (select Thumbnails, the Surveillance option in the Window menu). By default, two views appear in the Surveillance perspective. These views, along with Surveillance Settings, a Device menu option, allow you to perform all StruxureWare Central server surveillance functions. Device Groups view: used to select which group will have information about its associated NetBotz Appliance cameras displayed in the Thumbnails view. Thumbnails view: displays live-feed views for all cameras associated with the selected device group. Note: Each thumbnail can access a Camera view that displays a live-feed view for the selected thumbnail's camera only.
Thumbnails view
This view shows all of the cameras assigned to a selected device group. Each thumbnail shows a low frame-rate, real-time feed from a camera. When a thumbnail receives a new frame, it is highlighted to show any activity that happened for that camera for that frame. Note: If a NetBotz Appliance is mapped to an external share drive, a Store Data on NetBotz Appliance option is available in the "Surveillance Settings" display for each camera associated with that appliance. If that option is selected for a camera, its Thumbnail view cannot update, as thumbnail data cannot be sent to the StruxureWare Central server. However, its Camera View will still provide real-time video, and its clip data, which is stored at the external share drive at the NetBotz Appliance, can still be accessed by the StruxureWare Central server. All surveillance features, including all configuration settings that affect surveillance, can be accessed from this view using its thumbnails, right-click options, and button icons. 296
Note: Which thumbnails are displayed depends on which group is selected in the Device Groups view. In addition, an unlicensed camera will have a grayed out image showing where the camera is pointing, with a prohibited symbol that indicates the camera will not function until it is licensed, and when the StruxureWare Central server has lost communication with a camera, the thumbnail will be black with a grey x. Access the "Surveillance Settings" display to configure one or more cameras (select Surveillance Settings in a right-click menu for a selected camera's thumbnail). Note: Surveillance Settings in the Device menu allows you to configure cameras for all device groups; Surveillance Settings in the Device Groups view allows you to configure cameras for a selected device group; Surveillance Settings in the Camera view allows you to configure one camera for a selected device group. Access the "Camera Settings" display to configure the cameras at the monitored NetBotz Appliances (select NetBotz Appliance Camera Settings in a right-click menu for a selected camera's thumbnail). Access the "Recorded Camera Clips" display to retrieve, view, and tag clips for a selected camera (select Retrieve Clips in the thumbnail's right-click menu, or use icon). the Double-click a thumbnail to access its Camera view (or select Open Camera View in the thumbnail's right-click menu). Use the Change Resolution icons ( ) to select to display small ( 160x120) or large ( 320x240) thumbnails. ) to select whether the thumbnails Use the Toggle Extra Thumbnail Borders ( include a border. Use the Configure Thumbnail Details icon ( ) to define what information is included with the thumbnails. Sort the thumbnails by the type of information that can be provided with the thumbnails (use the icon to access the "Sort Surveillance Thumbnails" display}. Use the Search and Clear elements to filter the Thumbnails view to display only the thumbnails that include your typed text. Access the "Device Launch Settings" display to define the settings used to access the web interface at a selected camera's NetBotz Appliance (select Device Launch Settings in the thumbnail's right-click menu). Launch to the web interface at a selected camera's NetBotz Appliance (select Launch to Device in the thumbnail's right-click menu). View the Device View listing for a selected camera in the Monitoring perspective (select Show in Monitoring Perspective in the thumbnail's right-click menu). Log on to the Advanced View interface at a selected camera's NetBotz Appliance (select Launch Advanced View in the thumbnail's right-click menu). Note: This option is enabled by Advanced View Settings, a Client Preferences option in the File menu.
297
Icon
Description Click the chevron associated with this icon to select to display small ( 160x120) or large ( 320x240) thumbnails. Click this Toggle Extra Thumbnail Borders icon to select whether the thumbnails include a border. Click this Sort By icon to access the "Sort Surveillance Thumbnails" display, which allows the user to choose the criteria for sorting the displayed thumbnails. Click this Retrieve Clips icon to access the "Recorded Camera Clips" display for the selected cameras. Click this Configure Thumbnail Labels icon to select the camera-associated data to display under each thumbnail. Pod Label Hostname Location Status Licensed Model Device Groups Camera Label
Description
Sort by Pod Label. Sort by Location. Sort by Status. Sort by Camera Label. Sort by model number of the camera's NetBotz Appliance. Sort by IP address or hostname.
Sort by which cameras are detecting motion, and for how long. For example, three cameras (X, Y, and Z) are detecting motion, Camera X for five seconds, Y for four seconds, and Z for three seconds: Camera X is in the first position of the Thumbnails view, Y in the second, and Z in the third; if Camera X stops detecting 298
motion, it moves to the last position, Y moves to the first position, and X moves to the second. Note: This option, which is the default option, is helpful if you want to focus your attention on cameras that are currently showing activity.
Licensed Device Groups Sort by license status. Sort by the device groups to which the cameras are assigned. If a camera is assigned to multiple groups, the camera is sorted according to the first device group listed.
Element
Pod Label Location Status Camera Label Model Hostname Licensed Device Groups
Description
The label that identifies the pod. The location of the camera, if known. The status of the camera: Online or Offline. The label that identifies the camera. The model number of the camera's NetBotz Appliance. The IP address or hostname. The license status. The device groups to which the cameras are assigned.
Camera view
Displays a real-time view of the camera feed along with information about the selected NetBotz Appliance. The Camera view consists of two areas, the displayed real-time feed from the selected device, and a Camera Information area. The Camera Information area contains Pod Label, Camera Label, Hostname, Location, Status, Licensed, Model, and Device Groups information for the camera. The following icons are located on the upper right-hand side of the view: Icon Description Click this Listen icon to hear the accompanying audio stream for the selected device. 299
Icon
Description Note: Disabled when no audio is available. Click this Talk icon to send audio to be played at the device. Note: This feature is only available on certain models and requires a microphone on the user's side, and a set of external speakers on the device side. Click the chevron associated with this Change Resolution icon to select the resolution you want to use to display the real-time feed for the selected camera. Click this Retrieve Clips icon to view, tag, export, and delete existing surveillance clips.
You can use the right-click menu in the real-time feed area to do the following: Access the "Recorded Camera Clips" display to retrieve, view, and tag clips for the camera ( Retrieve Clips option, or use the icon). Access the "Surveillance Settings" display to configure the camera ( Surveillance Settings option). Note: Surveillance Settings in the Device menu allows you to configure cameras for all device groups; Surveillance Settings in the Device Groups view allows you to configure cameras for a selected device group; Surveillance Settings in the Thumbnails view allows you to configure selected cameras for a selected device group. Access the "Device Launch Settings" display to define the settings used to access the web interface at the camera's NetBotz Appliance ( Device Launch Settings option). Launch to the web interface at the camera's NetBotz Appliance ( Launch to Device option). Log on to the Advanced View interface at the camera's NetBotz Appliance ( Launch Advanced View option). Note: This option is enabled by Advanced View Settings, a Client Preferences option in the File menu. View the Device View listing for the camera in the Monitoring perspective ( Show in Monitoring Perspective option). Access the "Camera Settings" display to configure the camera at the monitored NetBotz Appliance ( NetBotz Appliance Camera Settings option).
Two-Way Audio
When connected to a device capable of capturing and broadcasting sound, you can transmit sounds to and from the device through the StruxureWare Central server. You can use the Camera view controls to stream audio from camera pods that have microphones, and to use a microphone connected to your system to send audio to camera pods that have connected speakers. Note: For two-way audio to work, the camera must be able to connect directly to the client on a public accessible network.
300
To listen to streaming audio from the currently selected Camera Pod (if available) click the button. Note: More than one client can listen to the audio stream simultaneously. To transmit audio from your system to speakers that are connected to the selected Camera Pod, click the button while speaking into your system's microphone. button is depressed.
While the button is depressed you will not be able to hear audio that is streaming from the target Camera Pod. While the button is depressed it will lock the audio transmission so only your client can send audio to the selected camera pod.
301
Select Surveillance Settings in the right-click menu for a selected camera's thumbnail, when multiple thumbnails are selected in the Thumbnails view, to configure those cameras. Select Surveillance Settings in a device group's right-click menu to configure cameras for that device group. Select Surveillance Settings in the Device menu to configure cameras for all device groups.
These settings are used by the StruxureWare Central server to manage the selected camera or cameras. They configure the server's behavior with regards to a camera.
Element
License Camera
Description
Select this option to apply an available Surveillance license to each selected camera.
If you deselect this option, the selected camera's surveillance is disabled, and its license can be used to enable surveillance for a different camera.
Note: A status message appears when there are not enough surveillance licenses available for the selected cameras. Thumbnail Activity Timeout (seconds) Define how long a selected camera's thumbnail will be highlighted before returning to normal when a motion is detected: the minimum is 10, the maximum is 120, and the default is 30. Select to include the audio stream from a camera saved with that stream's relevant image clips (not selected, by default). Note: The camera must be configured to send audio; otherwise, this option is not available.
Include Audio
If the camera is not configured to always send audio, only white noise will be recorded if Include Audio is selected. The camera setting can be accessed through the APC NetBotz Advanced View application.
Generate Digital Signature Select to generate a digital signature when a surveillance clip is archived. Note: Digital signatures are designed to ensure that the signed media has not been altered in any way. Select to have camera data stored at the share drive mapped at the camera's NetBotz Appliance, instead of at the StruxureWare Central server.
302
When selected, the Camera View, which provides a real-time feed, will continue to operate properly, and clip data, which is stored at the external share drive at the NetBotz Appliance, can still be accessed by the StruxureWare Central server; however, the Thumbnail view for the camera cannot update while this option is selected. Note: This option is available only when a NetBotz Appliance that supports using an external share drive for storage is mapped to a such a drive.
Server Settings
These settings are used to identify the StruxureWare Central server (the current server, by default) to which data from a selected camera or cameras will be sent, and to define Port and SSL Options used to communicate with that server. Note: A "Server settings unavailable when cameras are on both the Public Network (LAN1) and the Private Network (LAN2)" appears in this section when configuring multiple cameras using "Surveillance Settings" display, and some of those cameras are on the Private LAN, and some on the Public LAN. You cannot assign Private LAN server settings to a Public LAN camera, and vice versa. Element
StruxureWare Central server
Description
Identify the name of the StruxureWare Central server where data from the selected camera will be sent.
Note: By default, the name of the current StruxureWare Central server is provided.
Port Identify the port used by the server to connect with the selected camera.
80 is the default value for HTTP communication when the Connect using SSL Option is disabled. 443 is the default value for HTTPS communication when the Connect using SSL Option is enabled.
Note: The port number must match the port number defined in the identified StruxureWare Central server's Web Server tab for Server Access, a Server Administration Settings option in the System menu. Otherwise a NetBotz Appliance associated with the selected camera or cameras cannot send surveillance data to the server successfully. Connect Using SSL Select to have the server use the Secure Sockets Layer (SSL) protocol when communicating with the selected camera (not selected, by default).
303
SSL Options
Select the method of verification to be used when licensed cameras attempt to connect to the server using the SSL protocol.
No Verification: requires SSL support on the server (do not send data without it), but accepts any certificate provided by the server (i.e. self signed certificates will be allowed). This is the default setting. Verify Certificate: requires SSL support on the server (do not send data without it), and only accepts certificates signed by a trusted certificate authority (i.e. self signed certificates will not be allowed, but Verisign and the like certificates will be accepted even if the hostname does not match the host in the certificate). Verify Certificate and Hostname: requires SSL support on the server (do not send data without it), and only accepts certificates signed by a trusted certificate authority and which contain a hostname matching that used to contact the server (i.e. only certificates issued by trusted sources and which contain the same hostname as used to access the server are allowed).
Note: Disabled when Connect using SSL is not selected.
These settings control how the StruxureWare Central server responds to motion detected at the selected camera or cameras.
Element
Post Mode
Description
Select when clip images (and, optionally, audio) from the camera will be stored on the server.
Send on Motion Detected the camera will send clips to be archived whenever its motion sensor is activated (the default selection).
Send Continuously During Alerts : the camera will send clip images to be stored whenever an alert triggers the camera. Send on Motion Detected During Alerts : the camera will send clip images to be archived if motion is detected during an alert.
304
Camera Resolution
Note: The available sizes depend on the capabilities of the selected camera, with larger image resolutions requiring increased amounts of storage space.
Target Image Capture Rate Set the number of frames per second to be recorded when a clip is captured (1 frame per second, by default). Set the amount of delay between the start of an event and the beginning of a clip's capture. Click to use the "Surveillance Scheduling" display to specify when the camera is enabled and disabled (always enabled, by default).
Disabled:
The Disabled option prevents data from the camera from being archived, even during an alert. You may want to set a camera to Disabled if you need to temporarily disable capture on a camera for a non-repeating interval of time. Note: If you want to disable capturing for a repeating interval of time, you should use the Surveillance Scheduling option on the "Surveillance Settings" display.
Note: An alert can result in a camera's surveillance data being continuously sent only when that alert is in response to an alert threshold which has that camera selected by that threshold's Camera to Trigger option. Surveillance events created using the Send Continuously During Alerts mode do not rely on detected movement to determine whether an image should be captured and added to the surveillance clip. Therefore, the resulting clip may be more consistent in terms of time continuity, enabling you to more easily judge the amount of time that passes between movement that occurs in view of the camera. Note: You may not want to use this setting with alerts that are set to Return to normal requires user input. If a delay occurs before the alert is resolved, this setting can generate very large clips. You can use the Send Continuously During Alerts mode under the following circumstances: You are in a high security environment where you are required to have a complete audit record of all time-stamped images (including those with no detectable changes) while sensors, such as the door switch, camera motion sensor, or external dry contacts are triggered. You need to monitor for situations in which the rate or size of the changes in the images may be too small to be detected reliably by the motion sensor capabilities of the device camera (i.e. the blinking of a small light, a person moving very slowly at a distance from the camera). You prefer the time interval between frames to be approximately steady (more "realtime"), as opposed to variable (as is the case with motion based), without the frame count limitations of the alerts being an issue.
306
you could create a record of people entering and leaving a facility between the hours of 8:00PM and 6:00AM, for example, while ignoring entries and exits that occur during normal business hours. You want to create a visual record of a room that has been entered illegally, such as by breaking a window that has a dry contact glass break sensor attached to it or by opening a door that is supposed to be used for emergency exits only. You want to record images while a transparent rack or equipment room door is open (thereby triggering the Door sensor alert), but do not want to record movement seen though the door while it is closed.
Surveillance clips
Surveillance clips are generated as a result of detected motion, alarm, or motion and alarm, depending on how surveillance for each camera is set up. Surveillance clips have the ability to be much longer in length, and larger in size, than camera capture clips for alarms: surveillance clip settings (such as resolution and frame rate) are independent of the camera capture settings for alarms. Inactivity (no motion) of 10 seconds or more will cause a new clip to be created the next time motion is detected. Inactivity of less than 10 seconds, will add new frames to the current surveillance clip. The settings that control the generation of surveillance clips are located in the "Surveillance Settings" display accessed by the Surveillance Settings options in the Device menu, right-click menu in the Device Groups view, or right-click menu in the Thumbnails view. Note: The settings that control the generation of alarm clips are controlled by the Alarm Capture Data option in the "Capture Settings" display, a display accessed by Camera Settings, a NetBotz Appliance Configuration option in the Device menu and the Device Groups view right-click menu, or by NetBotz Appliance Camera Settings, a right-click menu option in the Thumbnails view. 307
Surveillance clips are stored on the StruxureWare Central server and can be tagged with metadata that allows users to search for specific clips. The location where the server stores clips is defined using Storage Settings, a Server Administration Settings option in the System menu. The size of a surveillance clip is based on the resolution and frame rate of the camera that generated it. These settings are controlled by a camera's "Surveillance Settings" display settings. You may export clips in AVI, Signed AVI, or MPEG-1 formats. You can also export the currently viewed image as a JPG file. If audio data for a clip exists, it must be exported to a separate file.
Digital signatures
NetBotz devices provide the capability to attach a digital signature to the generated clip. This signature is used by the verification utility to determine if any tampering with the clip occurred. If a clip has a digital signature attached to it, the Is Signed column in the clip listing pane of the "Recorded Camera Clips" display reports Yes, and the "Clip Viewer" display will show the digital signature icon ( ) in color.
StruxureWare Central ships with a Windows batch file and a Linux script located at the root directory of the StruxureWare Central application that can authenticate the existence of a clip's digital signature. Both are run using the same syntax structure: Windows: avivrfy.bat avi1 avi2 avi3 Linux: avi-verify avi1 avi2 avi3 This syntax allows you to check multiple AVI files by including each file's name in the command line, with a space separating each name. When the verification utility is run, it returns a message for each file that states whether the digital signature is valid.
Audio support
Audio can be captured from camera devices equipped with audio sensors. Audio data is stored in the OGG Vorbis codec file format, with an.ogg file extension. You need an audio player that supports this file format in order to play back the exported file. Note: If your media player cannot play the.ogg file format, you may need to download an additional codec to support the audio file format. Consult your media player help or documentation for details on installing additional codecs.
This display only retrieves clips for the camera or cameras associated with the Retrieve Clips right-click menu option or icon ( 308 ) used to access it.
The cameras selected in the Thumbnails view when the Retrieve Clips option or icon is used (the display's description identifies the selected cameras). The cameras in the group selected in the Device Groups view when the Retrieve Clips option or icon is used (the display's description identifies the selected device group). The display has three areas, each with elements that provide for a specific function: a retrieve clips section, a select clips section, and an Overview.
Retrieve clips section
This section consists of the elements used to identify and retrieve the clips for a specified Choose Date time frame, and when Search by Tag is enabled, limit the clips to those that match the provided Tag/Description information. Element
Choose Date: Relative
Description Enables searching by relative time to the current time. The available values are: Last Hour, Last 6 hours, Last 12 hours, Last Day, Last Week, Last Month, This Day, This Week, This Month. Values that start with "Last" use the current time and date and search backward for the specified time period. Values that start with "This" use the current date and search the corresponding time period that matches the criteria. For example, if the current date and time is February 22nd at 4:00pm, and you select Last Month, you will get all surveillance clips recorded since January 22nd at 4:00pm. If you selected This Month, you would see a listing of all clips recorded since February 1st at 12:00am. The Relative setting defaults to Last Hour. Note: The weekly period begins at 12:00am on Sunday and ends Saturday night at 11:59pm.
Enables searching for recorded clips during the dates identified by Start Date and End Date. The Start Date is the earliest date that will be checked for clips. The End Date is the most recent date that will be checked for clips.
Note: Both the Start Date and End Date default to the current date.
Tag/Description
Select to search only for clips that include the typed tag data or clip descriptions, that were recorded during the Choose Date time 309
frame, for the cameras selected when the "Recorded Camera Clips" display was accessed. For example, typing "fan" will retrieve only clips that have tags or descriptions that contain "fans", "cooling fans" "heating fan", etc. recorded for the selected cameras during the defined time frame. You can select a tag from the drop-down menu to the right of the text field which lists all the tags added to recorded clips for the selected cameras.
Retrieve Clips Click Retrieve Clips to search the repository for all clips that match the currently selected criteria.
This section lists the clips that were retrieved as a result of the current search, and allows you to view, tag, or export one clip at a time, or delete one or more clips. Clips can be sorted by clicking any column heading. Action Button
List
Description Lists and provides information about the retrieved clips. Camera: camera associated with the clip. Start Time: date and time the clip started. Duration: how much time the clip involves. Frames: how many frames the clip contains. Tags: any tag assigned to the clip. Is Signed: whether the clip is signed or not. Has Audio: whether audio is associated with the clip.
View
Click to use the "Clip Viewer" display to view, tag, or export the clip selected in the list.
Click to use the "Edit Clip Tags and Description" display to enter information into the Tag and Description fields for the clip selected in the list. Click to use the "Export Clip" display to export the clip selected in the list in an MPEG-1, AVI, Signed AVI, Current Image, or Audio format. Click to delete the clip or clips selected in the list.
Tag
Export
Delete
Overview section
This area displays provides a thumbnail for the clip selected in the list, and provides any tag or description associated with that clip. 310
Area
Clip Thumbnail Tag Area Description Area
Description Displays a small version of the first frame of the clip selected in the list.
Displays tag information, if any exists. Displays description information, if any exists.
Element
Camera Information
Description This area at the top of the display provides the following information: Pod Label: the label that identifies the pod. Camera Label: the label that identifies the camera.
View Pane
Play/Pause (
and
Click the Play icon to start the clip; click the Pause icon to pause the playback on the current image. You may begin playing the clip during the load sequence, if you desire.
Drag the control left or right to find a specific frame within the clip. The number to the right of the bar shows the currently displayed frame. You also can click the up and down arrows to the right of the slider bar to advance or rewind the clip by a single frame. The beginning and ending date and time of the clip are displayed below the slider bar.
Click this icon to access the "Export Clip" display. Click this icon to access the "Edit Tags and Description" display. If there is audio associated with the current clip, this icon is displayed in black; if there is no audio, the icon is grayed out. ) If the clip has a digital signature associated with it, this icon is displayed in color; if the clip is unsigned, the icon is grayed out. Displays the loading status of the selected clip: Loading or Loading Complete.
Displays the following information about the current clip: Total Frame Count 311
Use this display to add text strings to surveillance clips as a Tag or Description. Text contained in the Tag or Description fields can be used as search criteria when attempting to retrieve a specific clip. Text Fields
Tags
Description
Enter text into the Tags field to associate the data with the selected clip as metadata. This data can be used to refine future searches to only clips containing the appropriate keywords.
Description
The Description field can be used to enter a longer description of the contents or context of the clip. The contents of the description field can be searched on from the "Recorded Camera Clips" display, but will not be listed in the drop-down list of available tags. Note: The Description field cannot be longer than 65536 single-byte characters.
Use this display to export the selected clip in an MPEG-1, AVI, Signed AVI (if the digital signature option is enabled), Current Image, or Audio format. Note: This display can be accessed from the "Clip Viewer" display, or from the Clip option in the "View Alarm Details" display available for the Active Alarms and Alarm History views, using the Export Clip icon ( Element
Data Format
). Description Use to select the desired format as the output type. MPEG-1 Note: Disabled when a clip consists of a single frame. AVI Signed AVI (see below) Current Image Audio The Signed AVI format is only available if the clip was captured by a camera with the Generate digital signature option in the "Surveillance Settings" display enabled. Note: The Signed AVI option is only available if the NetBotz Appliance has the
312
optional Premium Software Module installed. If the Current Image option is selected, the currently displayed frame will be saved as a JPG file. When clips are recorded, the images and audio are saved as separate files. Therefore, an exported clip cannot contain both image and audio data. The audio can be saved to a separate file by selecting the Audio option. Note: If a clip contains audio data, but the audio capture option on the remote device was not activated, only white noise will be recorded.
Filename Use to set the location and the filename of the exported clip.
313