RIG Admin Guide

1. Introduction

The Nectar Remote Intelligence Gateway (RIG) is a client-site monitoring and reporting appliance, which is part of Nectar Foundation APM.

The RIG is a device that is deployed at the client premise and serves multiple roles:

• Interrogation engine interacting with equipment at the client-premise targeted for management
• Local (client-premise resident) repository for event data, performance feeds, and Business Intelligence Monitors
• Aggregation point for disparate alarming sources into a common event structure
• End-client dashboard host where business level management views can be pushed to the client for client-premise/network-based access
• RIGs can also host engineering tools and be remotely accessed to allow responders a launch point from within the client’s premise, ensuring smooth and accurate use of responder tools.
• Optional Enterprise Intelligence Platform (EIP) registration for consolidated single sign-on, global views for multi-RIG deployments. For more information, see the EIP Administration Guide.
• Optional Central Intelligence Platform (CIP) registration of the client premise or client network to an external service provider where the Nectar Foundation APM is being used to facilitate third-party service provider support and remote access. For more information, see the CIP Administration Guide.

This section provides the following information:

• About this Guide
• Audience
• Supported Software Versions
• Technical Notes
• General Data Protection Regulation
• Technical Support
• Product Documentation
• RIG Specification
• Network Ports
• RIG Maintenance

1.1 About this Guide

This guide provides instructions on software administration, configuration, and concepts relating to Nectar Foundation APM, including using the Nectar RIG Client, administering security for groups and users, organizing system access and permissions, configuring network monitors, managing dependency trees, and much more.

1.2 Audience

This guide is intended for system administrators or engineers who have a background or knowledge in the delivery of managed services, infrastructure management and monitoring, and/or Unified Communications (UC) with system administration access and a broad working knowledge of Nectar Foundation APM.

1.3 Supported Software Versions

• Nectar Foundation APM v8.7

1.4 Technical Notes

Important: After upgrading to v8.7, if you have or plan to manipulate a properties file that uses a file path or directory, then you must verify that you are using the proper backslash (\) or forward slash (/):

• Windows:

Use double backslash (\\), for example, <drive>:\\<folder>\\<folder|file> or Use single forward slash (/), for example, <drive>:/<folder>/<folder|file>

• Linux/iOS:

Use single forward slash (/), for example, /<folder>/<folder|file>

1.5 General Data Protection Regulation

You must upgrade to ‘Release 7.2 or later’ to enable the new General Data Protection Regulation (GDPR) audit logging. Logging is enabled by default but can be customized to suit your specific auditing needs. The Apps\<partner name>\etc\log4j2.xml file is used to enable that customization after the upgrade to ‘Release 7.2 or later’.

The upgrade to ‘Release 7.2 or later’ will back up your existing log4j2.xml file before installing the new version of that file.

If you have previously customized the log4j2.xml file, you will have to manually migrate those changes to the new log4j2.xml file. Your previous version can be accessed by navigating to Apps\<partner name>\rollback\etc\log4j2.xml AFTER you have upgraded.

1.6 Technical Support

For technical support, contact Nectar in one of the following ways:

• Nectar technical support email address: support@nectarcorp.com
• Visit http://www.nectarcorp.com for additional information. Use your company’s login information to access the documentation.

1.7 Product Documentation

• For additional information, see:

  CIP/EIP Administration Guide

  Installation Guide

  Perspective Administration and User Guide

  External Authentication Administration Guide

• These documents can be found on the Partner Hive:

  https://nectar.seismic.com/directlogon.aspx

• To provide feedback on Nectar documentation:

  documentation@nectarcorp.com

1.8 RIG Specification

For more information, see Nectar Appliance Guide.

1.9 Network Ports

The following is a list of network ports related to RIG communications and/or Perspective:

Table 1-1 Network Ports

1.10 RIG Maintenance

Use the following best practices to maintain RIG health:

• Perform a 60-90 day reboot cycle.

• Backup RIGs regularly.

• Apply Windows Security updates manually when released by Microsoft.

• Keep Nectar RIG software up to date (coordinated by or through the Partner, if applicable).

  RIGs should be installed with the latest software release or a release that is no more than one major release behind the current GA release. Patch releases should be reviewed to determine if any issues are needed on the current software platform.

• Schedule monthly reports for disk and CPU utilization via the Nectar RIG.

  By default, data is maintained for a month. However, reports should be retained for 12 months to provide a tracking of increased usage.

Note: The system will send an alert, if the CPU or disk utilization goes above 90 percent. These alerts should be addressed when they are received. Contact Nectar Support, if the CPU utilization remains above 90 percent.

• Ensure Nectar RIG is kept up to date with any infrastructure changes, such as IP addresses, new hardware, etc.

2. Definitions

• Central Intelligence Platform: The CIP is a server cluster provided by Nectar in a hosted data center facility that is dedicated to a business partner or service integrator. The CIP houses registration and communication proxy systems that allow service provider responders to receive alarms, securely connect to end-client deployed premise equipment (RIGs) for passing commands, and subscribe to information channels between the service provider responder and that location. For large enterprise deployments, Nectar Foundation can also provide a hierarchical system comprised of multiple EIPs.

• Client Application: The Client Application (CA) component allows for full use of bi-directional SRSTP control. Application extensions are allowed to initiate new information channel subscriptions that are ready for broadcast from RIGs or Distributed Agents (DAs). CA also allows for the switching of registration between multiple sources, such as a CIP, a deployed client RIG, and/or a DA. The CA is dynamically loaded to a user’s system via a standard web browser that facilitates loading and communicating CA on the user’s system. CA is a graphical interface that connects to multiple Nectar systems, including but not limited to CIP, EIP, RIG, and DA, which are included in the applicable core platform product.

• Client Portal: Different from the CA, the Client Portal (CP) (dashboard) is used to only push views. CPs are typically deployed to allow clients visibility to key metrics of the infrastructure being managed. For example, bandwidth utilization on key network connectivity points, concurrent call server registrations, digital signal processing utilization, and element host health statistics (memory, CPU, disk, network interfaces, etc.). CPs are customizable to fit the needs of the client and deployment, ensuring usefulness and securing vital desktop real estate with the client's management staff, further promoting the value of the overall solution. CP can be launched from CIP, EIP, and RIG, which are included in the applicable core platform product.

• Dependency Tree System: Nectar Foundation APM has the ability to identify the relationships of disparate silos of technology, events, and data. Dependency trees are the underlying system that enables such correlation within the platform. These trees can be automatically generated by a specific VKM or knowledge script and adjusted to fit the actual deployment environment, or manually created to illustrate in real-time the complex relationships between different and dependent technologies.

• Enterprise Intelligence Platform: The EIP is a system module that is typically deployed on a separate server with the option of an HA cluster. The EIP contains registration and communication proxy systems. It provides users with a centralized, consolidated, global single sign-on view for environments that have multiple RIG deployments or must run the Nectar Intelli-Q module.

  The EIP enables global dashboards, which act as a launch point or provide a consolidated view of customer dashboards from multiple downstream RIGS. The dashboards also provide centralized alarming of all RIGs.

  Users/responders can also use the EIP to:

  • Securely connect to downstream RIGs

  • Pass commands

  • Subscribe to information channels between user/responder and the equipment to which a RIG is providing proxy access

    For large enterprise deployments, Nectar Foundation APM can provide a similar hierarchical system that enables EIP to connect to an external CIP. This is typically housed in a service provider network.

• Maps: Maps provide a unique mapping function of the Nectar MSP that allows for live, alert driven visual notifications. iMaps can contain performance feeds, business process status, events, and topology shift notifications. Feature is included in the applicable core platform product.

• Perspective Agents: Perspective agents (PAs) are restricted agents used to conduct synthetic transactions with other PAs and DAs enabled with Nectar’s Perspective feature and distributed network sniffer applications. PAs are deployed either as Master Perspective Agents or Distributed Perspective Agents and automatically register back to the Perspective Controller. PAs are often distributed throughout building and data center network infrastructure layers, Lync Front End and Edge Server locations and other distributed architectural points to create hub and spoke, and mesh synthetic traffic generation measurements.

• Perspective Controller: Perspective is a synthetic traffic generation solution designed to simulate voice traffic patterns consistent with several codecs including but not limited to G711, G729, and G722. Perspective delivers an advantage in network pre-assessments, voice quality troubleshooting and proactive problem identification through its unique capability in generating RTP and UDP traffic. RTP and UDP traffic patterns can include a single source to multiple destinations, multiple sources to multiple destinations and/or a full mesh of traffic. Unlike many traditional synthetic engines, Perspective truly simulates a voice experience, which is customizable and able to detect degradation stemming from Route Trip Delay (RTD), Jitter, Packet Loss, and its effects on MOS (Mean Opinion Score). Additional features include end-to-end DSCP marking validation and path change notification. The Perspective Controller is installed/enabled on a RIG and the central console for management, configuration and ennoblement of Perspective Agents.

• Remote Intelligence Gateway: The Nectar RIG is a client-site monitoring and reporting appliance, which is part of the Nectar Foundation APM. The RIG is a device that is deployed at the client premise and serves multiple roles:

  • Interrogation engine interacting with equipment at the client-premise targeted for management
  • Local (client-premise resident) repository for event data, performance feeds, and Business Intelligence Monitors
  • Aggregation point for disparate alarming sources into a common event structure
  • End-client dashboard host where business level management views can be pushed to the client for client-premise/network-based access
  • RIGs can also host engineering tools and be remotely accessed to allow responders a launch point from within the client’s premise, ensuring smooth and accurate use of responder tools.
  • Optional: EIP registration for consolidated single sign-on, global views for multi-RIG deployments
  • Optional: CIP registration of the client premise or client network to an external service provider where Nectar Foundation APM is being used to facilitate third-party service provider support and remote access

• Secure Remote Session Transport Protocol: The Secure Remote Session Transport Protocol (SRSTP) is a hybrid communications protocol consisting of an information bus and proprietary transport protocol. SRSTP allows for secure registration of platform components between and amongst themselves and the passing of commands and data where allowed or authorized. The communications bus is designed in a publish and subscribe manner similar to electronic trading platforms found in modern financial markets. SRSTP allows for many client-bound sessions to simultaneously exist, promoting collaboration capabilities from responders to co- resolution or training purposes.

  RIGs deployed in the customer premise connect to the CIP/EIP using SRSTP tunnels. In a standard deployment, the RIGs connect directly to the CIP/EIP. This connection can be routed through a SOCKS proxy when required.

• Vendor Knowledge Modules: The Vendor Knowledge Module (VKM) provides in-depth monitoring and management of UC infrastructure, applications, quality and services inclusive of broad, deep, dynamic polling and reporting functionality, with increased automated process capabilities. Key features include auto discovery, auto dependency tree generation, inventory, reporting, predefined dashboards or dashboard components for visualization, and leverage interrogation mechanisms for performance and health.

  To visually depict these co-dependent components, the VKM creates dynamic dependency trees, eliminating the guesswork and delays in root-cause analysis while providing business- level reporting and deeper perspective of trending and analysis.

3. Nectar RIG Client Overview

The Nectar RIG Client is a Java application that is delivered through WebStart technology. To use the client on a machine, make sure that Oracle Java is integrated with your web browser.

Note: You can test your browser for Java support or download a run-time copy of Java for your machine by visiting Oracle’s Java website:

https://java.com/en/ Follow the directions to install the Java environment in your web browser.

This section provides information about the following:

• Launch and Log In Using the Nectar Client
• Summary View
• Command Buttons
• Menu Bar
• Status Bar
• Status Summary
• System Tray Icon

3.1 Launch and Log In Using the Nectar Client

Follow these steps to launch and log in using the Nectar client:

1. To launch and log in using the Nectar Client to the CIP or EIP, open your Java-enabled browser and enter the URL provided by the Nectar Administrator:

   http://[your_company_name]-cip1.nectarvoip.com

2. To launch and log in using the Nectar client, a RIG only implementation, open your Java- enabled browser and enter the URL provided by the Nectar Administrator:

   http://[RIG Host name or IP Address]

   Java uses the link to download a description file; then downloads the support files that comprise the client application. The files are cached on the local computer, so subsequent application launches take less time.

Note: You may start subsequent client application launches directly from your local computer using the Java WebStart Viewer application. However, if you launch your client application session from the URL, you automatically receive new updates to the client application.

The Nectar Portal Login window appears:

Figure 3-1 Nectar Portal Login

3. Enter your Username and Password.
4. Click the drop-down arrow and select a location server.

Note: Use the Location field to connect to different servers/systems. However, the Location is automatically set to the correct location server, if you launch from a URL.

5. From the Nectar Portal Login window, select one of the following check boxes, as needed:

   • Click Remember Login, if you want the Nectar client to remember your Username and Password.

     Next time you log in, your Username and Password will automatically appear in the designated fields.

   • Click Login Automatically, If you want to log in automatically (and skip the Nectar Portal Login window).

6. Click Login.
7. In the Location panel to the left, locate and select your RIG.

Note: If you have more than one RIG installed, click that RIG in the left Location panel in order to view the Summary window.

The Summary window appears (see Summary View).

3.1.1 Windows Integrated Authentication

The following requirements enable Windows integrated authentication on the client side:

• Set enable.integrated.winauth = true in the application.properties file, which is located in the apps/nectar/ folder.

• AD/LDAP authentication store should be enabled for RIGs and CIP.

  For more information on authentication, see Manage Authentication.

• The currently logged-in Windows user should be in the same AD Domain as the RIG/CIP, depending on where you want to log in.

  To enable Windows integrated authentication on the RIG, see Enable Windows Integrated Authentication for RIG to CIP Connectivity.

• Computers that launch Nectar Foundation clients and the servers running RIGs and CIPs should be on the same AD domain.

The Nectar Foundation client should automatically login without presenting the Nectar Portal Login window (which asks for your credentials) using your currently logged-in Windows user account credentials.

3.2 Summary View

After logging on, locate and select your RIG in the Location panel to the left.

The Summary window appears and posts all events generated from monitored poll functions.

Figure 3-2 Summary Window

Table 3-1 View Options

When registering to a RIG, the registration process immediately displays the Summary window. This list-based view provides you with a quick glance (in text mode) of the dependency trees, events or aggregate alarms of the RIG system. Enter information, such as date, time, and event ID, to filter for specific occurrences.

The Summary view can be used to translate critical system states and business processes, and the current status of the same to the service provider. Each of these can be used in managing service levels for the end-client.

Right-click on an event to view the following options:

Table 3-2 Event Options

Each event is highlighted in a color from the alarm key referenced in Status Summary. Use this key to identify the alarm criticality.

3.3 Command Buttons

The command buttons are located in top-right corner of any view window. These buttons allow you to perform functions, such chatting with other users, changing passwords, and setting screen preferences.

Item	Click to ...
	View the Intelli-Q dashboard, which provides a live list of all events/alarms. Note: Intelli-Q is only available, if the user is logged into a CIP/EIP. If the user is directly logged into a singular RIG, they will not see any Intelli-Q information. Each alarm/issue is color-coded based on the device alert levels and prioritized based on the client service windows.
	• Open the Nectar Chat window to use the Nectar chat system. • Double-click an ID to start a chat. • For more information, see Access the Chat System.
	Click on the logged-in user name to open the drop-down menu. Note: Provides user login information.
	Select one the following user options: • About - Provides version information about the current RIG on which you are logged in. • Change Password - Allows you to change your password on this RIG. • Settings - Allows you to: - Manage the appearance of your RIG. For example, you can use a larger banner, select the color theme for your RIG, use server nicknames (to shorten server names) in the interface, and include child nodes in the Location tree filter match. - Manage the screen appearance of your RIG by saving your settings on or loading settings from your computer. You can also choose to launch RDP Windows in full-screen mode. - Manage system settings, such as enabling debug logging for your RIG, viewing client connection details in your RIG, and refreshing permissions. - Reset settings to their original default settings. - Create a download location where data downloaded from your RIG(s) will be downloaded. • Logout - Allows you to logout of this RIG. • Exit - Allows you exit this RIG without logging out. Nectar recommends that you log out first.

Table 3-3 User Options

3.4 Menu Bar

This menu allows you to navigate to the various functions within the RIG.

Figure 3-3 Menu Bar

To use the menu navigation bar, click on one of the following menu options:

• RIG
• Health
• Dashboards
• Reports
• Tools
• Modules
• Configure

These menu items are discussed throughout this guide.

3.5 Status Bar

The status bar provides the following RIG/CIP/EIP information, depending on what you selected in the Location pane:

Figure 3-4 Status Bar

• Primary: Primary RIG/CIP/EIP version, depending on what you selected in the Location pane; also shows if the RIG/CIP/EIP is Online or Offline. A green status icon indicates that the primary server is up and running correctly.
• Backup: Backup RIG/CIP/EIP version, depending on what you selected in the Location pane; also shows if the RIG/CIP/EIP is Online or Offline.

Note: A green status icon indicates that the RIG/CIP/EIP is functioning properly. A yellow status icon indicates that the server is unlicensed or incorrectly configured. Hovering over the status icon provides more information as to what the problem is. For example, this status shows that the CAM module did not start:

Figure 3-5 Status Bar

• RTD: Round Trip Delay is a measure of time that it takes for the RIG/CIP/EIP to communicate and get information from the box that is being monitored.
• Users: Number of users assigned to this RIG/CIP/EIP.

3.6 Status Summary

The Status Summary panel in the bottom-left corner of your window provides a list of the alerts used in the following Nectar Foundation APM functionality areas:

• Dependency Trees
• Real-Time Quality (QoS)
• Perspective Real-Time QoS
• Element Registry
• Summary
• Events

Figure 3-6 Status Summary

3.7 System Tray Icon

When you click x to close the Nectar client window, rather than selecting Exit from the User options, the System Tray icon appears on your computer task bar.

Figure 3-7 System Tray Icon

Select one of the following:

• Click on the icon to open the Nectar client window.
• Right-click on the icon and select Restore to open/restore the Nectar client window.
• Right-click on the icon and select Exit to completely close the application.

4. License and Enable Modules

After installing the RIG client, you must license and enable your modules.

This section provides information about the following:

• Important Terms
• Apply a License
• Enable a Module

4.1 Important Terms

The following definitions are important:

• Vendor Knowledge Module (VKM): This module provides:
  • In-depth monitoring and management of the UC infrastructure/application.
  • Quality and services including broad, deep, dynamic polling and reporting functionality.
  • Increased automated process capabilities.
• Knowledge Scripts: These are used to monitor and manage the UC infrastructure, applications, and service providers in a similar fashion as the VKM. Knowledge scripts provide the ability to:
  • Use either SNMP or REST API for inventory alignment.
  • Run inventory collections.
  • Run alignments to add agents and pollers.
  • Run setup and remove for agents and polling.
  • Create traps in Receiver Module and provide post process functions.
• Poller Packs: The use of poller packs provides the ability to monitor and manage any specific manufacturer infrastructure or application through the use of logical pollers. Once created, these poller packs can be exported/imported across customer RIGs. This provides a mechanism to easily onboard additional assets from the manufacturer or application. For more information, see Import/Export Poller Packs.

4.2 Apply a License

To apply a license, follow one of these sections, depending on your setup:

• Apply a License to a Local Host RIG from a CIP/EIP
• Apply a License to a Newly Installed RIG

4.2.1 Apply a License to a Local Host RIG from a CIP/EIP

Follow these steps to apply a license to a local host RIG from a CIP/EIP:

1. Access the RIG via the CIP/EIP.
2. Navigate to RIG > Server License.

Figure 4-1 RIG > Server License

The Server License window appears.

Figure 4-2 Server License

3. Click Copy to Clipboard.

4. Open a ticket with the Nectar Services Desk and attach the value copied to the clipboard.

   The Service Desk provides a license file.

5. Download this license file to your desktop.

6. Click Install License.

7. Select the file received from the Nectar Services Desk.

8. To restart the RIG and apply the changes:

   a. Click Restart.

   b. When the following message appears, click Yes.

Figure 4-3 Restart

4.2.2 Apply a License to a Newly Installed RIG

Follow these steps to apply a license to a newly installed RIG (directly from the RIG):

1. Log in to the RIG via http://[RIG Host name or IP Address].

   You are presented with the Server License window:

Figure 4-4 Server License

2. Click Copy to Clipboard.

3. Open a ticket with the Nectar Services Desk and attach the value copied to the clipboard.

   The Service Desk provides a license file.

4. Download this license file to your desktop.

5. Click Install License.

6. Select the file received from the Nectar Services Desk.

7. To restart the RIG and apply the changes:

   a. Click Restart.

   b. When the following message appears, click Yes.

Figure 4-5 Restart

4.3 Enable a Module

After applying a module license, you must enable a module before you can use and view it in the menu:

1. Log in to the RIG.
2. Navigate to RIG > Module Configuration.

Figure 4-6 RIG > Module Configuration

3. In the Module Configuration window, select the module(s) you want to enable.

Figure 4-7 Select Module(s) to Enable on RIG

4. Click Apply.
5. Restart the RIG and apply the changes.

Note: To disable a module, uncheck the check box and click Apply; then restart the RIG.

6. For more detailed instructions on configuring and using the various modules), see the related Configuration Guide for your installed module(s).

4.3.1 Restart the RIG

Follow these steps to restart the RIG and apply the changes:

1. Navigate to RIG > Admin > Restart.
2. When the following message appears, click Yes.

Figure 4-8 Restart

5. Security Administration

The Permission module stores login information and user permissions. It is a required module for all RIG installations. Permissions for each RIG server are managed in the Permission Manager.

This section explains how to:

• Manage Users
• Manage Groups
• Manage Authentication
• Manage Password and Session Rules
• Reset Expired Passwords
• Reset Password History
• Expire Password Now

5.1 Manage Users

This section explains how to manage RIG users, including:

• Add a User
• Enable Two-Factor Authentication
• Edit a User
• Remove a User
• Add a User to a Group

5.1.1 Add a User

Follow these steps to add a user:

1. Navigate to RIG > Permissions.

Figure 5-1 RIG > Permissions

The Permissions - Users window appears.

Figure 5-2 Users - Add

2. Click Add.

Note: You can also right click and select Add to add a new user.

The Add User - Details window appears.

Figure 5-3 Add User

3. Enter a Username that is alphanumeric and case sensitive without a minimum or maximum value.

4. Enter the user’s password in the Password and Confirm fields.

5. In the Organization field, enter the organization to which the user is assigned (typically root).

6. From the Default Dashboard menu, select a default dashboard that will show up by default when you navigate to Dashboards > Dashboard.

7. Click the Rules tab.

   The Add User - Rules window appears:

Figure 5-4 Rules

8. Click the Enable user specific rules check box to activate the selected Password and Session rules, if needed.
9. Select and specify a value, if activated, for the Password and Session rules for the user accessing your RIG.
10. Click OK.

5.1.2 Enable Two-Factor Authentication

Two-factor authentication provides an additional layer of security.

Follow these steps to enable two-factor authentication for a specific user:

1. Navigate to RIG > Permissions.
2. The Permissions - Users window appears.
3. Select a user; then right-click and select Enable Two-Factor Authentication.

Figure 5-5 Enable Two-Factor Authentication

The Enable Two-Factor Authentication window appears.

Figure 5-6 Enable Two-Factor Authentication

4. Click Yes.

   The Two-Factor Auth Setup window appears.

Figure 5-7 Two-Factor Auth Setup

5. Enter the following information for the two-factor authentication:

6. Click Next.

   The following window appears with the new generated Secret key.

Figure 5-8 Secret Key

7. Scan the generated QR-Code using a third-party authentication application, such as Google Authenticator or WinAuth, to generate a one-time password (OTP); then click Next.

   The authentication application creates an OTP that is valid for a short period of time.

Note: You can also manually enter the Shared-key in the authentication application to generate an OTP. You will need to click the Show Shared-key check box to view the key.

8. When the following Confirm with OTP window appears, enter the OTP generated from the authentication application to complete the setup.

Figure 5-9 Confirm with OTP

9. Click Finish.

Note: For each login, a generated OTP from the authentication application must be entered in addition to the username and password.

To disable, select a user; then right-click and select Disable Two-Factor Authentication. Click Yes to confirm.

5.1.3 Edit a User

Follow these steps to edit a user:

1. Navigate to RIG > Permissions.
2. The Permissions - Users window appears.

Figure 5-10 Users - Edit

3. Select a user; then select Edit.

   The Edit User - Details window appears.

Figure 5-11 Edit User

4. Select the Password check box, if you want to change the password associated with the user.

   The Password and Confirm fields are cleared, so that you can enter a new password.

5. Make changes to the following selections, as needed:

   • Organization
   • Default Dashboard

6. Click the Rules tab.

7. Make changes, as needed, to the Password and Session rules.

8. Click OK.

5.1.4 Remove a User

Follow these steps to remove a user:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

Figure 5-12 Users - Remove

2. Select a user; then click Remove.

   The Remove User window appears with the following message:

Figure 5-13 Remove User

3. Click Yes.

5.1.5 Add a User to a Group

To control user access to functional areas within the system, a group with designated permissions may be assigned or removed from the user.

Follow these steps to add a user to a group:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

Figure 5-14 Users - Add to Group

2. Select a user; then click Add to Group.

   The Add User to Group window appears.

Figure 5-15 Add User to Group

3. Select a group in the list; then click Add.

Note: You can select multiple groups to assign to a user:

• Hold down the Shift key to highlight groups located next to each other; then click Add.

• Hold down the Ctrl key to randomly select a group; then click Add.

Note: The Add User to Group window is populated with groups that you create, as discussed in Add a Group.

The user is now assigned to that group(s).

4. View a selected user’s group memberships in the Group Membership pane. In this example, user User1 is assigned to Admin group.

Figure 5-16 User Permissions

5.2 Manage Groups

Groups allow you to grant users specific access to system areas. The Permission Manager does not contain default user groups.

This section explains how to:

• Add a Group
• Edit a Group
• Remove a Group
• Assign Permissions to a Group

5.2.1 Add a Group

Follow these steps to add a group:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Groups tab.

Figure 5-17 Permissions - Groups

3. Click Add.

   The Add Group window appears.

Figure 5-18 Add Group

4. Enter the name of the new group, such as Admin.

5. Click the drop-down arrow and select the Default Dashboard for this group.

6. Select Backups to add the group to the backup server instance.

7. Click OK.

   The new group name and dashboard appear in the Groups pane.

Figure 5-19 New Group

5.2.2 Edit a Group

Follow these steps to edit a group:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Groups tab.

Figure 5-20 Permissions - Groups

3. Select a group; then click Edit.

   The Edit Group window appears.

Figure 5-21 Edit Group

4. Edit the Default Dashboard, as needed.
5. Select Backups to add (or remove) the group to (from) the backup server instance.
6. Click OK.

5.2.3 Remove a Group

Follow these steps to remove a group:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Groups tab.

Figure 5-22 Permissions - Groups

3. Select a group; then click Remove.

   The group is removed from the Groups pane without any warning.

5.2.4 Assign Permissions to a Group

Follow these steps to assign permissions to a new group:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Groups tab.

Figure 5-23 Permissions - Groups

3. Select a group; then click Add Permission.

   The Add Permission to window appears.

Figure 5-24 Add Permission To Group

4. Select a permission; then click Add.

Note: You can select multiple permissions to assign to a group:

• Hold down the Shift key to highlight permissions located next to each other; then click Add.

• Hold down the Ctrl key to randomly select a permission; then click Add.

The selected permission is added to the group.

5. View a selected group’s permissions in the Permissions pane. In this example, the group Admin is assigned to the Admin permission.

Figure 5-25 Group Permissions

5.3 Manage Authentication

Follow these steps to select an authentication type:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Authentication tab.

Figure 5-26 Permissions - Groups

3. Select one of the available authentication types:
   • Local Store
   • LDAP
   • Active Directory / Windows NT
   • RADIUS

Note: The last three authentication types require you to enter additional authentication details. Authentication types will automatically failover to the Local Store, if the selected authentication type is unavailable.

For more information on authentication types, see External Authentication Administration Guide.

4. Click Save Changes at the top of the dialog when you have made your selections and entries.

5.3.1 Enable Windows Integrated Authentication for RIG to CIP Connectivity

To enable Windows integrated authentication for RIG to CIP connectivity, make sure the following requirements are met:

• AD/LDAP authentication store should be enabled on CIP.
• Both the RIG and CIP must be on the same AD domain.
• Set the constant UUID value IWA:12622123-df90-4e6c-8493-561a24101b35 for the password property in the RIG’s infospot.properties file (located in the /etc folder).
• Set the constant UUID value IWA:12622123-df90-4e6c-8493-561a24101b35 for the superpassword property in the RIG’s server.properties file (located in the /etc folder) in order for CIP to lookup the RIG.

5.4 Manage Password and Session Rules

Follow these steps to set up password and session rules for local users/groups accessing your RIG:

1. Navigate to RIG > Permissions.

   The Permissions - Users window appears.

2. Click the Rules tab.

Figure 5-27 Rules

3. Select any of the available password rules for local users/groups accessing your RIG.
4. Click Save Changes to apply these changes.

5.5 Reset Expired Passwords

Follow these steps to reset expired account passwords:

1. Navigate to RIG > Permissions.

   The Permissions - User window appears.

Figure 5-28 Reset Expired Password

2. Select a user whose password has expired; then right-click and select Reset Expired Password.

   The Reset Expired User Password dialog box appears with the following message:

Figure 5-29 Reset Expired User Password

3. Click Yes to confirm your decision to reset this user’s password. The user will receive a notification with a temporary password.

5.6 Reset Password History

Follow these steps to reset a user’s password history, so they can reuse former passwords:

1. Navigate to RIG > Permissions.

   The Permissions - User window appears.

Figure 5-30 Reset Password History

2. Select a user whose password history needs to be reset; then right-click and select Reset Password History.

   The Reset Password History dialog box appears with the following message:

Figure 5-31 Reset Password History

3. Click Yes at the prompt to confirm your decision to reset this user’s password history.

5.7 Expire Password Now

Follow these steps to immediately expire a user’s password. This is useful when a user has left the company, and you want to prevent them from accessing the system.

1. Navigate to RIG > Permissions.

   The Permissions - User window appears.

Figure 5-32 Expire Now

2. Select a user whose password needs to be removed now; then right-click and select Expire Now.

   The Expire Passwords dialog box appears with the following message:

Figure 5-33 Reset Expired User Password

3. Click Yes at the prompt to confirm your decision to expire this user’s password immediately.

6. Access the Chat System

The Chat icon is located in the top-right corner of the window. It allows you to access the Nectar Chat System. This is an instant messaging system that allows chat sessions among logged in users:

Figure 6-1 Chat Icon

Follow these steps to use the Chat system:

1. Select the icon at the top right area of the window.

   A list of chat contacts appears in left pane. Your name is located at the top of the list:

Figure 6-2 Chat Contacts

2. To set your chat status, click the drop-down arrow beneath your name in the Chat pane, and select one of the following statuses:
   • Online
   • Away
   • Busy
   • Offline

Figure 6-3 Chat Status

3. To chat with someone, double-click on their user name in the Chat panel.
4. Enter your message in the field at the bottom of the right pane where you see Type here and press Enter to send the message.

Figure 6-4 Chat Window

The message immediately appears in the top area of the pane.

Figure 6-5 Sample Chat

Note: - The dialog between the two users is distinguished by font color: blue and red.

• The history of the chat session remains in the top portion of the pane.

• You can use the Chat pane to exchange data as well as conversations.

• Drag and drop events into the Chat field as links that direct the other user to the event details.

7. Remote Access

Administrators can use the Connection Broker module to manage permissions and access to servers, applications, networks, and more. You can view a list of all open connections and the individuals that have open connections through a client RIG. The Socket Tunnel allows you to connect to a specific server through a connection request.

This section provides information about the following:

• Connection Broker
• Open Connections
• Socket Tunnel

7.1 Connection Broker

The Connection Broker module is used to broker connections to servers, local application connections, desktops, web interfaces, networks, and so on. It provides two advanced features to Service Provider Responders:

• The ability to use third-party applications, such as element management systems or native equipment manufacturer tools, directly from the desktop running the Client Application Portal.
• The ability to have common access tools, such as Telnet, web access, SSH, Remote Desktop and third-party tool launches, in a central list maintained by the Service Provider for repetitive and instance access.

1. To access the Connection Broker, navigate to Tools > Remote Access > Connection Broker.

   The Connection Broker window appears.

Figure 7-1 Connection Broker

2. Right-click within the Connection Broker list and select from the following options:

Figure 7-2 Connection Broker Menu Options

Table 7-1 Menu Options

7.1.1 Add a Connection

Follow these steps to add a connection:

1. Navigate to Tools > Remote Access > Connection Broker.

   The Connection Broker window appears.

Figure 7-3 Connection Broker

2. Right-click in the Connections pane and select Add; then select one of the following types to create a connection:

Figure 7-4 Connection Types

Table 7-2 Connection Types

3. After you select the connection type and enter the connection data; then click Add.

   The new connection appears in the Connections pane.

Figure 7-5 New Connection

7.1.2 Edit Connection Properties

Follow these steps to edit a connection:

1. Navigate to Tools > Remote Access > Connection Broker.

   The Connection Broker window appears.

Figure 7-6 Edit a Connection

2. Select a connection; then right-click and select Edit.

   The Edit Connection Properties window appears.

Figure 7-7 Edit Connection Properties

3. Change the following values, as needed; then click OK.

   • Description

   • IP

   • Port

     The updated connection appears in the Connections pane.

7.1.3 Remove a Connection

Follow these steps to remove a connection:

1. Navigate to Tools > Remote Access > Connection Broker.

   The Connection Broker window appears.

Figure 7-8 Edit a Connection

2. Select a connection; then right-click and select Remove.

   The connection is removed without warning and no longer appears in the Connections pane.

7.2 Open Connections

To view a list of all open connections, as well as the individuals that currently have open connections through the specified client RIG:

1. Navigate to Tools > Remote Access > Open Connections.

   The Open Connections window appears.

Figure 7-9 Open Connections

7.3 Socket Tunnel

You can use the Socket Tunnel to connect to a specific server through a connection request.

1. Navigate to Tools > Remote Access > Socket Tunnel.

   The Start Socket dialog box appears.

Figure 7-10 Start a Socket Tunnel

2. Enter the following information to start a socket tunnel:

Table 7-3 Parameters

3. Click Start.

   The Remote Sockets dialog box appears with your perpetual socket number.

Figure 7-11 Remote Socket Number

8. File Manager

File Manager is most often used on a RIG and EIP level to complete file transfers, software upgrades, and/or release management at a client premise. File Manager is also available at the CIP level to stage upgrades for Farm and Wayside servers.

Note: Upgrades to Farm and Wayside servers are generally completed by Nectar.

This section provides the following information:

• File Manager Overview
• File Manager Features
• Move Files and Directories

8.1 File Manager Overview

To access File Manager, navigate to RIG > File Manager:

Figure 8-1 RIG > File Manager

File Manager allows you to copy files from your local host to a target RIG.

Service Providers can use it to place updated files for release management at the client premise in a service directory directly on the RIG. The RIG can later be used as an FTP, TFTP, or UNC source for locally distributing the file at the client premise or within the client WAN.

You can also use File Transfer to send ISO images to RIGs that are equipped with DVD burners. This is useful when local hands require software for servicing the client that might be missing or lost at the client premise. Note that the length of transfer will differ from client to client based on the bandwidth available to the on-premise RIG that has access to the Internet.

The File Manager provides directory access to the RIG, where you can:

• Upload files from your local file system to the RIG.
• Download files from the RIG to your local computer.

8.2 File Manager Features

This section introduces you to a few key File Manager features, including:

• Local/Remote File System
• Home Link
• File Manager Icons
• Drives
• Breadcrumb Paths

8.2.1 Local/Remote File System

File Manager contains two panes:

• Local File System - Displays your local computer’s directory structure.
• Remote File System - Displays your remote RIG’s directory structure.

Figure 8-2 Local/Remote File System

8.2.2 Home Link

The Home link appears in the Local and Remote File System panes.

• In the Local File System pane, the Home link displays the directory structure that the client recognizes as your Users > Owner directory structure.
• In the Remote File System, the Home link displays the RIG installation directory structure.

Figure 8-3 Home Link

8.2.3 File Manager Icons

File Manager contains several icons on each directory structure menu that are useful:

• The < icon allows you navigate backward through the history of where you have been in the session.
• The > icon allows you to navigate forward through the history of where you have been in the session.
• The ^ icon takes you up one level in the directory structure.
• The Refresh icon refreshes the contents in the directory structure.

Figure 8-4 File Manager Icons

8.2.4 Drives

A vertically stacked list of drives that are found on the Local/Remote File Systems are displayed in the left-hand portion of the File Manager panes.

• For a Windows environment, one or more drive icons will exist.
• For a Linux environment, there should only be one drive, which will contain a forward slash (/), signifying root.

If you click on a drive, the contents of that pane are updated with a couple of caveats:

• If you have already navigated to a location on that drive during the current session, the contents of that location are displayed.
• If you have not navigated to a location on that drive during the current session, then the root contents for that drive are displayed.

Figure 8-5 Drives

8.2.5 Breadcrumb Paths

Directory breadcrumb paths exist below the Local File System and Remote File System titles. Each breadcrumb is a live link to the actual directory/drive, except for the last breadcrumb. This is the actual directory you are currently viewing.

Figure 8-6 Breadcrumb Paths

When you click on an arrow (>) between the breadcrumbs, a pop-up window appears, showing a list of directories for the breadcrumb located to the left of the selected arrow. For example, in Figure 8-7 the arrow (>) following Users is selected, so the list of directories that appear is for Users.

Figure 8-7 Breadcrumb Arrow (>) Menu of Directories

8.3 Move Files and Directories

This section explains how to upload and download files between your local and remote file systems, including:

• Select Files and Directories
• Drag and Drop Files and Directories
• Upload Files/Directories from Local File System to Remote File System
• Download Files/Directories from Remote File System to Local File System

8.3.1 Select Files and Directories

File Manager allows you to select multiple files and directories by holding down the Ctrl key and clicking on the desired files/directories.

You can also use a common keyboard shortcut to Select All (Ctrl-A).

8.3.2 Drag and Drop Files and Directories

File Manager allows you to use a standard “drag-and-drop” feature to move files between panes.

Note: You can drag-and-drop files/directories from a Windows Explorer window to the Remote File System pane, not vice versa.

8.3.3 Upload Files/Directories from Local File System to Remote File System

Follow these steps to upload files/directories from your Local File System to the Remote File System:

1. Select the drive/directory location in the Local File System pane containing the files/ directories you will upload to the Remote File System.
2. Select the files/directories you will upload.
3. Right-click on the files/directories and select Upload:

Figure 8-8 Upload File from Local File System

4. The Upload File dialog box appears, where you have these additional selection options:
   • Check box is located to the left of each selected file/directory. You can deselect/select these if you change your mind about which files to upload.
   • The Deselect All/Select All toggle button can be used to select/deselect all files/ directories.

Figure 8-9 Upload Files

5. Click the Upload button to begin the upload process.

   A File Transfer Status dialog box appears with the following information:

   • The top progress bar shows the upload progress for all selected files/directories. The Cancel icon to the right of this bar allows you to cancel the entire upload.
   • The bottom progress bar shows the progress of the file currently being transferred with an estimated time until completion.

Note: If only a single file is being transferred, then only one progress bar (the bottom bar) appears.

8.3.4 Download Files/Directories from Remote File System to Local File System

Follow these steps to download files/directories from your Remote File System to the Local File System:

1. Select the drive/directory location in the Remote File System pane containing the files/ directories you will download to the Local File System.
2. Select the files/directories you will download.
3. Right-click on the files/directories and select Download:

Figure 8-10 Download File from Remote File System

4. The Download File dialog box appears, where you have an additional selection option.
   • The Deselect All/Select All toggle button can be used to select/deselect all files/ directories.

Figure 8-11 Download Files

5. Click the Download button to begin the download process.

   A File Transfer Status window appears with the following information:

   • The top progress bar shows the download progress for all selected files/directories. The Cancel icon to the right of this bar allows you to cancel the entire download.
   • The bottom progress bar shows the progress of the file currently being transferred with an estimated time until completion.

Note: If only a single file is being transferred, then only one progress bar (the bottom bar) appears.

9. RIG Connectivity and Logs

This section provides information about the following:

• Command Line
• Maritime Terminal
• Remote Desktop
• Log Tails

9.1 Command Line

The Command Line function creates a Telnet-based connection between your local client application and the far-end RIG. The Command Line of a targeted RIG is actually a local RIG emulation of the Windows command line that is fed through a Telnet session.

1. Navigate RIG > Admin > Command Line.

Figure 9-1 RIG > Admin > Command Line

The Telnet Command Line window appears.

Figure 9-2 Command Line

You can run quick remote O/S level commands from the Command Line function. An example would be to ping an element or conduct trace routes directly from the RIG at the client premise.

The command line is produced through a telnet session. Similar in communication methods as the Terminal Services session to the RIG, the telnet session is launched off of the local host where the Client Application is running and SRSTP transfers the communication from the Client Application to the CIP and then to the Client RIG.

9.2 Maritime Terminal

The Maritime Terminal function is a command line interpreter for the RIG software and it is reserved for advanced and support related functions. This function establishes communication directly with the governing software system of the remote RIG system, or better known as the CLI (Command Line Interface).

There is a separate reference guide for Maritime commands. Please refer to that manual for Maritime commands. We encourage that you do not leverage the Maritime Terminal except when VKMs that require specific commands must be run from the CLI.

1. Navigate to RIG > Admin > Maritime Terminal.

Figure 9-3 RIG > Admin > Maritime Terminal

The Telnet Martime Terminal window appears.

Figure 9-4 Maritime Terminal

9.3 Remote Desktop

The Remote Desktop function will immediately launch a Microsoft Terminal Services session (also known as a RDC session) from your local computer to the RIG server. Make sure that your local machine does not have any firewalls that will prevent the RIG from reaching the information source.

It is important to note that RDP can take default values of the default.rdp file stored in your user profile within your Windows O/S environment. To make certain that you have the Remote Desktop experience you are looking for (e.g., make remote drives available and establish a comfortable display setting), login into RDP directly (at the command line, type MSTSC) and save your preferred settings into a file called default.rdp.

The system will create a local Socket Tunnel that arranges for TCP communication from the CAP to the target RIG system. The Microsoft Terminal Services client will use the target RIG system to pass to the far end RIG system.

1. Navigate to RIG > Admin > Remote Desktop.

Figure 9-5 RIG > Admin > Remote Desktop

The Remote Desktop Connection dialog box appears, showing the status of the remote session connection.

9.4 Log Tails

The Log Tails function allows you to view logs in a certain log file. You can also select certain logs (or all logs displayed) and copy them to a clipboard for other use.

1. Navigate RIG > Admin > Log Tails.

Figure 9-6 RIG > Admin > Log Tails

The Log Tails window appears.

Figure 9-7 Log Tails

2. Use the Log File drop-down to select the log file that you want to view.

   The log file populates in the pane below (see Figure 9-7).

3. You can also perform the following actions:

   • Select one or more logs by using the Ctrl key or use Select All to select all of the logs.
   • Click Copy to copy the selected logs.
   • Paste the logs in a tool, such as Notepad, as needed.

10. RIG Database Backup/Restore

You can easily backup and restore the database that is associated with your RIG(s) and contains all of your RIG data.

This section provides information on the following:

• Database Backup
• Database Restore

10.1 Database Backup

The Database Backup feature backs up all data in the database. The backup goes through all of the tables that are exposed by each module on a RIG and dumps the row data into backup folder. The backed-up data does not include file-based config files, such as properties files.

Follow these steps to back up the database associated with your RIG(s):

1. Navigate RIG > Database Backup.

Figure 10-1 RIG > Database Backup

The Database Backup window appears.

Figure 10-2 Database Backup

2. Complete the following fields:

Table 10-1 Backup Database

3. Click Apply.

   The backup will be scheduled.

4. If you want to back up the database immediately, click Backup Now.

10.2 Database Restore

The Database Restore feature restores all data from the backup folder. After performing a restore, the Client encourages you to restart your RIG(s) based on database mode (Embedded / Network). This restore does not include file-based config files, such as properties files.

Follow these steps to restore the database that is associated with your RIG(s) from a previous backup:

1. Navigate RIG > Database Restore.

Figure 10-3 RIG > Database Restore

The Select Database Backup to Restore window appears:

Figure 10-4 Select Database Backup to Restore

2. Navigate to the backup file that you want to restore; then click OK.

   The Confirm Database Restore window appears.

Figure 10-5 Confirm Database Restore

3. Click Yes.
   • If database is running in standalone mode, then the server will be restarted automatically and current database will be replaced with selected backup.
   • If database is running in Network mode, then you will need to manually stop and restart the NectarRIG service using Windows Services.

11. Dependency Tree Management

This section provides information on the following:

• Dependency Trees
• Manage Dependency Trees
• Manage Dependency Tree Nodes

11.1 Dependency Trees

When network topologies converge as in the case of Voice over IP and local and wide area networks, identifying and understanding the intersection points of co-existing or reliant topologies is critical in determining root cause and calculating business impact.

A core function of Nectar Foundation APM is the ability to identify the relationships of disparate silos of technology events and data within the UC ecosystem. Dependency Trees are the underlying system that enables such correlation within the platform. Dependency Trees can be automatically generated by specific VKMs and Knowledge Scripts and adjusted to fit an actual deployment environment or manually created to illustrate in real time complex relationships between different and dependent technologies.

Take, for example, a client-server web application. The front-end web server may be coupled to a back-end transaction processing system residing on a different host, while the data may sit on a SAN or network-based storage facility. Those are three distinct systems, with each running on different hosts and reliant upon a delivery network, which can consist of several elements to connect those hosts together (such as switches, routers, and firewalls).

Given this example, Nectar Foundation APM can perform the following monitoring functions:

• Web Server:
  • Host level health (CPU, memory, disk, sessions)
  • Application processes
  • Application logs
• Transaction Server:
  • Host level health (CPU, memory, disk, sessions)
  • Application processes
  • Application logs
  • Database queries and synthetic transactions calls
• Storage Server
  • Host level health (CPU, memory, disk, sessions)
  • File integrity
  • File security (watching for unauthorized access)
• Network Infrastructure (switches / routers / firewalls)
  • Platform level health (CPU, memory)
  • Throughput measurement of key interfaces
  • Port status of key ports (for example those that services above hosts or inter-network elements)

Having all of the above information would be extremely helpful when troubleshooting a complex distributed system. Dependency trees can take advantage of collections for event and performance data being taken in to the Nectar Foundation APM and leveraged with policy- based management into a single view that identifies all of the inter-device, inter-app, and inter- system relationships that exist for this singular service to function.

The trees maintain a live view of each individual element status contributing to the relationships, so there is a living breathing documentation set of a service and underlying supporting technology assets.

Figure 11-1 Dependency Tree Showing CLAN Associations

11.2 Manage Dependency Trees

Dependency trees are created per location using available elements and agents from that location. The trees maintain a live view of each individual element status contributing to the relationships. For more information on the alert value structure, see Status Summary.

Follow these steps to view dependency tree options:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-2 Configure > Dependency Trees

2. Notice the following options on the Dependency Trees window:

   • View

   • Add

   • Edit

   • Remove

   • Emails

     You can also right-click on a dependency tree and select from the following options:

Figure 11-3 All Elements

These options are explained in Table 11-1 and the following sections.

Table 11-1 Options

11.2.1 View a Dependency Tree

Follow these steps to view a dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

2. Select a tree Name in the left pane and click View to view the associated dependency tree diagram in the right pane.

Note: You can also double-click on a dependency tree Name.

Figure 11-4 View Dependency Tree

11.2.2 Add a Dependency Tree

Follow these steps to add a dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-5 Add

2. Click Add.

   The Add Dependency Tree dialog box appears.

Figure 11-6 Add Dependency Tree

3. Enter the dependency tree Name.
4. Click the Enabled check box to enable the dependency tree.
5. Select one of the following event types for the new dependency tree using the drop-down:

Table 11-2 Event Types

6. Click OK.

   The new dependency tree is added to the list of trees in the Name column.

11.2.3 Edit a Dependency Tree

Follow these steps to edit a dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-7 Edit

2. Select a dependency tree; then click Edit.

   The Edit Dependency Tree dialog box appears.

Figure 11-8 Edit Dependency Tree

3. Edit the following parameters for the dependency tree, as needed:
   • Enabled
   • Event Type
4. Click OK.

11.2.4 Remove a Dependency Tree

Follow these steps to remove a dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-9 Remove

2. Select a dependency tree to delete; then click Remove.

   The Removal Confirmation dialog box appears.

Figure 11-10 Removal Confirmation

3. Click Yes.

11.2.5 Enable/Disable a Dependency Tree

Follow these steps to enable/disable a dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

2. Perform one of the following actions:

Figure 11-11 Enable/Disable Tree

• To enable a dependency tree, select the dependency tree Name in the left pane and click Enable. Yes shows in the Enabled column.
• To disable a dependency tree, select the dependency tree Name in the left pane and click Disable. No shows in the Enabled column.

11.2.6 Copy a Dependency Tree

Follow these steps to copy an existing dependency tree to create a new dependency tree:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

2. Right-click on the dependency tree Name in the left pane that you want to copy and select Copy Dependency Tree from the drop-down menu.

   The Copy Dependency Tree dialog box appears.

Figure 11-12 Copy Dependency Tree

3. Enter the new dependency tree Name.
4. Click OK.

11.3 Manage Dependency Tree Nodes

This section explains how to manage dependency tree nodes, including:

• Parent Node Menu
• Child Node Menu
• View Node Information
• Edit a Node

11.3.1 Parent Node Menu

Right-click on a parent (top) node to view the following options:

Figure 11-13 Parent Node Menu

Table 11-3 Options

11.3.2 Child Node Menu

Right-click on a child (second or lower-level) node to display the following menu options:

Figure 11-14 Child Node Menu

Table 11-4

11.3.3 View Node Information

When you hover over a node, you can view the following node information:

Figure 11-15 Node information

Table 11-5 Labels

Note: To change the node information, right-click on the node and select Edit. For more information, see Edit a Node.

11.3.4 Edit a Node

Follow these steps to edit a dependency tree node:

1. Right-click on a node and select Edit.

Figure 11-16 Edit a Node

The Edit Node dialog box appears.

Figure 11-17 Edit Node

2. Make changes to the following fields, as needed; then click OK.

Field	Description
Node Name	Enter a name of the new node or select an existing node from the list under Filter.
Filter	• Used to filter the list just below it, so that you can more easily find existing node names. • If you click on one of the node names in this list (whether you filtered for it or not), it will get added to the Node Name (see above).
Description	Enter a description of the node.
Service Type	Enter the service type being performed on the node.
Function	Select the function of this node using the drop-down. If you select Max Alert %, the following additional fields appear. Specify a maximum and minimum percentage for alerting as well as the threshold, such as Warning. Note: You can also select this function when adding a new node.
Message on Change	Select from the following: • Ignore - This option will not send email messages when a change occurs to the node. • Message - This option causes an email notification to go out when a change occurs to the node.
Propagate to Branch	Select this check box to propagate node changes to the branch.

Table 11-6 Edit a Node

11.4 Manage Email Notifications

This section explains how to:

• Set Up Email Notifications
• Edit an Email Notification
• Remove an Email Notification
• Configure Schedules

11.4.1 Set Up Email Notifications

Follow these steps to set up email notifications that will be sent when a node changes alert state:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-18 Click Emails

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

Figure 11-19 Dependency Emails

3. Click Add.

   The Add Email dialog box appears.

Figure 11-20 Add Email

4. Enter the following information:

Table 11-7 Add Email

5. Click OK.

   The new email appears in the Emails pane.

11.4.2 Edit an Email Notification

Follow these steps to edit an email notification that will be sent when a node changes alert state:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-21 Click Emails

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

Figure 11-22 Dependency Emails

3. Select an email address to edit; then click Edit.

   The Edit Email dialog box appears.

Figure 11-23 Edit Email

4. Make changes, as needed, to the following parameters:
   • Address
   • Format
   • Schedule
   • Group
5. Click OK.

11.4.3 Remove an Email Notification

Follow these steps to remove an email notification:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-24 Click Emails

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

Figure 11-25 Dependency Emails

3. Select an email address to remove; then click Remove.

   The Removal Confirmation dialog box appears.

Figure 11-26 Removal Confirmation

4. Click Yes.

11.4.4 Configure Schedules

Follow these steps to configure schedules for email notifications that will be sent when a node changes alert state:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-27 Click Emails

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

Figure 11-28 Dependency Emails

3. Click Configure Schedules.

   The Service Window window appears.

Figure 11-29 Service Window

For more information, see Manage Schedules.

11.5 Manage Email Groups

This section explains how to:

• Set Up an Email Group
• Remove an Email Group

11.5.1 Set Up an Email Group

Follow these steps to set up an email group:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-30 Dependency Trees

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

3. Click the Groups tab.

Figure 11-31 Groups Tab

4. Click Add.

   The Add Group dialog box appears.

Figure 11-32 Add Group

5. Enter the name of the Group; then click OK.
6. To add a group filter, see Add a Group Filter.

11.5.2 Remove an Email Group

Follow these steps to remove an email group:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-33 Dependency Trees

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

3. Click the Groups tab.

Figure 11-34 Groups Tab

4. Select a group to remove; then click Remove.

   The Removal Confirmation dialog box appears.

Figure 11-35 Removal Confirmation

5. Click Yes.

11.6 Manage Group Filters

This section explains how to:

• Add a Group Filter
• Edit a Group Filter
• Remove a Group Filter

11.6.1 Add a Group Filter

Follow these steps to add a filter for a group:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-36 Dependency Trees

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

3. Click the Groups tab.

Figure 11-37 Groups Tab

4. Select a group.

5. Click Add in the Filters pane to add a filter for the group.

   The Add Group Filter dialog box appears.

Figure 11-38 Add Group Filter

6. Enter the following information for the group filter:

Table 11-8 Parameters

7. Click OK.

   The new filter appears in the Filters pane.

Figure 11-39 New Filter

11.6.2 Edit a Group Filter

Follow these steps to edit a filter for a group:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-40 Dependency Trees

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

3. Click the Groups tab.

4. Select a group; then select a filter in the Filters pane.

5. Click Edit in the Filters pane.

Figure 11-41 Edit Filter

The Edit Group Filter dialog box appears.

Figure 11-42 Edit Filter

6. Make changes, as needed, to the group filter; then click OK.

11.6.3 Remove a Group Filter

Follow these steps to remove a filter for a group:

1. Navigate to Configure > Dependency Trees.

   The Dependency Trees window appears.

Figure 11-43 Dependency Trees

2. Click Emails.

   The Dependency Emails window appears with the Emails tab highlighted.

3. Click the Groups tab.

4. Select a group; then select a filter in the Filters pane.

5. Click Remove in the Filters pane.

Figure 11-44 Edit Filter

The Removal Confirmation dialog box appears.

Figure 11-45 Removal Confirmation

6. Click Yes to remove the filter.

12. Manage Dashboards and Maps

This section provides information on the following:

• Overview
• Take Inventory
• Load Existing Dashboards
• Copy Dashboards from other RIGs Using Dashboard Packs
• Configure a New Dashboard
• Maps
• View a Map in a Dashboard

12.1 Overview

Dashboards and maps enable Nectar Foundation APM to provide visualization across the management platform. They communicate the business-centric status of elements under management with the platform. Dashboards and maps are directly published to clients from the RIG and can be left open on the desktop to monitor.

Dashboards and maps provide real-time views that are presented to end clients. They also help Service Providers monitor network agents. It is important to understand the different dashboard components, which vary from client to client.

To access Dashboards, navigate to Dashboards > Dashboard.

Figure 12-1 Dashboards > Dashboard

Dashboards can have a variety of views and panels within views:

For example:

• Summary View
• Health and Performance
• Microsoft S4B KHIs
• Avaya Communications Manager (CM)
• Cisco UCM and Conferencing
• Trunks (PRIs, T1s, SIP)
• Resource Capacities (such as CLAN, MedPro, and Gateway)
• Voice Quality
• Voice Recording

12.1.1 Example: Disk Usage

This Disk Usage panel displays disk usage details:

Figure 12-2 Disk Usage Example

12.1.2 Example: Trunks Panel

The Trunk panel contains active trunk meters:

Figure 12-3 Trunks Panel

12.1.3 Example: Lync/SfB KHIs

This view contains Microsoft Lync/SfB Key Health Indicators (KHIs):

Figure 12-4 Lync/SfB KHIs

12.1.4 Example: Cisco Summary Dashboard

This view contains Cisco health and performance details:

Figure 12-5 Cisco Summary

12.1.5 Example: Avaya Dashboard

This view contains Avaya health and performance details:

Figure 12-6 Avaya Dashboard

12.1.6 Example: Voice Quality

This Voice Quality view contains details on:

• Voice Quality for Phone, Perspective, or All
• Media Processor
• Search Filter

Figure 12-7 Voice Quality

12.1.7 Example: Voice Recording

This Voice Recording view contains status details on voice recordings:

Figure 12-8 Voice Recording

12.1.8 Example: Reports

This view contains a list of reports. You can view a report by double clicking on it:

Figure 12-9 Reports

12.2 Take Inventory

Dashboards allow you to summarize system health information by combining view components onto one or more pages that are visible to the user.

Before creating any dashboards, you should understand the available inventory and assets that you would like to display in the dashboards. To take inventory:

1. Navigate to Reports > Inventory > <Module>.

Figure 12-10 Reports > Inventory > Avaya CM

2. An inventory list appears. You can click on each of these items in the list and drill down to view inventory details.

Figure 12-11 Reports > Inventory > Avaya CM

3. You can also view element details by navigating to Health > Elements and selecting an element category such as Agents.

Figure 12-12 Health > Elements

4. Select one of the following elements and drill down to view details:
   • Folders
   • Chassis
   • Subnets
   • Agents
   • Poll Functions
   • Element Registry

Figure 12-13 Elements

5. You can also take an inventory by viewing existing dashboards. Navigate to Dashboards > Dashboard. Gathering this information will better prepare you to configure and manage your dashboards.

12.3 Load Existing Dashboards

To load an existing dashboard:

1. Navigate to Dashboards > Dashboard:

Figure 12-14 Dashboards > Dashboard

2. Click the Configure Dashboard icon in the top right corner of the Dashboards page.

Figure 12-15 Configure Dashboard Button

3. The Load Dashboard window appears where you can select a dashboard to view. Then, click Load.

Figure 12-16 Load Dashboard

12.4 Copy Dashboards from other RIGs Using Dashboard Packs

If you have a dashboard set up on an existing RIG and want to copy it to another RIG, you can do so using the Dashboard feature:

1. Navigate to Configure > Dashboard:

Figure 12-17 Configure > Dashboard

2. A list of existing dashboards appear in the Configure Dashboard panel.
3. Select the dashboard you want to load onto another RIG. Use the CTRL key to select multiple dashboards.
4. Right-click and select Export:

Figure 12-18 Export Dashboards

5. Navigate to a location where you can temporarily save the exported dashboard and then click Save:

Figure 12-19 Save Exported Dashboard

6. Access the new RIG to which you will import the dashboard(s) you exported.
7. Navigate to Dashboards > Configure Dashboard.
8. Right-click in the Configure Dashboard panel and select Import:

Figure 12-20 Import Dashboard

9. The Open dialog appears (similar to the Save dialog), where you can browse to the dashboard file you saved earlier. Click Open to begin the import process.
10. The selected dashboard(s) are imported into the new RIG and can be accessed in the Configure Dashboard panel.

12.5 Configure a New Dashboard

To begin configuring dashboards:

1. Navigate to Configure > Dashboard.

Figure 12-21 Configure > Dashboard

The Configure Dashboard page appears:

Figure 12-22 Configure Dashboard

2. Right click anywhere in the left Configure Dashboard panel, and select Add in the menu:

Figure 12-23 Add New Dashboard

3. In the Add Dashboard window, enter a name for the new dashboard and then click Add:

Figure 12-24 Add Dashboard Window

12.5.1 Dashboard Layout

To begin configuring the dashboard’s layout, select the Layout radio button in the top right corner of the Configure Dashboard page to enter Layout Mode.

Figure 12-25 Layout Radio Button

Create Containers

Create a new container by using your mouse in the white space. Press your right mouse button and drag a container line (red highlighted line) to create as many containers as you want to create of any size. You will define the container properties in Dashboard Content.

Figure 12-26 Create Container

Container Menu

You can also right click on any container in the Layout panel to display a menu with these options:

Figure 12-27 Layout Menu

• Copy: Select this to copy the selected container. Then, right click where you want to place it in the Layout panel and select Paste from the menu.
• Delete: Select this to delete the current container.
• Split Container: Select this to invoke the Split Dashboard Cell window where you can split up the current container into a specified number of evenly shaped rows and columns. You can also configure the horizontal and vertical gaps. Click Split to invoke the split

Figure 12-28 Split Dashboard Cell

Repositioning Containers

You can also reposition containers within Layout Mode by dragging and dropping them into the position where you want them.

Snapping Check Box

Select the Snapping check box to assist you in lining up your containers.

Figure 12-29 Snapping

12.5.2 Dashboard Content

To configure the dashboard’s content:

1. Select the Content radio button in the top right corner of the Configure Dashboard page to enter Content Mode.

Figure 12-30 Content Mode

2. To assign a component to a container, place your cursor in the top portion of the container (indicated in this figure with a red box). This displays the Dashboard Component window, where you will select a component to assign to this container. Then, click Apply:

Figure 12-31 Assign Dashboard Component

3. In Content Mode, you can edit the content of the various containers by clicking the Edit icon and changing details in the resulting window:

Figure 12-32 Edit Element

12.5.3 Dashboard Elements

To manage the elements that are displayed in a given dashboard:

1. Click the Elements button in the top right corner of the Configure Dashboard page.

Figure 12-33 Elements Button

2. The Elements window appears, where you can drill down to a particular element within the Element Registry.
3. Then, right click on an element and view the following options:
   • Remove Device: Select this to remove a device from the Element Registry.
   • Insert Event: Select this option to add an event for this particular element in the Alert Properties window. Enter the Event ID, select the alert level, and click Send Alert.

Figure 12-34 Alert Properties

• Insert Element: Select this option to insert a new element in the Element Registry.

Figure 12-35 Elements Window

4. To populate the dashboard, you can drag and drop an element from the Elements window into the dashboard.

12.5.4 Dashboard Tabs

A dashboard can display a variety of tabs with different details within a single dashboard:

Figure 12-36 Dashboard Tabs

To manage the dashboard tabs:

1. Follow the steps in Configure a New Dashboard.
2. Click the Tabs button in the upper right corner of the page:

Figure 12-37 Tabs Button

3. The Manage Dashboard Tabs window appears, where you can select any dashboard on that RIG to display as a tab within that dashboard by moving from the left column to the right column. You can also rename the dashboard tabs.

Figure 12-38 Manage Dashboard Tabs Window

4. Double click a dashboard tab in the left Available Dashboards column. The Dashboard Link Label window appears:

Figure 12-39 Dashboard Link Label Window

5. To rename the Dashboard tab name, enter the new name in the Dashboard Link Label field and click Set.
6. In the Manage Dashboard Tabs window, click Apply to apply your changes.

12.5.5 Clear Containers

To clear out all containers and provide a clean workspace:

1. Make sure you are in Layout Mode.
2. Click the Clear button in the upper right corner of the page:

Figure 12-40 Clear Button

12.5.6 Save Dashboard Changes

After creating or editing a dashboard tab, be sure to save your changes to the dashboard.

1. After you have made changes, click the Save button.

Figure 12-41 Save Button

The Save Dashboard window appears:

Figure 12-42 Save Confirmation

2. Click Save to save the dashboard. You can also save the dashboard under a new name by entering the name in the Dashboard Name field before clicking Save.

12.5.7 Undo or Redo Dashboard Changes

You can use the Undo or Redo buttons to undo/redo changes you have made to a dashboard before clicking Save.

Figure 12-43 Undo/Redo Buttons

12.5.8 Remove a Dashboard

To remove a dashboard:

1. Highlight the dashboard you want to remove in the left Configure Dashboard panel.
2. Right click and select Remove in the menu:

Figure 12-44 Remove Dashboard

3. In the Removal Confirmation window, click Yes to remove the Dashboard.

Figure 12-45 Removal Confirmation

12.5.9 Edit Icon

You can dashboard component and lists by clicking the Edit icon. This will launch the window associated with the component or list where you can change details.

Figure 12-46 Edit Buttons

For example:

Figure 12-47 Edit Round Dial

12.6 Maps

1. To access Maps, navigate to Dashboards > Maps.

Figure 12-48 Dashboards > Maps

A list of available Maps is displayed in the left pane:

Figure 12-49 List of Maps

2. Double click on a Map Name to view map details for that RIG location in the right pane:

Figure 12-50 Example Map

12.6.1 Edit Maps

To enter Edit Mode:

1. Click the Edit radio button in the top left corner of the window:

Figure 12-51 Edit Map

2. In Edit Mode, you can:
   • Drag and drop existing map components to rearrange them and resize them as needed.
   • Drag up the bottom bar under a map to see a list of components. You can then drill down to a particular component and drag it into the map.

Figure 12-52 Drag Bottom Bar Up and View Map Components to Drag into Edit Map Layout

• Change the details of a map component by right clicking and selecting Edit Node Properties. For example, right clicking on this map component displays a menu with these options:

Figure 12-53 Edit Node Properties

• Edit Node Properties: Change the component’s properties.
• Remove: Remove the component all together.
• Send to Back: Send this particular element to the back (in terms of visual layers). This places the element behind other elements.
• Bring to Front: Bring this particular element to the front (in terms of visual layers). This places the element in front of other elements.
• Image: Change an existing or upload a new image for this component.
• Edit a connection between map elements by right clicking on the connection line and selecting one of the following options:

Figure 12-54 Edit Connections

• Add Path Point: Add a new path point to the connection.
• Remove All Path Points Remove all connection path points.
• Remove Connections: Remove all connections.
• Properties Configure connection properties.

12.6.2 Other Map Options

The following map options are also available:

Figure 12-55 Other Map Options

1. Snap: Select this check box to display the grid lines so you can line things up in the map as you move them around.

2. Fit on Screen: Click this button to resize the map so that it fits on your screen.

3. Overall View: Click this button to display the overall view of the map in the bottom right corner of the window. This is useful for especially large maps.

4. Options: Click this button to display two options:

   a. Image Library: Select this to access the image library to import images into your map.

   b. Alert Expressions: Select this to add connection and node alerts to your map.

12.6.3 Add a New Map

1. To add a new map, navigate to Dashboards > Maps.

Figure 12-56 Dashboards > Maps

2. In the Maps list, right click and select Add from the menu:

Figure 12-57 Maps > Add

3. In the Add New Map window, enter a meaningful name for the map:

Figure 12-58 Add New Map

4. Locate and click on the new map name in the Maps list to the left.
5. In the right pane, right click to display the Maps menu, which has these options:

Figure 12-59 Maps Menu

• Fit to screen: Select this option so that the map fits on your screen.
• Layout Wizard > Grid Layout: Select this option to display the Grid Layout Window window where you can adjust:
  • Grid Layout Width
  • Grid Layout Height
  • Relative Spacing
  • None (No Grid)
  • Smallest (Smallest Grid)
  • Largest (Largest Grid)
  • Click OK when you have made your changes.

Figure 12-60 Grid Layout Wizard

• Add Label: Select this option to add a text label to the map.
• Remove All: Select this option to remove all map elements

12.6.4 Remove a Map

1. To remove a new map, navigate to Dashboards > Maps.

Figure 12-61 Dashboards > Maps

2. In the Maps list, right click on the desired map and select Remove from the menu:

Figure 12-62 Maps > Remove

The map is removed from the system.

12.6.5 Copy Maps

You can copy an existing map, rename it, and save it as a new map to simplify the map creation process.

1. To copy a map, navigate to Dashboards > Maps.

Figure 12-63 Dashboards > Maps

2. In the Maps list, right click on the desired map and select Copy Map from the menu:

Figure 12-64 Maps > Copy Map

3. In the New Name window, enter a name for the new map and then click OK.

Figure 12-65 New Name Window

The new map is added to the Maps list.

12.7 View a Map in a Dashboard

To view a map in a dashboard:

1. Create a container, as discussed in Dashboard Layout.
2. Select the Content radio button in the top right corner of the Configure Dashboard page to enter Content Mode.

Figure 12-66 Content Mode

3. Place your cursor in the top portion of the container (indicated in this figure with a red box). This displays the Dashboard Component window, where you will select the Map component and click Apply.

Figure 12-67 Assign Map Component

4. Define the Map container by clicking the Edit icon and defining details in the resulting window:

Figure 12-68 Edit Map Container

13. Configure Vendor Knowledge Script

A Vendor Knowledge Script (VKS) is a single-application monitoring knowledge base built to support specific, purpose-built applications.

Configuring Vendor Knowledge Scripts include the following tasks:

• Enable VKS
• Add an Agent
• Import VKS
• Give Specific Device Types Access to the VKS
• Associate VKS

13.1 Enable VKS

You must enable the Knowledge Script module.

1. Log in to the RIG.
2. Navigate to RIG > Module Configuration.

Figure 13-1 RIG > Module Configuration

3. In the Module Configuration window, select Knowledge Script under Premium Modules.

Figure 13-2 Enable Knowledge Script

4. Click Apply.

5. Restart the RIG and apply the changes.

   a. Navigate to RIG > Admin > Restart.

   b. When the following message appears, click Yes.

Figure 13-3 Restart

13.2 Add an Agent

Note: This section can be skipped if the agent already exists.

1. Click on the Health menu and select Elements.

Figure 13-4 Health Menu

2. When the Elements window appears, click Agents.
3. Right-click anywhere in the All Agents pane and select Add.

Figure 13-5 Add Agent

The Add Agent window appears.

Figure 13-6 Add Agent

4. Populate the fields in the Add Agent window.

5. Click OK.

The new agent appears in the All Agents pane.

13.3 Import VKS

Note: The VKS only needs to be imported once. It can then be applied to multiple devices.

1. Click on the Configure Menu and select Knowledge Script.

Figure 13-7 Configure Knowledge Scripts

2. Right-click anywhere in the Knowledge Script pane and select Import.

Figure 13-8 Import Knowledge Script

3. Browse to the VKS file you wish to import through your Windows Explorer and double-click on, or select the file and click Open.

Figure 13-9 Select VKS file

Note: At this point, your VKS is added and now appears in the Knowledge Scripts

pane.

Figure 13-10 Added VKS

13.4 Give Specific Device Types Access to the VKS

Now that the VKS has been added, you need to set up the devices that can be associated with this VKS to prevent improper association with incompatible devices.

1. With the applicable VKS selected, select the Devices tab
2. Right-click anywhere in the Supported Devices pane and select Add.

Figure 13-11 Add Device

3. When the Add Supported Devices window appears, click on the ... to the right of the System Object ID.

Figure 13-12 More Button

4. Search for the Agent to be associated with this VKS. This action also sets up the Object ID for the device type.
5. Select the agent and click Select.

Figure 13-13 Select Agent

The System Object ID will auto-populate.

6. Click Ok.

Figure 13-14 Add Supported Device

The System Object ID, agent, and VKS now appear in the Supported Device pane.

Note: The OID is not unique for the agent. However, it is unique for the version of the VKS or host/device type.

Figure 13-15 Supported Device Added

13.5 Associate VKS

Now you need to associate the agent with the VKS in order to begin polling data.

1. Click on the Health menu and select Elements.

Figure 13-16 Health Menu

2. When the Elements window appears, click Agents.
3. Select the agent in the All Agents pane; then right-click and select Associate Knowledge Scripts.

Figure 13-17 Associate Knowledge Script

4. Select the applicable VKS and click the Add button.

Figure 13-18 Add/Remove VKS

5. Once the VKS is added, click Done.

Figure 13-19 Added VKS

At this point, Poll Functions are now available and displayed in the Poll Functions pane.

Figure 13-20 Poll Functions Displayed

14. Manage Poll Functions

Nectar Foundation APM monitoring provides the basic building blocks on element health and availability statistics, such as CPU, disk, and memory usage, process alerts, and trending of statistical information over time.

This section explains how to:

• Import/Export Poller Packs
• View Poll Functions
• Add Poll Functions - PowerShell Example
• Enable or Disable Poll Functions
• Edit Poll Functions
• Remove Poll Functions
• Export Poll Functions

Note: In order to add PowerShell-based poll functions, you must first create a domain account, configure permissions, and add and configure the agent. For more information, see:

• Add Poll Functions - PowerShell Example

• Create a New Domain Account in the Active Directory

• Add and Configure the Agent for PowerShell

14.1 Import/Export Poller Packs

Poller packs are groupings of pollers. They allow you to monitor and manage any specific manufacturer infrastructure or application through the use of logical pollers. Once created, you can import/export poller packs across customer RIGs. This allows you to easily onboard additional assets from the manufacturer or application.

14.1.1 Import Poller Packs

Follow these steps to import a poller pack into your RIG:

1. Navigate to Configure > Poll Functions:

Figure 14-1 Configure > Poll Functions

2. Right-click in the Poll Functions pane and select Load Pack:

Figure 14-2 Load Pack

The Open window appears:

Figure 14-3 Open Window

3. Browse to the information (poller) pack and click Open to load it onto your RIG.

   A status window appears temporarily letting you know that the information (poller) pack is loading.

   After it is loaded, you can see it in the Poll Functions pane.

14.1.2 Export Poller Packs

Follow these steps to export a poller pack from your RIG:

1. Navigate to Configure > Poll Functions:

Figure 14-4 Configure > Poll Functions

2. Select the poller pack(s) you want to export (for use in another RIG) in the Poll Functions pane.

Note: You can also use the Ctrl and Shift keys to select multiple poller packs in the Poll Functions pane.

Figure 14-5 Select Poller Packs to Export

3. Right-click on the selected poller packs and select Save Pack.

Figure 14-6 Save Poller Packs to Export

The Save Packs? window appears:

Figure 14-7 Save Packs

4. Click Save to save the poller packs.

   The Save window appears where you can browse to a location to store the poller packs:

Figure 14-8 Save Window

5. Click Save.

   The Saving Custom Poller Pack window temporarily appears while the poller pack is exporting.

14.2 View Poll Functions

Follow these steps to view a list of poll function for a RIG and its agents:

1. Navigate to Health > Elements.

Figure 14-9 Health > Elements

The Elements window appears.

2. Select Poll Functions.

   A list of agents appears under Poll Functions.

Figure 14-10 Poll Functions

14.3 Add Poll Functions - PowerShell Example

To add PowerShell-based poll functions, you must first:

• Create a New Domain Account in the Active Directory
• Add Local Administrator Permissions to Domain Account
• Add and Configure the Agent for PowerShell
• Add the PowerShell-Based Performance Poll Functions

14.3.1 Create a New Domain Account in the Active Directory

Follow these steps to create a new user in the Active Directory (AD):

1. Log on to your Domain Controller.
2. Open Active Directory Users and Computers with an account that has permissions to create new user accounts and assign permissions.
3. Right-click on your domain and select New > User.

Figure 14-11 Add New User

The New Object - User window appears:

Figure 14-12 New Object - User

4. Enter the following information about the new user:

Table 14-1 New User

5. Click Next.

   The New Object - User window appears.

Figure 14-13 Add Password

6. Enter your Password; then confirm your password.

7. Click Password Never Expires.

8. Uncheck any other boxes, if applicable.

9. Click Next; then click Finish.

   A new user is added for the PowerShell remoting.

Figure 14-14 New User

14.3.2 Add Local Administrator Permissions to Domain Account

Follow these steps to add local administrator permissions to the newly created domain account on each of the agents for which you will create a performance counter poller.

Note: You must have local administrator permissions on all servers.

1. Log on to a Windows server.
2. Navigate to Local Users and Groups (Local) > Groups > Administrators.

Figure 14-15 Local Users and Groups (Local) > Groups > Administrators

The Administrators Properties window appears.

Figure 14-16 Administrators Properties

3. Click Add.

   The Select Users, Computers, Service Accounts, or Groups window appears.

Figure 14-17 Select Users, Computers, Service Accounts, or Groups

4. Enter the domain user previously added, such as plano; then click Check Names to search and complete the user name.
5. Click OK.
6. Repeat this process for each Windows server or machine.

14.3.3 Add and Configure the Agent for PowerShell

To add and configure an agent for PowerShell-based performance counter pollers, perform these tasks:

• Add an Agent
• Configure the Agent

Add an Agent

Before you can create and configure PowerShell-based performance counter pollers, you must add an agent for each remote Windows server or device from which you want to collect performance counter values.

Follow these steps to add an agent:

1. Navigate to Health > Elements.

   The Elements window appears.

2. Click Agents to view a list of agents.

Figure 14-18 Elements - Agents

3. Right-click in the All Agents pane and select Add.

Figure 14-19 Select Add

The Add Agent window appears.

Figure 14-20 Add Agent

4. Enter the Name and IP address for the new agent; then click OK.

   The new agent is added to the list of agents in the All Agents pane.

Note: You can also enter the following optional information for the new agent.

Table 14-2 Add an Agent

Configure the Agent

After adding a new agent, you must edit the properties for the agent to add the PowerShell remoting properties.

Follow these steps to configure an agent:

1. Navigate to Health > Elements > Agents.

   A list of agents appears.

2. In the All Agents panel, select the agent on which you are adding PowerShell remoting properties.

3. Right-click on the agent and select Edit.

Figure 14-21 Edit

4. In the Edit Agent window, select the Properties tab.

Figure 14-22 Edit Agent - Properties Tab

5. In the Properties tab, click Add to display the Add Property window:

Figure 14-23 Add Property

6. Add the following PowerShell properties by entering their Name (such as powershell.domain) and associated Value in the Add Properties window. This populates the Properties tab with their names and values.

Note: For this step, you will use the domain account information created in Create a New Domain Account in the Active Directory.

• powershell.domain

• powershell.host

• powershell.password

• powershell.user

  For more information on adding a domain user, see Create a New Domain Account in the Active Directory.

  When you have completed this step, your window will look like the following (this is an example only):

Figure 14-24 Powershell Properties - Examples

7. When you have added all properties, click OK to close the Add Property window.
8. Click OK to close the Edit Agent window.

14.3.4 Add the PowerShell-Based Performance Poll Functions

Nectar Foundation APM provides access to a number of poll function counters. We will discuss the following poll function counters in this section, as an example.

Follow these steps to enable or disable a poll function:

1. Navigate to Health > Element.
2. In the left pane, select Agents.
3. In the All Agents pane, select the agent that you configured in Add and Configure the Agent for PowerShell.
4. In the Poll Functions pane, right-click anywhere and select Add.

Figure 14-25 Add Poll Function

The Add Poll Function window appears.

In the next sections, we use this window to create a Windows Performance Counter Poller and Windows PowerShell Script Based Poller. See:

• Windows Performance Counter Poller
• Windows PowerShell Script Based Poller

Windows Performance Counter Poller

The Windows Performance Counter Poller communicates with the PowerShell-configured agent and obtains all of the available performance counters.

1. After clicking Add in Add the PowerShell-Based Performance Poll Functions:

   a. Open the Other folder in the Add Poll Function window.

   b. Select the Windows Performance Counter Poller (via PowerShell) option.

   c. Click Next.

Note: You can enter a poller name (partial or complete) in the search field at the top to search for a particular poller.

Figure 14-26 Add Poll Function

2. In Parameters tab of the Add Windows Counter dialog, select a Windows Counter option, such as Memory Available Bytes.
3. Click Add.

Note: You can use the Filter field to filter your results by entering a partial or complete parameter name.

Figure 14-27 Memory Available Bytes

The Memory Available Bytes counter is added in the poll function list:

Figure 14-28 Memory Available Bytes

Windows PowerShell Script Based Poller

1. After clicking Add in Add the PowerShell-Based Performance Poll Functions:

   a. Open the Other folder in the Add Poller Function window.

   b. Select the Windows PowerShell Script Based Poller option.

   c. Click Next.

Note: You can enter a poller name (partial or complete) in the search field at the top to search for a particular poller.

Figure 14-29 Add Poll Function

Note: In order for this to function correctly, make sure you have set up a Scripts folder. This is where you will place your PowerShell scripts that are displayed in this list.

• Go to your Nectar server installation location.

• Search for the apps/nectar/etc folder and locate the scripts folder. Create it, if it does not exist.

Note: In order for a PowerShell script to be made available in a poller, it must produce a single numeric output value.

A list of PowerShell scripts that are available on the server are displayed in the Add PowerShell Script Poller dialog:

Figure 14-30 Add PowerShell Script Pollers

2. Highlight a PowerShell script; then click Add.
3. In the Poll Functions pane, you can view the poller and its functions that were created by the PowerShell script(s) you added:

Figure 14-31 Added PowerShell Script

Multi-instance Counters

In the Parameters tab, multi-instance counters are indicated in the list by (*) in the name as follows:

Figure 14-32 Multi-instance Counters

1. Double-click on a multi-instance counter to view all of the counters within that multi-instance counter:

Figure 14-33 All Counters within a Multi-Instance Counter

2. Highlight both of the counters and the Select button at the bottom of the window to create a poll function for these. The poll functions are displayed in the Poll Functions pane:

Figure 14-34 New Poll Functions

14.4 Enable or Disable Poll Functions

Follow these steps to enable or disable a poll function:

1. Navigate to Health > Element > Poll Functions.
2. Right-click on a poll function and select Enable or Disable.

Figure 14-35 Enable or Disable Poller Function

The poll function Enabled column shows true for enabled poll functions or false for disabled poll functions.

Figure 14-36 Poll Function True/False Status

14.5 Edit Poll Functions

Follow these steps to edit a poll function:

1. Navigate to Health > Element > Poll Functions.
2. Right-click on a poll function and select Edit.

Figure 14-37 Edit

The Edit Poll Functions - Parameters window appears.

Figure 14-38 Edit Poll Functions

3. On the Parameters tab, make changes to the values, as needed.
4. Click the Thresholds tab; then click Add to add threshold values, as needed.

Figure 14-39 Threshold Tab

5. Click Update.

14.6 Remove Poll Functions

Follow these steps to remove a poll function:

1. Navigate to Health > Element > Poll Functions.
2. Right-click on a poll function and select Remove:

Figure 14-40 Remove

The Remove Poll Functions? window appears.

Figure 14-41 Remove Poll Functions?

3. Click Remove.

14.7 Export Poll Functions

Follow these steps to export poll functions:

1. Navigate to Health > Element > Poll Functions.
2. Right-click on a poll function and select Export Poll Metrics.

Figure 14-42 Export Poll Metrics

The Export Poller Metrics window appears.

Figure 14-43 Export Poller Metrics

3. Complete the following fields:

Table 14-3 Poll Function Export

4. Click Start to begin th export.

15. Configure Network Monitors

The RIG is able to collect metrics for various processes, and these are managed in the Elements module and viewed in the Dashboard module.

This section explains how to:

• Overview
• Manage Agents
• Run SNMP Tools
• Run Host Wizard
• View Statistical Collections and Performance Data
• Manage Thresholds
• View Polling Metric Chart
• Manage Interfaces

15.1 Overview

The Element system contains a grouping function called Agents for all collections to be performed against a target device. You can define an agent and associate all interrogation requests for that target with the agent, such as SNMP, ICMP, and other available types.

There are also different collections leveraged for various equipment types. As additional agents are added, they are also re-ordered numerically first, then alphabetically.

To access Agents, navigate to Health > Element.

Figure 15-1 Health > Elements

When the Elements window appears, select Agents in this list.

Figure 15-2 Elements

To access polling, select an agent in the All Agents list and view the poll functions.

Figure 15-3 Poll Functions

Different statistics can also be collected at distinctive intervals to ensure smooth and unified polling, while maintaining the appropriate performance data sets for different measurements. If a poll function is configured to store the metric data, then the data can be viewed in chart form by double-clicking the poll function entry.

Nectar Foundation APM incorporates several standard event and performance management functions found in a variety of commercial solutions available today. Many unique features in the form of distribution and remote monitoring and management enhance Nectar Foundation APM’s ability to scale past standard commercial packages when deployed for Service Providers.

15.2 Manage Agents

This section explains how to manage agents, including:

• Add a New Agent
• Edit an Agent
• Remove an Agent

15.2.1 Add a New Agent

Note: The Import from CSV option allows you to import multiple agents and their properties.

Follow these steps to add a new agent:

1. Navigate to Health > Element > Agents.

   A list of agents appears.

Figure 15-4 Add Agent

2. Right-click in the All Agents panel and click Add.

   The Add Agent window appears.

Figure 15-5 Add Agent

3. Complete the following fields:

Table 15-1 Add Agent

4. Click OK.

   The new agent is added to the list of agents in the All Agents pane.

15.2.2 Edit an Agent

Follow these steps to edit an agent:

1. Navigate to Health > Element > Agents.

   A list of agents appears.

Figure 15-6 Edit Agent

2. Right-click on an agent and select Edit.

   The Edit Agent window appears.

Figure 15-7 Edit Agent

3. Make changes, as needed; then click OK.

   The agent is updated with new data.

15.2.3 Remove an Agent

Follow these steps to remove an agent:

1. Navigate to Health > Element > Agents.

   A list of agents appears.

Figure 15-8 Remove Agent

2. Right-click on an agent and select Remove.

   The Remove Elements dialog box appears with the following message:

Figure 15-9 Remove Elements

3. Click Remove.

   The agent is removed from the list of agents in the All Agents pane.

15.3 Run SNMP Tools

After an agent is created, a wizard identifies available objects to be monitored.

Follow these steps to run the SNMP Tools:

1. Navigate to Health > Element > Agents.

   A list of agents appears.

Figure 15-10 SNMP Tools

2. Right-click on an agent and select SNMP Tools.

   The SNMP window appears.

Figure 15-11 SNMP Tools

3. Select one of the following three SNMP tools:

Table 15-2 SNMP Tools

15.3.1 SNMP Walk

When you decide that you want to write an SNMP monitoring application for a given device you need to start by understanding what is available to you. You can use the SNMP Walk tool to do this.

1. Click the SNMP Walk button.

   The SNMP Walk window appears to the right.

Figure 15-12 SNMP Walk

2. Complete the following fields:

Table 15-3 SNMP Walk

3. Click one of the following:

Table 15-4 Buttons

15.3.2 SNMP v1 Trap

SNMP v1 Trap messages are alerts generated by agents on a managed device.

Follow these steps to send an SNMP v1 Trap message from the agent:

1. Click the SNMP v1 Trap button.
2. The SNMP v1 Trap window appears to the right.

Figure 15-13 SNMP v1 Trap

3. Complete the following fields:

Table 15-5 SNMP v1

4. Click Send Trap to send the SNMP v1 trap message.

15.3.3 Import SNMP MIB

You can import an SNMP MIB file to create custom pollers and packs:

1. Click the Import button.

   The Open dialog box appears.

2. Browse to the location of the SNMP MIB file that you want to import.

Note: The file must be a Vendor Enterprise (.MIB) file.

3. Select the file; then click Open.

   The SNMP Import window appears with a list of the OId (Object Identifiers) for the selected MIB appears.

Figure 15-14 SNMP Import - Create Traps

4. Select the desired Traps; then click Create Traps.

   This sends the Trap definition to the Nectar Foundation APM Trap Receiver.

5. After making your selections, click Next to view the SNMP Import - Create Pollers window.

Figure 15-15 SNMP Import - Create Pollers

6. Select the desired pollers.

7. Select the Gauge or Counter option using the drop-down; then click Create Pollers.

   This adds the corresponding pollers to the Adjunct Pollers list for each agent.

8. Click Next to view a list of created pollers.

Figure 15-16 Import MIB

15.4 Run Host Wizard

After adding an agent, you can use the Host Wizard to create pollers to gather data for the agent. The Host Wizard helps you identify available objects to be monitored.

Follow these steps to run the Host Agent wizard:

1. Navigate to Health > Element > Agents.

   A list of agents appears.

*Figure 15-17 *

2. Right-click on an agent and select Host Wizard.

   The Host Wizard - Create Pollers for Agent Resources window appears.

Figure 15-18 Host Wizard

3. Complete the following; then click Next:

Table 15-6 Host Wizard

Note: The operating system is automatically detected by the RIG according to the file system formatting and process/service list returned from the host.

The Host Wizard - Disks/Memory window appears.

Figure 15-19 Host Wizard - Disks/Memory

4. Select the disks/memory for which you will create pollers; then click Next.

Note: You can select more than one option using the Ctrl key.

The Host Wizard - Services window appears.

Note: When Windows is selected as the Host Operating System in the Host Wizard - Create Pollers for Agent Resources page, the Host Wizard - Services window appears. When any other operating system is selected, the Host Wizard - Processes window appears, where you can select processes instead of services.

Figure 15-20 Host Wizard - Services

5. Select the services for which you will create pollers; then click Next.

Note: You can select more than one option using the Ctrl key.

The Host Wizard - Layer 3 Status (Ping) window appears.

Figure 15-21 Host Wizard - Layer 3 Status (Ping)

6. Select the Layer 3 status ping entries for which you will create pollers; then click Next.

Note: You can select more than one option using the Ctrl key.

The Host Wizard - Layer 2 status page appears.

Figure 15-22 Host Wizard - Layer 2 Status

7. Select the Layer 2 Status ping entries for which you will create pollers.

Note: You can select more than one option using the Ctrl key.

8. Click Finish.

   Pollers are now created according to your selections.

15.5 View Statistical Collections and Performance Data

Nectar Foundation APM employs normalization tactics to reduce the reliance of vendor or technology specific context. This allows for a Service Provider to increase the ability for lower responder tiers to make decisions and employ resolutions more easily, because information is presented in the context of the collection.

In addition to normalization, Nectar Foundation APM also allows for instant replay into history of real-time monitor views of any statistical collections. The operator can establish collection frequency and retention standards within the platform by customer, location, class of device, or individual elements. These capabilities aid both operators and customers, so information can be viewed in the context of capacity and capabilities.

For information on managing poll functions (which are used in this section), see Manage Poll Functions.

15.5.1 Example: Parameters - Ping

The following example tests whether a particular host is reachable across an IP network.

1. Navigate to Health > Elements.

Figure 15-23 Health > Elements

2. Click Folders.
3. Select a Root Folder.
4. Select Infrastructure.
5. Select a Poll Function.

Figure 15-24 Folders > Root Folder > Infrastructure > Poll Function

6. Right-click on a Poll Function and click Add in the menu.

Figure 15-25 Add Poll Function

The Add Poll Function window appears.

Figure 15-26 Add Poll Function

7. Enter Ping in the Search field; then select Ping and click Next.

Figure 15-27 Add Poller Function - Select Ping

The Parameters tab appears.

Figure 15-28 Add Ping Function - Parameters Tab

8. Enter the following; then click Add.

Table 15-7 Add Ping Function

You can click the Thresholds tab and modify the thresholds of any poll function.

• Some poll functions, such as the Ping function, automatically have associated thresholds.
• You can choose to have the poll function generate an event based on the results of the task.
• Each poll function returns a number as a result of its task. For example, the Ping poll function returns 1, if the destination is reachable, and -1, if the destination does not reply.
• Usage monitors return the current utilization of the network element they are sampling.

15.5.2 Example: Parameters - CPU Utilization Process

The following example tests CPU Utilization Process.

1. Follow steps 1-6 in Example: Parameters - Ping.

   The Add Poll Function window appears.

Figure 15-29 Add Poll Function

2. Enter CPU Utilization Process in the Search field; then select CPU Utilization Process and click Next.

Figure 15-30 Add Poller Function - Select Ping

The Parameters tab appears.

Figure 15-31 Add CPU Utilization Process

3. Enter the following information; then click Add.

Table 15-8 CPU Utilization Parameters

4. Click Add to commit the data.

Edit Compression

Follow these steps to select a different compression:

1. Click ... to the right of the Compression field.

   The Edit Compression window appears. The default is set as [Do Not Store].

Figure 15-32 Edit Compression

2. Select one of the following compression strategies, such as 1 Week; then click Select.

   • 1 Week

   • 2 Weeks

   • 1 Month

   • 3 Months

     The Parameters tab appears with the new compression.

Figure 15-33 New Compression

View Compression Strategies

Follow these steps to view the available compression strategies:

1. From the Edit Compression window, click Edit.

Figure 15-34 Click Edit

The Edit Compression Strategies window appears.

Figure 15-35 Edit Compression Strategy

When you select a compression strategy on the left, such as 3 Months, you can view the compression rules for that strategy to the right. These are also called Strategy Legs.

Figure 15-36 Edit Compression Strategies

3 Months

This strategy stores three months of data:

• After one week (7 days), average data to five-minute clusters.
• After one month (30 Days) average data to one hour clusters.
• After three months (90 days) delete the data.

Figure 15-37 Example - 3 Months

Note: Storing data over one month creates limitations on data storage. Be sure to set up the appropriate compression strategies.

2 Weeks

This strategy has two legs and instructs to keep the data for 14 days with the following rules:

• After one week, compress the data to 5 minutes.
• After two weeks, delete the data.

Figure 15-38 Example - 2 Weeks

1 Week

This strategy has one leg that instructs to keep the data for seven days; then delete.

Figure 15-39 Example - 1 Week

1 Month

This strategy has two legs and instructs to keep the data for 30 days with the following rules:

• After one week, compress the data to 5 minutes.
• After one month, delete the data.

Figure 15-40 Example - 1 Month

Modify a Compression Strategy

You can edit a compression strategy by adding or removing the strategy legs.

Follow these steps to edit a compression strategy:

1. From the Edit Compression Strategies window, select a strategy.
2. Right-click in the Strategy Leg area (see Figure 15-41)and select New Strategy Leg from the menu.

Figure 15-41 New Strategy Leg

The Add Compress Function window appears.

Figure 15-42 Add Compress Function

3. Select the up and down arrows to the right of each field or manually enter the Days, Hours, and Minutes for the new strategy leg.

4. Define the Compress To time allotment using the drop-down.

5. Click Add.

   The new strategy leg is displayed for the compression strategy.

6. Close the window by selecting the X in the upper right corner of the window.

   The Edit Compression window re-appears.

7. Highlight the strategy; then click Select.

8. Close the Edit Compression window.

   The Parameters tab appears.

Figure 15-43 New Compression

9. Confirm that the new strategy is displayed in the Compression field.
10. Click Add to complete the process.

Remove a Strategy Leg

Follow these steps to remove a strategy leg from a compression strategy:

1. From the Edit Compression Strategies window, select the compression strategy you want to modify in the Name column on the left; then view the strategy legs for that strategy on the right.
2. Select the strategy leg that you want to remove.
3. Right-click and select Remove Strategy Leg to delete the rule/condition from the compression strategy.

Remove a Compression Strategy

Follow these steps to remove a compression strategy listed in the Name column:

1. From the Edit Compression Strategies window, select the strategy in the Name column to remove.

2. Right-click and select Remove Compression Strategy.

   The compression strategy is removed from the list of compression strategies.

15.6 Manage Thresholds

Thresholds are set to trigger events when certain instances occur. When metric data enters the system, it looks to match a threshold rule.

For example:

• When disk usage is greater than 90 percent, it is deemed a level 5 (red) alert.
• When the disk usage is greater than 60 percent, it ranks as a Level 3 (orange) alert.
• When the disk usage is greater than 30 percent, the alert is Level 2 (yellow).
• When the disk usage is always -1, it is deemed a Level 1 (green) alert.

This section explains how to manage thresholds, including:

• View Thresholds
• Add a Threshold
• Apply Bulk Edits

15.6.1 View Thresholds

Follow these steps to view thresholds:

1. Navigate to Health > Element.

Figure 15-44 Health > Elements

The Elements window appears.

Figure 15-45 Elements > Poll Functions

2. Click Poll Functions to view a list of poll functions.
3. Select a Poll Function; then right-click and select Edit from the menu.

Figure 15-46 Edit Poll Function

The Edit Poll Functions window appears.

4. Click the Thresholds tab.

Figure 15-47 Thresholds Tab

5. View the current thresholds for the poll function.

15.6.2 Add a Threshold

Follow these steps to add a new threshold:

1. Click Add.

Figure 15-48 Add Threshold

2. Enter the following information; then select Update:

Field	Description
Function	Select a matching function using the drop-down: • =: Poll task return equals the given value. • !=: Poll task return does not equal the given value. • >: Poll task return is greater than the given value. • <: Poll task return is less than the given value. • Always: Threshold entry always matches. • %>: Percentage of the poll task return is calculated using the maxValue for the poll function. If the percentage is greater than the given value, then the entry matches. • %<: Percentage of the poll task return is calculated using the maxValue for the poll function. If the percentage is less than the given value, then the entry matches.
Value	Numerical amount used with Function to trigger an event.
EventID	• Type of event that will be declared for this threshold. • There is no preset value for this field. • Enter a unique identifier for this event. • Identifier can be used in multiple pollers, if the results for their occurrence are the same.
Description	Enter a brief summary of the threshold.
Alert	Select the numerical color that identifies the importance of this alarm.
	Select to move the threshold up or down in order.

Table 15-9 Add Thresholds

15.6.3 Apply Bulk Edits

Bulk edits can be made to both Parameters and Thresholds by selecting more than one poll function:

Figure 15-49 Select Multiple Poll Functions

1. To use bulk edit, use one of the following to select multiple poll functions:

Table 15-10 Bulk Edits

2. With your selections highlighted, right-click and select Edit (as discussed earlier in this section).

Note: Changes committed using bulk edits will permanently adjust ALL selected poll functions.

The Edit Poll Functions - Parameters window appears (similar to the following) for a bulk edit:

Figure 15-50 Edit Poll Functions - Bulk Add

3. Enter new values, as needed, for the Parameters to make global adjustments to the selected poll functions; then click Update.

   For example, you may want to assign the same compression value for multiple poll functions or adjust the Frequency to poll every three minutes rather than every minute.

   Updates are only made to modified fields.

4. Click the Thresholds tab.

5. Click Add to create new thresholds.

   For more information, see Manage Thresholds.

6. Select Update.

Note: Making ANY bulk edits to Thresholds will permanently REMOVE all previously identified thresholds.

15.7 View Polling Metric Chart

Follow these steps to view the polling metric chart for a selected poll function:

1. From the Elements - Poll Functions window, double-click on a poll function to view the related chart.

Figure 15-51 Metric Chart

2. Select a Time Range using the drop-down or select All Data to pull a complete data retrieval.

   The bottom chart is a global perspective of the data.

3. Select Show Thresholds to include the polling function thresholds data.

4. Select Scale Relative to include data within a relative scale.

5. Click Reset to reset the data in the chart.

6. Click and drag the yellow line to expand or contract the amount of data that is shown in the graph.

   • To show the most data, click the left yellow bar and drag it to the far left; click the right yellow bar and drag it to the far right, as shown in Figure 15-51.
   • To view less data, click the left yellow bar and drag it to the right; click the right yellow bar and drag it to the left, as shown in Figure 15-52.

Figure 15-52 Metric Chart

15.8 Manage Interfaces

Manage Interfaces by entering the following information:

Table 15-11 Manage Interfaces

Follow these steps to verify that SNMP is working correctly:

1. Check the IP address and subnet mask.
2. Open a command prompt and run ipconfig:

Figure 15-53 Command Prompt

3. Evaluate both the IP address and subnet mask.
4. Hit a router using this. You will have multiple IP addresses to which the router answers.

16. Manage Events

Managing events includes the following tasks:

• View Events
• View Event Details
• Configure Events
• Manage Acknowledgments
• Manage Aggregate Alarms
• Manage Escalations
• Manage Event Delays
• Manage Event Forwarding

Events can be managed from the Summary View or Events window (navigate to Health > Events). Parameters for events are managed in Configure > Events.

16.1 View Events

When registering to a RIG, the registration process immediately displays the Summary window. This list-based view provides you with a quick glance of events that are triggered by a dependency tree or poller.

The Summary View can be used to translate critical system states and business processes, and the current status of the same to the Service Provider. Each of these can be used in managing service levels for the end-client.

Select an event; then right-click and select one the following options:

Figure 16-1 Summary - Options

Table 16-1 Event Options

Each event is highlighted in a color from the alarm key referenced in Status Summary. Use this key to identify the alarm criticality.

16.1.1 Dependency Trees

Dependency trees are created per Agent using available elements and Pollers from that location. The trees maintain a live view of each individual element status contributing to the relationships. For more information on dependency trees, see Dependency Tree Management.

For example:

1. Right-click on an event and select Show Dependency Tree.

   The View Dependency window appears.

Figure 16-2 View Dependency

2. View all nodes of the selected dependency tree.
3. Mouse-over one of the nodes to view details about the node.

Figure 16-3 Node Details

4. Click at the top to zoom into the tree; click to zoom out.

5. To view the events associated with a node in the dependency tree, click on a node.

   The related events appear in the bottom pane of the View Dependency window.

Figure 16-4 Details of Single Node Selection

6. Double-click an event in the bottom pane.

   The View Event pane appears to the right with details about the event.

Figure 16-5 View Event Details of Dependency Tree

7. Notice the Counter number and the Description summary.

Figure 16-6 View Counter and Description

The Description can either be user defined or a listed alarm description. The Counter field displays the total number of times that the event has been merged or replaced. This prevents multiple listings of the same alarm while accounting for the total number of times that a specific alarm was triggered.

16.2 View Event Details

The core of the Nectar Foundation APM is event knowledge. Nectar Foundation APM streamlines communication between all components (CIP, RIG, and Client Application) by leveraging publish and subscribe event forwarding mechanisms. This allows the operator to experience rapid interaction with an end-client RIG even at high latency/low bandwidth conditions.

The Events module allows for the necessary steps to manage events:

• As with many fault management platforms, Nectar Foundation APM has scalable event management capabilities that include:
  • Event De-duplication
  • Auto correlation of up-down events
  • Searchable events
  • Pre- and post-processing of events
• Advanced features include:
  • Synchronize event source information for live feeds.
  • Multi-cast events and performance feeds to several consoles for collaboration.
  • Send and receive event data to other commercial event management platforms and also proprietary or home-grown management applications that customers may have internally developed. Integration comes in the form of SNMPs, passing of SysLog feeds as well as SMTP.
  • Manufacturer alarm code descriptions.

To view event level detail from a RIG, navigate to Health > Events.

Figure 16-7 Events

Any event within the Nectar Foundation APM server flows through the Events module. This module has rules and automations that can help control the quantity and severity of events in the system, listing either events or aggregate alarms.

You can view and interact with events, which are split into two lists. The Current Events list (top pane) shows only the current events, or the events that represent the real-time status of the monitored systems. The All Events list (bottom pane) contains a history of all events.

To view events for a particular time period, select a Time Range from the drop-down menu:

Figure 16-8 Time Range

16.3 Configure Events

As polling data enters the system, it first checks the threshold rules for the device. It then checks a series of other rules that may be assigned to a defined event for the device. These rules are organized within Configure > Events.

Figure 16-9 Configure > Events

The following directions can be applied to events:

Table 16-2 Event Directions

16.4 Manage Acknowledgments

Multiple events can enter the system to create duplicates. For easy management, rules can be assigned to merge or replace such events.

This section explains how to manage acknowledgments, including:

• View Acknowledgments and Rules
• Add an Acknowledgment Rule
• Remove an Acknowledgment Rule

16.4.1 View Acknowledgments and Rules

Follow these steps to view the existing acknowledgments and associated rules:

1. Navigate to Configure > Events > Acknowledgments.

Figure 16-10 Configure > Events > Acknowledgments

The Acknowledgments window appears.

Figure 16-11 Acknowledgments

2. View a list of acknowledgments in the left pane.
3. Select an acknowledgment in the left pane to view the rule(s) for that acknowledgment in the right pane.

Figure 16-12 Acknowledgments and Rules

16.4.2 Add an Acknowledgment Rule

Follow these steps to add a new acknowledgment rule for the selected acknowledgment:

1. View Acknowledgments and Rules.

Figure 16-13 Add

2. Select an acknowledgment in the left pane.

   The new rule will be added to this acknowledgment.

3. Click Add.

   The Add Acknowledgment dialog box appears.

Figure 16-14 Add Acknowledgment Rule

The From field contains the selected acknowledgment from the left pane.

4. In the To field, select a new rule for the acknowledgment using the drop-down.

5. Click OK.

   The new rule appears in the list in the right Acknowledgments pane.

6. Right-click on the new rule and select a new Function for the rule from one of the following:

Table 16-3 Functions

16.4.3 Remove an Acknowledgment Rule

Follow these steps to remove an acknowledgment rule:

1. View Acknowledgments and Rules.

Figure 16-15 Remove

2. Select the acknowledgment rule you want to delete in the right pane.

3. Click Remove.

   The Remove Acknowledgment dialog box appears with the following message:

Figure 16-16 Remove Acknowledgment

4. Click Yes.

   The rule is removed from the list in the right pane.

16.5 Manage Aggregate Alarms

When you add a new element and that element is a grouping of other elements based on an arbitrary filter, any filter alarm can be created. It does not have to be in the dependency tree.

The system normally keeps track of the maximum alarm severity for each individual device name for current alarms in the system. Sometimes a system needs to be configured so that individual elements show alarm severity of events based on arbitrary filtering rules.

This section explains how to manage aggregate alarms, including:

• View Aggregate Alarms
• Add an Aggregate Alarm
• Add a Boolean Tree Expression Leg
• Edit an Aggregate Alarm
• Export an Aggregate Alarm
• Import an Aggregate Alarm
• Remove an Aggregate Alarm
• Add an Aggregate Alarm Email
• Edit an Aggregate Alarm Email
• Remove an Aggregate Alarm Email
• Connect Dependency Trees and Aggregate Alarms

16.5.1 View Aggregate Alarms

Follow these steps to view the aggregate alarms:

1. Navigate to Configure > Events > Aggregate Alarms.

Figure 16-17 Configure > Events > Aggregate Alarms

The Aggregate Alarms - Alarms window appears.

Figure 16-18 Configure > Events > Aggregate Alarms

2. View a list of the aggregate alarms.

16.5.2 Add an Aggregate Alarm

Follow these steps to add an aggregate alarm:

1. View Aggregate Alarms.

Figure 16-19 Add

2. Click Add.

   The Add Aggregate Alarm dialog box appears.

Figure 16-20 Add Aggregate Alarms

3. Enter the Name of the new aggregate alarm.
4. Assign rules to the aggregate alarm by entering the following information:

Table 16-4 Add an Aggregate Alarm

5. Add a Boolean Tree Expression Leg to the new aggregate alarm, if applicable.
6. Click OK.

16.5.3 Add a Boolean Tree Expression Leg

In the bottom pane, you can add/update Boolean expressions that serve as filters. They can filter data to match an alarm (or an event forwarding group). The Boolean expression begins with IF and is represented by a green circle.

Follow these steps to add a Boolean tree expression leg:

1. Right-click on IF and select one of the following Boolean expressions:

   • Add AND

   • Add OR

   • Add NOT

   • Add XOR

   • Add Condition

     In this example, select Add Condition.

Figure 16-21 Aggregate Alarm Conditions

The following parameters appear for the IF expression.

Figure 16-22 IF Parameters

2. Enter the following information to define the parameters for the Boolean operation:

Table 16-5 Parameters

Note: If you right-click and select another Boolean operation as part of the tree expression, such as IF AND or IF OR, a separate pane appears for each operation. You will need to define the parameters for each operation.

3. Click Update.
4. Click Add.

16.5.4 Edit an Aggregate Alarm

Follow these steps to edit an aggregate alarm:

1. View Aggregate Alarms.

Figure 16-23 Edit

2. Select an aggregate alarm to edit; then click Edit.

   The Edit Aggregate Alarms window appears.

Figure 16-24 Edit Aggregate Alarms

3. Select a new Function and/or Event Type for the alarm, as needed, using the drop-down.
4. Change the following information, as needed, to define the parameters for the Boolean operation:

Table 16-6 Parameters

Note: If you right-click and select another Boolean operation as part of the tree expression, such as IF AND or IF OR, a separate pane appears for each operation. You will need to define the parameters for each operation.

5. Click Update to save the Boolean tree expression leg changes.
6. Click Update to save the alarm changes.

Note: After making changes, you can click Reset to reset the changed values. You can also click Remove to remove the expression values.

7. Click OK.

16.5.5 Export an Aggregate Alarm

Follow these steps to export an aggregate alarm to a file on your local computer:

1. View Aggregate Alarms.

Figure 16-25 Export an Alarm File

2. Select an aggregate alarm to export; then right-click and select Export.

   The Store Aggregate Device Pack File dialog box appears.

Figure 16-26 Save Aggregate Alarm

3. Click Save.
4. Browse to the location where you want to save the file; then click Save.

16.5.6 Import an Aggregate Alarm

Follow these steps to import an aggregate alarm file from your local computer:

1. View Aggregate Alarms.

2. Right-click and select Import.

   The Open dialog box appears.

Figure 16-27 Import Aggregate Alarm File

3. Browse to the location of the file, select the file, and click Open.

   The alarm file is loaded.

16.5.7 Remove an Aggregate Alarm

Follow these steps to remove an aggregate alarm:

1. View Aggregate Alarms.

Figure 16-28 Remove

2. Select an aggregate alarm to delete; then click Remove.

   The Remove Aggregate Alarms dialog box appears with the following message:

Figure 16-29 Remove Aggregate Alarms

3. Click Yes.

16.5.8 Add an Aggregate Alarm Email

Follow these steps to add an email to an aggregate alarm. A notification is sent to this email address when the alarm reaches a specified alert level:

1. Navigate to Configure > Events > Aggregate Alarms.

   The Aggregate Alarms window appears.

2. Click the Emails tab.

Figure 16-30 Emails

3. Click Add.

   The Add Aggregate Alarm Email dialog box appears.

Figure 16-31 Add Aggregate Alarm Email

4. Enter the following information:

Table 16-7 Parameters

5. Click OK.

16.5.9 Edit an Aggregate Alarm Email

Follow these steps to edit an email to an aggregate alarm. A notification is sent to this email address when the alarm reaches a specified alert level:

1. Navigate to Configure > Events > Aggregate Alarms.

   The Aggregate Alarms window appears.

2. Click the Emails tab.

Figure 16-32 Edit

3. Select the alarm and email that you want to edit; then click Edit.

   The Edit Aggregate Alarm Email dialog box appears.

Figure 16-33 Edit Aggregate Alarm Email

4. Make changes to the following parameters, as needed:
   • Aggregate Device
   • Minimum Alert
   • Email Address
5. Click OK.

16.5.10 Remove an Aggregate Alarm Email

Follow these steps to remove an email to an aggregate alarm:

1. Navigate to Configure > Events > Aggregate Alarms.

   The Aggregate Alarms window appears.

2. Click the Emails tab.

Figure 16-34 Edit

3. Select the alarm and email that you want to delete; then click Remove.

   The Remove Aggregate Alarms Email dialog box appears.

Figure 16-35 Remove Aggregate Alarms Email

4. Click Yes.

16.5.11 Connect Dependency Trees and Aggregate Alarms

Follow these high-level steps to tie aggregate alarms to a dependency tree:

1. Navigate to Configure > Events > Aggregate Alarms.
2. Add an Aggregate Alarm.
3. Navigate to Health > Element > Element Registry.
4. Create the Aggregate Alarm as an element.
5. Navigate to Configure > Dependency Tree.
6. Select a dependency tree.
7. Add the Aggregate Alarm element into a dependency tree.

16.6 Manage Escalations

Escalations allow the importance of an event to be automatically modified based upon a set of defined rules. These rules can allow a wait time to be assigned per event type. For example, after the wait time has expired, it allows an alert to change from a 2 to a 4.

For example:

• Pollers are a good example of when alert escalation procedures would be of benefit without acknowledgment.
• SNMP Trap messages are a good example of when alert escalation procedures should contain an acknowledgment. Trap messages can turn into an event, but the system has no control over when the Trap messages are called into the system. One way of controlling these events would be to enable Acknowledge and have a Wait Time of 4 hours. This would allow the event to be closed after 4 hours.

This section explains how to manage escalations, including:

• View Escalations
• Add an Escalation
• Edit an Escalation
• Remove an Escalation

16.6.1 View Escalations

Follow these steps to view the existing escalations:

1. Navigate to Configure > Events > Escalations.

Figure 16-36 Configure > Events > Escalations

The Escalations window appears.

Figure 16-37 Escalations

2. View any existing escalations.

16.6.2 Add an Escalation

Follow these steps to add a new escalation rule.

1. Navigate to Configure > Events > Escalations.

   The Escalations window appears.

Figure 16-38 Add

2. Click Add.

   The Add Escalation dialog box appears.

Figure 16-39 Add Escalation

3. Enter the following information to create a new escalation rule:

Table 16-8 Add Escalation

4. Click OK.

16.6.3 Edit an Escalation

Follow these steps to edit an escalation rule:

1. Navigate to Configure > Events > Escalations.

   The Escalations window appears.

Figure 16-40 Edit

2. Select an event/escalation rule you want to edit; then click Edit.

   The Edit Escalation window appears.

Figure 16-41 Edit Escalation

3. Make changes, as needed, to the following parameters:
   • Wait Time
   • Alert
   • New Alert
   • Acknowledge
4. Click OK to apply your changes.

16.6.4 Remove an Escalation

Follow these steps to remove an escalation rule:

1. Navigate to Configure > Events > Escalations.

   The Escalations window appears.

Figure 16-42 Remove

2. Select an escalation rule that you want to delete; then click Remove.

   The Remove Escalation dialog box appears with the following message:

Figure 16-43 Remove

3. Click Yes.

   The escalation is removed from the list.

16.7 Manage Event Delays

Event delays associate an amount of time against a certain event in order to verify the event validity. For these events, a delay may be set, while for others outside the system, a delay may or may not be required.

This section explains how to manage escalations, including:

• View Event Delays
• Add an Event Delay
• Edit an Event Delay
• Remove an Event Delay
• Global Set for Event Delay
• View an Event Delay In Action

16.7.1 View Event Delays

Follow these steps to view the existing event delay rules:

1. Navigate to Configure > Events > Event Delay.

Figure 16-44 Configure > Events > Event Delay

The Event Delay window appears.

Figure 16-45 Event Delay

2. View the existing event delay rules.

3. To adjust the priority of an event delay rule:

   a. Select an event delay rule.

   b. Right-click and select one of the following:

Table 16-9 Move Up/Down

16.7.2 Add an Event Delay

Follow these steps to creates a new event delay time for a certain type of event:

1. Navigate to Configure > Events > Event Delay.

   The Event Delay window appears.

Figure 16-46 Add

2. Click Add.

   The Add Event Delay Rule window appears.

Figure 16-47 Add Event Delay

3. Enter the following information to create the event delay rule:

Table 16-10 Add Event Delay

4. Click OK.

16.7.3 Edit an Event Delay

Follow these steps to edit an event delay rule:

1. Navigate to Configure > Events > Event Delay.

   The Event Delay window appears.

Figure 16-48 Edit

2. Select an event delay rule; then click Edit.

   The Edit Event Delay Rule window appears.

Figure 16-49 Edit Event Delay Rule

3. Make changes to the following information, as needed:
   • Alert
   • Field
   • Value
   • Delay
4. Click OK to apply the changes.
5. Right-click within the Event Delay Setup pane to manage event delays.

16.7.4 Remove an Event Delay

Follow these steps to remove an event delay rule:

1. Navigate to Configure > Events > Event Delay.

   The Event Delay window appears.

Figure 16-50 Remove

2. Select an event delay rule you want to delete; then click Remove.

   The Remove Event Delay dialog box appears with the following message:

Figure 16-51 Remove Event Delay

3. Click Yes.

16.7.5 Global Set for Event Delay

Follow these steps to set a system-wide default time for an event delay rule:

1. Navigate to RIG > Admin > Maritime Terminal.

Figure 16-52 RIG > Admin > Maritime Terminal

The Telnet Maritime Terminal appears:

Figure 16-53 Maritime Terminal

2. Find out the global setting for event delay by entering:

   Ahoy>GXEVENT GETEVENTDELAYTIME

   The event delay time will be retrieved for the global setting, in this case, 180.

   View the following example:

Figure 16-54 Global Setting Example

3. Change the number of seconds to 20 by entering:

   Ahoy> GXEVENT SETEVENTDELAYTIME 20

4. Confirm the update by entering:

   Ahoy>GXEVENT GETEVENTDELAYTIME

   The updated number of seconds should display.

16.7.6 View an Event Delay In Action

Event delays associate an amount of time against a certain event to verify the event validity.

Follow these steps to view an event delay in action:

1. Navigate to Health > Events.

Figure 16-55 Health > Events

The Events window appears.

2. Locate an event delay, if available.

   Event delays are displayed with a clock icon under the Delay column. Once the time delay has passed, the icon is no longer visible.

   The clock icon shows during the following two instances:

   • Under the Current Events section, the clock icon is displayed until the designated time has passed.
   • Under the All Events section, the clock icon remains associated to the acknowledged event. It shows that there was an event that was resolved before the delay time lapsed.

16.8 Manage Event Forwarding

Forwarding makes integration with Network Management Systems possible and provides a mechanism to forward events as email, client popups, rest, and syslog.

• Groups allow the server to match incoming events against a specific boolean expression, so the server can trigger forwarding via an associated agent.
• Agents process events matched by an associated group. Based on the agent type, the matched event can trigger an email, syslog message, popup on a user’s RIG client, rest message, and SNMP trap. After an event has been matched and processed, the resulting message, popup, or trap goes out immediately. The delay rules do not apply to the messages, popups, or traps distributed by the forwarding rules. Agents support these types of forwarding mechanisms:
  • Email - Sends an email message to the specified email address.
  • Popup - Triggers a popup message on the specified user name’s RIG client or on all user RIG clients.
  • Rest - Sends rest messages to a specified URL.
  • Snmptrapv1 - Sends SNMP v1 trap messages to a specified IP address.
  • Snmptrapv2 - Sends SNMP v2 trap messages to a specified IP address.
  • Snmptrapv3 - Sends SNMP v3 trap messages to a specified IP address.
  • Syslog - Sends syslog message to a specified syslog server IP address.

This section explains how to manage Event Forwarding, including:

• Manage Event Forwarding Groups
• Manage Event Forwarding Agents
• Forwarding In Action

16.8.1 Manage Event Forwarding Groups

Groups allow the server to match incoming events against a specific boolean expression, so the server can trigger forwarding through an associated agent. To set up notifications, you use a Boolean Tree Editor.

Note: To manage event forwarding groups, you must be familiar with Boolean strings.

Follow these steps to access the event forwarding group features:

1. Navigate to Configure > Events > Event Forwarding.

Figure 16-56 Configure > Events > Event Forwarding

The Event Forwarding window appears.

2. Right-click within the Groups pane and view the following options, which are discussed in detail in this section:

Table 16-11 Manage Groups

Add Event Forwarding Group

Follow these steps to add an event forwarding group:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click Add.

   The Add Forwarding Group dialog box appears.

Figure 16-57 Add Forwarding Group

3. Enter the following information:

Table 16-12 Add Forwarding Group

4. Add a Boolean Tree Expression Leg to the new event forwarding group, if applicable.

Note: After you add the tree expression leg, notice the Boolean shorthand expression that appears above the left Boolean expression pane.

5. Click Add.

   The new group appears in the Group pane.

Edit an Event Forwarding Group

Follow these steps to edit an event forwarding group:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Select an event forwarding group you want to change; then click Edit.

   The Update Forwarding Group dialog box appears.

Figure 16-58 Update Forwarding Group

3. Make changes, as needed, to the following parameters:
   • Name
   • Enabled
   • Rest-Specific Data: URL Path, Custom Tag 1, 2, 3
4. Right-click on IF; then add/change the Boolean Tree expression leg information, as needed:

Table 16-13 Parameters

Note: If you right-click and select another Boolean operation as part of the tree expression, such as IF AND or IF OR, a separate pane appears for each operation. You will need to define the parameters for each operation.

5. Click Update to save the changes to each Boolean tree expression leg.
6. Click OK to save the event forwarding changes.

Note: After making changes, you can click Reset to reset the changed values. You can also click Remove to remove the expression values.

Enable or Disable an Event Forwarding Group

Follow these steps to enable or disable an event forwarding group:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Select an event forwarding group in the Groups pane; then perform one of the following:

   • If the Enable column is no, you can right-click and select Enable to enable the group.
   • If the Enable column is yes, you can right-click and select Disable to disable the group.

Note: You can also enable/disable a group by checking/unchecking the Enabled check box on the Add or Update Forwarding Group dialog box. You can select multiple groups within the Groups pane using the Ctrl key on your keyboard and enable/disable them at the same time.

Remove Event Forwarding Group

Follow these steps to remove an event forwarding group:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Within the Groups pane, select the event forwarding group(s) that you want to remove; then click Remove.

   The Remove dialog box appears with the following message:

Figure 16-59 Remove

3. Click Yes to remove the group.

Clone Event Forwarding Group

Cloning an event forwarding group allows you to make a copy of an existing group to create a new group.

Follow these steps to clone an event forwarding group:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Select the event forwarding group you want to clone.

3. Right-click on the event forwarding group and select Clone in the menu.

   A new event forwarding group appears in the Groups pane with copy as part of the name.

Figure 16-60 Clone an Event Forwarding Group

4. Select the cloned event forwarding group; then click Edit to rename the group and make any other changes, as needed (see Edit an Event Forwarding Group).

16.8.2 Manage Event Forwarding Agents

Agents accept the notifications sent from system groups. Agents serve as a destination for events, such as an email, syslog or Rest messages, popup windows, and so on. After an event has been declared that has forwarding rules assigned, the notification goes out Immediately. The delay rules do not apply to the notifications distributed to the forwarding rules.

Add an Event Forwarding Agent

Follow these steps to add an event forwarding agent:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click the Agents tab.

Figure 16-61 Agents Tab

3. Click Add to add a new agent.

   The Add Agent - General dialog box appears.

Figure 16-62 Add Agent

4. Notice the following tabs. These will change based on the type of agent created.
   • General
   • SNMP
   • Event Fields
   • Group Membership
5. Enter the Name of the new agent.
6. Select one of the following for the Type of agent using the drop-down:

   • Email

   • Popup

   • REST

   • SNMP

   • Syslog

     This selection determines the information that must be provided for the agent type. View the following table:

Table 16-14 Agent Types

7. Enter the following information for the General tab, if applicable:

Table 16-15 General Tab

8. Enter the following information for the SNMP tab, if applicable:

Table 16-16 SNMP Tab

9. Enter the following information for the Event Fields tab, if applicable:

Table 16-17 Event Fields Tab

10. Enter the following information for the Group Membership tab, if applicable:

Table 16-18 Group Membership Tab

11. After all of the agent information is entered, click OK.

    The new agent appears in the Agents pane.

Edit an Event Forwarding Agent

Follow these steps to edit an existing event forwarding agent:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click the Agents tab.

Figure 16-63 Agents Tab - Edit

3. Select an agent you want to change; then click Edit.

   The Edit Agent - General dialog box appears.

Figure 16-64 Edit Agent

4. Click each tab and make changes, as needed, to the agent.

Note: The tabs that appear are based on the agent type.

5. Click OK.

Enable or Disable an Event Forwarding Agent

Follow these steps to enable or disable an event forwarding agent:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click the Agents tab.

3. Select an agent in the Agents pane; then perform one of the following:

   • If the Enable column is no, you can right-click and select Enable to enable the agent.
   • If the Enable column is yes, you can right-click and select Disable to disable the agent.

Note: You can also enable/disable an agent by checking/unchecking the Enabled check box on the Add or Edit Agent dialog box.

You can select multiple agents within the Agents pane using the Ctrl key on your keyboard and enable/disable them at the same time.

Remove an Event Forwarding Agent

Follow these steps to delete an event forwarding agent:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click the Agents tab.

Figure 16-65 Agents Tab - Remove

3. Select an agent you want to delete; then click Remove.

   The Remove dialog box appears with the following message:

Figure 16-66 Remove

4. Click Yes.

Clone an Event Forwarding Agent

Cloning an event forwarding agent allows you to make a clone (or a copy) of an existing event forwarding agent using a new agent name.

To clone an event forwarding agent:

1. Navigate to Configure > Events > Event Forwarding.

   The Event Forwarding - Groups window appears.

2. Click the Agents tab.

3. Within the Agents pane, highlight the event forwarding agent you want to clone.

4. Right-click on the event forwarding agent and select Clone in the menu.

   A new event forwarding agent appears in the Agents pane with copy as part of the name.

5. Select the cloned event forwarding agent; then click Edit to rename the agent and make any other changes, as needed (see Edit an Event Forwarding Agent).

16.8.3 Forwarding In Action

After an event has been matched and processed, the resulting message, popup, or trap goes out immediately. The delay rules do not apply to the messages, popups, or traps distributed by the forwarding rules.

17. Trap Receivers and Groups

This section provides information on the following:

• Trap Receivers
• Access Receiver Module
• Traps
• Trap Fields
• Trap Field Mapping
• Post Process Trap
• Community Filter
• Trap Forwarding
• Manage Trap Groups

17.1 Trap Receivers

The Trap Receiver serves as an SNMP Trap receiver. It listens for SNMP Traps that are sent by managed network devices. These monitored devices send unsolicited SNMP Traps to the Receiver module as event notifications. The Receiver module provides definitions for all Traps that are received by the Nectar platform.

A Nectar administrator can also export/import SNMP traps using Tools > SNMP > SNMP Import. If an Enterprise or RFC MIB contains SNMP V1 Trap definitions, the Import function will try to generate a Trap definition. The Alert column values will be unpopulated. The administrator can define these using a MIB definition document from the manufacturer of the monitored product.

The Receiver Module serves two basic functions:

• Listens on port 162 for Traps that are sent to Nectar.
• Stores Trap definitions and the alerting level provided upon import. When Traps arrive, the administrator performs further configurations to enable alarming.

17.2 Access Receiver Module

To access the Receiver module:

1. Navigate to Configure > Receiver:

Figure 17-1 Configure > Receiver

The Receiver - Traps window appears:

Figure 17-2 Receiver Window

17.3 Traps

The Traps pane contains the following information:

Table 17-1 Traps

17.3.1 Add Traps

Very rarely will you manually add a new Trap. You would do so when a Trap is malformed or if one is missing and you want to add a single one instead of doing an import. This feature is not the norm for adding Traps to a platform. Traps are normally imported/received. Adding a Trap is an exception to the rule.

Follow these steps to manually add a Trap.

Note: You must have the original Trap name and OID from the MIB browser.

1. Click Add.

Figure 17-3 Add

The Add Trap window appears:

Figure 17-4 Add Trap

2. Enter the following information:

Table 17-2 Add Trap

3. Click OK.

   The Trap name is displayed in the Traps pane.

17.3.2 Edit Traps

You can edit a Trap to add additional details:

1. Select a Trap in the Traps pane; then click Edit:

Figure 17-5 Edit Trap

The Edit Trap window appears.

Figure 17-6 Edit Trap

2. Make changes, as needed, to the Trap.
   • The Send to Module field indicates the loaded Nectar module that provides additional Trap handling. Verify that the Nectar module is accepting Traps. Consult with Nectar Support.
   • Add an Acknowledgment value. This represents an acknowledged notification. When Traps arrive, you can close them by setting this field to Yes. If set to Yes, this trap will not alert, but it will immediately be acknowledged, and the alert closed.
3. Click OK to save your changes.

17.3.3 Remove Trap Name (Definition)

When you remove a trap from the Receiver module, you are actually removing the individual Trap definition.

1. Select a Trap in the Traps pane; then click Remove:

Figure 17-7 Remove Trap

The Remove Trap Name window appears with the following message:

Figure 17-8 Remove Trap Name

2. Click Yes to remove the trap.

17.3.4 Import/Export Traps

You can import Traps using the Import feature. You can also export Traps to your local computer for import to another RIG as follows:

1. Highlight the Trap(s) that you want to export.

Note: Use the Ctrl key to select more than one trap.

2. Click Export.

Figure 17-9 Export

3. In the Export Traps window, browse to the location where you will temporarily save the exported Trap(s); then click Save:

Figure 17-10 Save Exported Traps

4. Access the new RIG to which you will import the Trap(s) you exported.

5. Navigate to Configure > Receiver.

6. Click Import.

   The Import Traps window appears (similar to the Export Traps window).

Figure 17-11 Import Traps

7. Browse to the trap file you saved earlier; then click Import to begin the import process.

   The selected trap(s) are imported into the new RIG and can be accessed in the Receiver - Traps pane.

17.4 Trap Fields

The Fields pane provides information about the received Trap parameter fields.

Figure 17-12 Fields Pane

The Fields pane contains the following information about a selected Trap:

Table 17-3 Fields

Note: The purpose of the Edit feature is primarily for informational purposes only. Be very careful about editing these values. If you must edit these values, consult your Nectar representative for guidance.

17.4.1 Edit a Trap

Follow these steps to edit a trap:

1. Select a Trap in the Fields pane; then click Edit:
2. In the Edit Trap window, you can edit the OID. An example would be param1, param2, and so on. These are the parameter fields you would see in an event.
3. Do not edit the Parameter Function field.
4. Click OK to save your updates.

17.5 Trap Field Mapping

The Field Mapping pane allows you to map the parameters received in a Trap to fields within an event.

Note: Be very careful about making changes in the Field Mapping pane. If you have questions about this process, consult your Nectar representative before attempting to make changes.

The Field Mapping pane contains the following information:

Table 17-4 Field Mapping

17.5.1 Map Parameters to Events

Follow these steps to add a parameter and map it to a field within an event:

1. In the Field Mapping pane, click Add.

The Add Field Mapping window appears.

Figure 17-13 Edit Field Mapping

The Parameter OID field contains the parameter from the Trap that you want to map to an event parameter/field.

2. Use the drop-down to select the Event parameter to which you want to map the selected Parameter OID (in this example, we selected alert).
3. Add a Description, as needed. This data is not pertinent; it is only a comment field.
4. Click OK to save your changes.

17.5.2 Edit a Mapping

Follow these steps to edit the parameter to which a Trap is mapped within an event:

1. In the Field Mapping pane, select a parameter; then click Edit.

The Edit Field Mapping window appears.

Figure 17-14 Edit Field Mapping

The Parameter OID field contains the parameter from the Trap that you want to map to an event parameter/field.

2. Use the drop-down to select the Event parameter to which you want to map the selected Parameter OID (in this example, we selected acknowledgeTime).
3. Edit the Description field, as needed. This data is not pertinent; it is only a comment field.
4. Click OK to save your changes.

17.5.3 Remove Parameters

Follow these steps to remove a parameter received in a Trap:

1. In the Field Mapping pane, select a parameter to be removed.

2. Click Remove.

   The parameter is removed.

17.6 Post Process Trap

The Post Process tab of the Receiver window allows you to add, edit, or delete Trap parameter values.

Note: Be very careful about making changes in the Post Process pane. If you have

questions about this process, consult your Nectar representative before attempting to make changes.

This section explains how to:

• Add a Trap Post Processor
• Edit Trap Post Processor
• Remove Trap Post Processor

17.6.1 Add a Trap Post Processor

Follow these steps to add a Trap parameter value to the Post Process pane:

1. Click the Post Process tab.

2. Click Add.

   The Add Trap Post Processor window appears.

Figure 17-15 Add Trap Post Processor

3. Enter the Trap OID and a Description for the Trap parameter.

4. In the Matching Trigger area, select a parameter value in the Column 1 drop-down menu and enter an associated Value 1 value (which can be an expression or numeric value) in the provided field. Repeat for Column 2, as needed.

5. In the Replace Values area:

   a. Use the Column 1 drop-down menu to select a value.

   b. In the Prefix 1 field, enter a prefix for the parameter that will appear in the associated event. This is an optional step.

   c. In the Value 1 field, enter the new parameter value. This value can be alpha or numeric.

   d. Repeat Steps a-c to add additional columns.

6. Click OK.

   This adds the Trap parameter and its OID to the Post Process pane.

17.6.2 Edit Trap Post Processor

Follow these steps to edit a parameter value on the Post Process pane:

1. Select a parameter listed in the Post Process pane; then click Edit.

   The Edit Trap Post Processor window appears.

Figure 17-16 Edit Trap Post Processor

2. Change the Trap OID and a Description, as needed, for the Trap parameter.

3. In the Matching Trigger area, change the parameter value for Column 1, as needed, using the drop-down as well as the associated Value 1 value (which can be an expression or numeric value) in the provided field. Repeat for Column 2, as needed.

4. In the Replace Values area:

   a. Use the Column 1 drop-down menu to change the value, as needed.

   b. In the Prefix 1 field, enter or change the prefix for the parameter that appears in the associated event, as needed. This is an optional step.

   c. In the Value 1 field, enter or change the parameter value, as needed. This value can be alpha or numeric.

   d. Repeat Steps a-c to add or change additional columns.

5. Click OK to save your changes.

17.6.3 Remove Trap Post Processor

Follow these steps to remove a parameter value on the Post Process pane:

1. Select a parameter listed in the Post Process pane.

2. Click Remove.

   The parameter is removed from the Post Process pane.

17.7 Community Filter

The Community Filter tab of the Receiver window allows you to:

Figure 17-17 Community Filter

• Filter incoming traps based on SNMP V1, V2, and V3 community strings by selecting the associated check box.
• Search for traps based on filter rules using the search field to the right (see Trap Forwarding).
• View, add, change, or remove community names in the Community Name pane.

This section explains how to:

• Filter Incoming Traps
• Add a Community
• Edit a Community
• Remove a Community

17.7.1 Filter Incoming Traps

Click the Filter incoming traps based on SNMP community strings check box, if you want to filter incoming traps based on SNMP V1, V2, or V3 community strings.

For more information on community strings, see the following sections.

17.7.2 Add a Community

Follow these steps to add a community:

1. Navigate to Configure > Receiver.

   The Receiver - Traps window appears.

2. Click the Community Filter tab.

3. Click Add.

   The Add Community Filter window appears.

Figure 17-18 Add Community Filter

4. Enter the following information: