Integrate CA UIM and CA Spectrum through the Southbound Gateway

CA UIM and CA Spectrum are integrated through the CA Spectrum Southbound Gateway component (SBGW). This integration is unidirectional (CA UIM to CA Spectrum), and supports multiple outstanding alarms, of various types, per device. The component asserts the alarm against the existing device model or against an auto-created event model of CA UIM Robot. CA Spectrum EventModel is used when a full device model for the network entity does not exist in CA Spectrum. This integration supports multiple alarms types per model, such as Low Disk, Excessive CPU usage, and Traffic Threshold violation.   
casp1030
From the Spectrum v10.1.2 release, the SNMP Gateway probe and SBGW /Southbound gateway are no longer recommended for alarms synchronization from CA UIM to CA Spectrum. Please use the Spectrum Gateway (spectrumgtw) probe for this.
For more information refer to the following CA Spectrum - CA UIM Integration Compatibility Matrix:
CA Spectrum
CA UIM
Inventory sync using nisapi
snmpgtw /SBGW
spectrumgtw
10.1
8.2, 8.3
YES
NA
10.1.1
8.2, 8.3
YES
NA
10.1.2
8.47
nisapi-wasp v8.4.2 or later
NA
YES
We recommend that you go through the CA Spectrum-CA UIM Integration using spectrumgtw probe - FACT SHEET to understand the changes to the integration whether you are new to this integration or an existing user.
CA UIM and CA Spectrum are integrated through the CA Spectrum Southbound Gateway component (SBGW). This integration is unidirectional (CA UIM to CA Spectrum), and supports multiple outstanding alarms, of various types, per device. The component asserts the alarm against the existing device model or against an auto-created event model of CA UIM Robot. CA Spectrum EventModel is used when a full device model for the network entity does not exist in CA Spectrum. This integration supports multiple alarms types per model, such as Low Disk, Excessive CPU usage, and Traffic Threshold violation.   
Overview
The CA Spectrum - CA UIM Integration expands the CA Spectrum model of the infrastructure with information and alarms from CA UIM and provides the following benefits:
  • Receive events and alerts in CA Spectrum from CA UIM probes.
  • Obtain extended CA Spectrum monitoring capabilities leveraging the intelligence of CA UIM probes
  • Use the UIM SLA rules to trigger events that create alert conditions in CA Spectrum.
  • Use CA Spectrum root cause analysis capabilities to perform basic root cause analysis on events and alerts that are created by CA UIM.
As an administrator, configure CA UIM to send alert data to CA Spectrum. CA UIM sends the trap data to the host name and port where the SpectroSERVER is running. By default, CA Spectrum uses standard SNMP trap port 162. CA Spectrum accepts an individual SNMP trap packet to a maximum size of 65467 bytes. You can modify the port by changing the snmp_trap_port parameter in the CA Spectrum ".vnmrc" file that is located in the CA Spectrum directory.
The following diagram illustrates the process to integrate CA UIM and CA Spectrum through the Southbound Gateway:
Integrate CA Nimsoft and CA Spectrum
Integrate CA Nimsoft and CA Spectrum
Perform the following tasks to integrate CA UIM and CA Spectrum through the Southbound Gateway:
Review the Prerequisites and Considerations
Verify the following prerequisites before installing and configuring the CA Spectrum - CA UIM Integration:
  • Licensed installations of CA Spectrum v10.1 and higher and CA UIM Management System (version 8.2 or later) are required.
    If you plan to install CA Spectrum as a user other than Administrator, disable User Account Control (UAC) on Windows. For more information, see the Install CA Spectrum
    section.
  • Verify that the system where you want to install CA Spectrum has a static IP address.
  • Standard CA Spectrum supported platforms and hardware are required.
Verify the following considerations:
  • The current integration does not attempt to upgrade previous (that is field-developed) integrations. We plan to support upgrades to future versions of this integration.
  • This integration requires CA Spectrum to use the SNMP Trap port (162) for communication from CA UIM.  
  • This integration connects to only a single CA UIM instance.
  • This integration depends on trap reception because typical SNMPv1 traps are unconfirmed. Traps can be dropped in transit and not recognized.
  • For the events and alarms to be raised on the correct CA Spectrum model, use IP address instead of host name to model the entity on CA UIM. If a host name is used for entities that are modeled in CA UIM, CA Spectrum alarms are raised on the EventModel of robot hosting the probe.
Install and Configure CA Spectrum
CA Spectrum installation software requires administrator privileges to evaluate available resources and run custom installation scripts. An initial installation generates residual files with administrator ownership. Subsequent upgrade installations also require administrator privileges.
The C:\Program Files\CA directory on Windows platforms and the /opt/CA directory on Linux platforms are automatically created during the CA Spectrum first-time installation. CA Spectrum components that are also common to other CA products are intentionally installed into this directory. This directory is automatically updated as needed during a CA Spectrum upgrade. Do not remove files from this directory.
A CA Spectrum installation is required to integrate CA UIM and CA Spectrum through the Southbound Gateway. You can install CA Spectrum on Windows and Linux platforms.
Follow these steps:
  1. Stop all non-CA Spectrum running applications.
  2. Perform the following actions:
    • Log off from OneClick in the Client Details web page and shut down the OneClick client.
      For more information, see the section.
    • Click Stop SpectroSERVER to stop the SpectroSERVER and the Archive Manager in the CA Spectrum Control Panel and then close the CA Spectrum Control Panel.
      For more information, see the section
      .
    • Stop all VnmSh connections.
      For more information, see the section
      .
    • Close all Bash shells.
    Disable your antivirus software real-time protection before installing CA Spectrum. Disabling helps avoid potential problems with files that can be in use by the real-time protection software.
  3. Log in as a user with administrator rights.
  4. Insert the installation medium into the appropriate drive. If auto-run is disabled, you can double-click the setupnt.exe file from the Explorer view to start the installation.
    The installation starts.
  5. Install CA Spectrum. For more information, see the Install CA Spectrum
     
    section.
Deploy and Configure Probes
CA UIM Probes are small, dedicated applications that monitor specific resources or events. Each probe can be easily configured for your specific monitoring requirements.
The SNMP Gateway probe sends traps from CA UIM to CA Spectrum. To integrate CA UIM with CA Spectrum, configure the SNMP Gateway probe (snmpgtw) through CA Unified Infrastructure Manager.
The SNMP gateway converts alarms to SNMP trap messages that are readable by any SNMP-based event manager. The SNMP gateway maps the various severity levels to enterprise-specific trap types. For more information, see http://docs.UIM.com/prodhelp/en_US/Probes/GettingStarted/.
Follow these steps:
  1. Open CA Unified Infrastructure Manager.
  2. From the Console window, select Archive, UIM Server hub, and Robot.
    A list of predefined probes is displayed.
  3. Select a package name in the archive folder.
  4. Drag and drop the package name to the domain/hub/robot.
    A View Distribution Progress dialog opens.
  5. Click Close Dialog after distribution has completed.
    The probe is deployed to the specified location.
  6. To configure the probe, double-click the probe that you deployed.
    The Probe Configuration window opens.
  7. Click the Setup tab.
    The Setup window opens with the following options:
    • Active
      Activates or deactivates this probe.
    • Subject(s)
      Specifies the CA UIM subject that is transformed. Subject is a text string, that classifies the CA UIM message for all components of CA UIM.
      Default:
       Alarm
    • Trap variables
      Indicates a unique identifier of the SNMP operation where the traps are triggered.
    • Log file
      Specifies the file where the probe logs information about its internal activity.
    • Log level
      Sets the level of details for the data that is written to the log-file. We recommend logging as little data as possible during normal operation to minimize disk consumption. You can then increase the amount of detail when debugging.
    The following image illustrates the options that are available in the Setup window:
    2168155.png
  8. Click the Profiles tab.
    The Profile window opens. For more information, see Configure CA Unified Infrastructure Manager.
  9. Click Ok.
    The snmpgtw probe is deployed and configured.
Configure CA Unified Infrastructure Manager
The CA Unified Infrastructure Manager is the primary interface for configuration and management of the CA UIM system.
Configure CA UIM to manage entities on your network through CA Unified Infrastructure Manager or the Unified Management Portal. To integrate CA UIM with CA Spectrum, configure the SNMP Gateway probe (snmpgtw) through CA Unified Infrastructure Manager. For more information, see Deploy and Configure Probes.
A profile is created in the SNMP Gateway Probe to communicate to the CA UIM about the traps to send, the conditions under which to send them, and where to send them.
Follow these steps:
  1. Open CA Unified Infrastructure Manager.
  2. From the Console window, select Domains, UIM Server Domain, UIM Server Hub, UIM Primary Hub and then Gateway.
    A list of Probes is displayed.
    The following image displays the navigation to snmpgtw probe:
    2198520.png
  3. Double-click the snmpgtw probe.
    The Probe Configuration window opens.
  4. Click the Profiles tab.
  5. Right-click the Configured Profiles workspace and select New.
    The following image the illustrates the procedure to create a new profile:
    2198518.png
  6. Enter the name of the profile. For example, you can supply Spectrum-
    Server name
    .
  7. To enable the profile, click Spectrum in the list of Configured profiles.
    The following image illustrates the options that are available in the Profiles window.
    2174714.png
    • Target(s)
      Specifies the SpectroSERVER IP address. Indicates the network node where the SNMP traps can be sent.
    • Base Object Identifier (OID)
      Indicates the SNMP Object identifier to be used in the trap packages generated.
      Default:
       1.3.6.1.4.1.4055.1
    • Community String
      Indicates the SNMP community string that is used in the SNMP traps.
    • Trap Mapping
      Classifies the incoming traps by trap type and takes different actions for different trap types. You can map the severity levels of the alerts to SNMP traps.
      For example, provide the following values for trap mapping:
      Default:
       5
      • Clear: 7
      • Informational: 5
      • Warning: 6
      • Minor: 2
      • Major: 3
      • Critical: 4
      If you want to disable informational and warning messages at the source level, remove the mappings for Default, Warning, and Informational in Trap Mapping. For more information, see Performance Considerations.
    • Level Mapping
      Identifies the severity levels with different codes. You can map the CA UIM severity levels to the corresponding level in the receiving system by specifying the correct code.
      For example, provide the following values for level mapping:
      Default: 1
      • Clear: 0
      • Informational: 1
      • Warning: 2
      • Minor: 3
      • Major: 4
      • Critical: 5
  8. Click Apply and Ok.
    CA Unified Infrastructure Manager is configured to integrate with CA Spectrum.
Create an EventAdmin Model for the CA UIM Server
The CA Spectrum EventAdmin model receives events from the Southbound Gateway and transfers the event data to EventModels or device models depending on how the integration is configured. Alarms can be created from this event data.
The EventModel is a model type that represents a unique source of event data on the system that is managed by the EventAdmin application. A given EventAdmin model can contain one or many instantiated EventModels. Each event that is received through the Southbound Gateway contains information that uniquely identifies the source of that event. The EventAdmin model receives the event, finds the unique event source, and passes the event to the target destination. Create an EventAdmin model for the UIM server to support the integration.
Follow these steps:
  1. Open the CA Spectrum OneClick Console.
  2. From the Navigation Panel, select SpectroSERVER, and then Universe.
  3. Click the Topology tab in the Contents Panel and click Create New Model by Type.
    The Select Model Type dialog opens.
    The following image displays the model types to be created:
    2198527.png
  4. In the All Model types tab, click EventAdmin.
  5. Click OK.
    The Create Model of Type EventAdmin dialog opens.
  6. Configure the following parameters:
    • Name
      (Optional) Defines the EventAdmin model name. This model name appears in the field at the top of the EventAdmin icon.
    • Network Address
      Specifies the network address of the event source host computer. Required for all integrations that are based on the SNMP traps.
    • Security String
      (Optional) Defines who can view and edit this model.
    • Manager Name
      When this attribute is set on the EventAdmin model, all EventModels contained within this EventAdmin also have this attribute.
    • EventModel Prefix
      Verifies the naming prefix for all EventModels that are associated with a particular EventAdmin model. This field is related to the EventModel Name for all the EventModels contained by this EventAdmin. It is also useful for sorting and filtering.
      Default: 
      0x06330000
  7. Click OK.
    The EventAdmin model is generated. A default EventModel is also created and is contained in the EventAdmin model. This model is used for fault tolerance functionality that represents the unique source.
Verify the Received Events and Alarms in OneClick 
The EventAdmin Model receives an event from CA UIM and sends it to the EventModel in OneClick. The event generates an alarm on this model. To verify that the integration is configured correctly, we recommend viewing the details of the alarm data from the Alarm Details tab in OneClick. The generic and subsystem-specific events are created in OneClick. You can also verify the design pattern of these events/alarms.
Follow these steps:
  1. Open the OneClick Console.
  2. Select the EventModel in the Navigation panel.
  3. To view events, click the Events tab in the Contents panel.
    Events are displayed with the following event types:
    • Generic Events
      Indicates the events that are not related to CPU, Disk, and Memory subsystems.
      The range starts from 0x06330000 - 0x6330005.
    • Subsystem Specific Events
      Indicates the events that are related to CPU, Disk, and Memory subsystems. You can verify the following event range for the subsytem-specific events:
      • CPU
        0x06330050 - 0x6330055
      • Disk
        0x06330030 - 0x6330035
      • Memory
        0x06330040 - 0x6330045
  4. Verify the following design pattern of these events/alarms:
    • 0x063300x0 Clear Event
    • 0x063300x1 Minor Event / Alarm
    • 0x063300x2 Major Event / Alarm
    • 0x063300x3 Critical Event / Alarm
    • 0x063300x4 Informational Event
    You can review the following table to know how the CA UIM message severities are mapped to CA Spectrum events and alarms:
  5. CA UIM Spectrum
    • Informational Event only
    • Warning Event only
    • Minor Minor Alarm
    • Major Major Alarm
    • Critical Critical Alarm
  6. To view alarms, click the Alarms tab.
    Alarms are displayed.
  7. Click the Alarm Details tab in the Component Detail panel to view the alarm details.
    Events and Alarms that are generated in OneClick are verified.
Alarms that are manually cleared in the CA UIM Alarm Console do not clear the corresponding alarms in CA Spectrum. This behavior is caused by a known imitation of the SNMP Gateway probe (snmpgtw). Therefore, when you clear alarms in CA UIM, the alarms accumulate in CA Spectrum, causing high alarm counts. These alarms must be manually cleared in CA Spectrum.
Performance Considerations
CA UIM - CA Spectrum integration through the Southbound Gateway supports and implements all severities and traps (such as Informational, Warning, Minor, Major, Critical, Clear).
By default, CA UIM snmpgtw is configured to send alerts (traps) for messages of all severity levels.
The volume of events and alarms that are generated by CA UIM in CA Spectrum depends on the number, type and condition of managed elements. In situations where performance is an issue, you can disable these messages at the CA Unified Infrastructure Manager.
For example, if the trap storm detection threshold of CA Spectrum exceeds a certain level, it indicates that performance is degraded. By default this threshold is configured for 20 traps/second from a single device. In a moderately large CA UIM installation, the CA Spectrum default trap storm threshold can be exceeded easily, and when it is exceeded, traps are dropped. To preserve the most critical traps, we recommend disabling the informational and warning messages. In this way, bandwidth is not used on less severe situations and the critical traps can be handled by CA Spectrum.
To handle this situation, you can disable the informational messages that are sent by CA UIM. In this way the problem can be resolved at the source level. If the trap storm threshold is exceeded, the warning messages can be disabled and not sent to CA Spectrum. You can also raise the trap storm threshold to 25 or 30 traps/second, if the SpectroSERVER has sufficient capacity.
If after disabling the informational and warning messages, the number of alerts from CA UIM still exceeds the trap storm threshold, consult CA UIM documentation to determine ways to limit the number or types of traps being sent to CA Spectrum. By default all alarms are filtered. Therefore, you can change the alarm messages that are filtered by snmpgtw. You can also change the alarm setting to alarm_new and alarm_clear messages, which can reduce the total traffic from CA UIM to CA Spectrum.
If you change the alarm setting to alarm_new and alarm_clear message, the alarm counts may not be correctly incremented in CA Spectrum as a single message for each occurrence of an alarm that is received.
Disable the Integration
You can disable the CA UIM - CA Spectrum Integration, if you want to stop generating alarms and events in OneClick. On disabling the integration, the EventAdmin model no longer receives events from CA UIM and the events are not forwarded to the EventModel model in OneClick.
Follow these steps:
  1. Open CA Unified Infrastructure Manager.
  2. From the Console page, select Gateway.
    The SNMP Gateway window opens.
  3. Click the Profiles tab.
    The Configured Profiles window opens.
  4. Right-click a Profile, select Delete.
    Profile is deleted.
  5. Click Ok.
    The Integration is disabled.