CA Spectrum and CA UIM Bidirectional Integration

casp102
This page describes the CA Spectrum and CA UIM Bidirectional integration by covering the following topics:
3
If you are setting up the integration for the first time using CA Spectrum 10.2.3 and CA UIM 8.5.1/ 8.5.1 (SP1) using the spectrumgtw probe v8.65; you can no longer enable the bidirectional integration from the CA Spectrum OneClick Administration > UIM Configuration page. You need to first select
SpectrumGateway Integration
from the OneClick Admin > UIM Configuration page, enable the Alarm Integration checkbox and then configure additional parameters in the Alarm Configuration section of the spectrumgtw Admin Console, to initiate the bidirectional alarm integration.
For more information, see spectrumgtw Admin Console.
Integration Compatibility
CA Spectrum
CA UIM
NIS Restful API (Wasp Edition)
spectrumgtw probe
10.1.2
8.47, 8.5
From CA UIM 8.47 onwards, you no longer have to deploy nisapi separately.
The wasp probe which is a core component in CA UIM contains the nisapi_service_host probe functionality. 
By default, the CA Spectrum integration uses the nisapi package deployed in wasp as part of the CA UIM installation or upgrade. 
8.47, 8.49
10.1.2 / 10.2
8.5.1
8.51
10.2.1
8.5.1
8.6
10.2.2
8.51 and 8.5.1 SP1
8.64
10.2.3
8.51 and 8.5.1 SP1
  • From CA Spectrum 10.2.3, there is a change in the GUI for configuring the Spectrum-UIM integration. Starting from spectrumgtw probe v8.65, the integration configuration is now completely moved to the spectrumgtw probe Admin Console.
  • If you are setting up the integration for the first time, you can just enable or disable the integration from the CA Spectrum OneClick Admin pages > UIM Configuration.
  • Existing integration users (till spectrumgtw 8.64) upgrading to CA Spectrum 10.2.3 can view and manage their integration configuration under the Legacy Integration field in the UIM Configuration page.
8.65
In previous releases of CA UIM, the nisapi_service_host package was deployed to the service_host probe. As of CA UIM release 8.47, the service_host probe was deprecated and its functionality was moved to the wasp probe.
  • By default
    ,
    the wasp probe uses port 80. However, because the wasp probe is a core component in CA UIM, this port should already be open in a properly functioning CA UIM environment. For more information, refer to the wasp probe documentation
Overview
You can enable bidirectional integration between CA Spectrum r10.1.2 or higher and CA UIM 8.47 using the spectrumgtw probe v8.4.7. This bidirectional integration enables the following functionalities:
  • Reception of all CA UIM alarms by CA Spectrum.
    This functionality enables CA Spectrum users to update (acknowledge, unacknowledge, clear, assign and unassign troubleshooter, and create service desk ticket) CA UIM alarms in OneClick. CA UIM receives such updates when its alarms are updated in OneClick.
  • Reception of CA Spectrum inventory information and all CA Spectrum alarms by CA UIM.
    This functionality enables:
    • CA UIM to maintain an updated CA Spectrum inventory information based on a specific global collection in OneClick.
    • CA UIM to receive all CA Spectrum alarms. As a result, CA UIM users can update (acknowledge, unacknowledge, clear, assign and unassign troubleshooter, and create service desk ticket) CA Spectrum alarms. CA Spectrum receives such updates when its alarms are updated in CA UIM.
  • If you were using the uni-directional integration, you should turn off the associated profile in the snmpgtw probe before you start using the spectrumgtw probe for bidirectional integration. 
  • Ensure that snmpgtw probe is not configured with the SpectroSERVER you are configuring, for the bidirectional integration using spectrumgtw probe.
Information:
  • Inventory is a list of devices from a single or multiple landscapes.
  • The deletion of CA Spectrum models in CA UIM is not supported.
  • Even if you have enabled the integration for Server Management and VMware Management, you can enable this bidirectional integration provided that you deploy and configure the spectrumgtw probe. In this case, integration for Server and VMware Management, and the bidirectional integration work without any conflict.
Enable the Bidirectional Integration
You need to complete the following steps to enable this integration:
  • Verify the following prerequisites:
    • CA Spectrum v10.1.2 or higher and CA UIM v8.47 are deployed. 
    • The spectrumgtw probe (v8.4.7 or higher) is deployed and configured. For more information on the Spectrum Gateway probe, see spectrumgtw AC Configuration.
    • The CA Unified Infrastructure Management Alarm Server (nas) probe must be installed and activated. 
    • The CA Unified Infrastructure Management Event Management Services
       
      (v 8.4.2 or higher) probe must be deployed and configured for the 
      spectrumgtw
       probe to run successfully. 
    • The CA Unified Infrastructure Management trellis probe should be active and the
      Spectrum UIM Services
       service should be running.
    • The vmware (VMware Monitoring) probe v6.72 and higher is deployed. (if you are managing virtualized devices with CA UIM as well CA Spectrum)
  • Configure the
    UIM Configuration
    page on the CA Spectrum OneClick Administration page. 
  • Select the bidirectional integration option on the
    UIM Configuration
    page.
For more information on configuring the spectrumgtw probe, see spectrumgtw Admin Console Configuration.
To enable the bidirectional integration, follow these steps:
  1. Launch the CA Spectrum OneClick home page, and click
    Administration
    .
  2. From the left Navigation pane, select UIM Configuration.
  3. In the UIM Configuration section, enter the following information in the corresponding fields:
    1. UIM Server Host Name
    2. UIM Server Port
    3. UMP Server Host Name
    4. UMP Server Port
    5. UMP Server Protocol
    6. UIM Group Name
      Please specify the UIM group name in this field if you want selective inventory synchronization (of the UIM group specified) from CA UIM to CA Spectrum.
  4. Select the dedicated SpectroSERVER from the drop-down list.
    : The new devices that are managed by CA UIM will be created under the selected SpectroSERVER.
  5. Select the
    CA Spectrum-UIM Bidirectional Management
    check box.
  6. Click
    Save.
  7. Verify that the UIMAdmin container model of type EventAdmin is created in
    OneClick-> Universe topology
    .
    You have enabled the CA Spectrum and CA UIM bidirectional integration successfully.
Share CA Spectrum inventory with CA UIM 
You need to create a global collection of the devices (and their interfaces) that you want to share with CA UIM. Once the global collection is created with all the required devices, CA UIM receives that inventory information. CA Spectrum inventory information is synchronized in CA UIM when new devices are included or deleted from that global collection.
CA Spectrum inventory need not include devices that belong to following model types or their derivatives:
  • Pingable
  • ContainerDevice
  • ClusterBaseResource
  • GenCblModem
  • GenSetTop
  • VMwareESXHost
  • SolarisZonesHost
  • IBMLPARHost
  • HyperVHost
The following procedure describes the search criteria that excludes these devices. If these devices are included in the global collection, they do not appear in CA UIM.
Follow these steps:
  1. From
    OneClick->Navigation pane
    right-click
    Global Collections
    , and select
    Create Global Collection
    .
  2. Enter the following details in the
    Create Global Collection
    dialog for this global collection:
    • Name
      For example, enter "InventoryGC".
    • Security String
  3. Click
    Landscapes
    to include devices from all the required landscapes in a DSS environment.
  4. Click
    Search Options
    to specify the search criteria for including devices in this global collection.
    The Search Options dialog appears.
  5. In the
    Search Criteria
    pane, click the
    Show Advanced >>
    button.
    The
    Hints
    pane appears.
  6. Click the
    Add Existing
    button.
    The
    Add Existing Search
    dialog appears.
  7. Expand
    Models
    , and select
    UIM Bidirectional Search
    .
  8. Click
    OK
    .
    You come back to the
    Search Options
    dialog.
  9. In the
    Update Options
    pane, select
    Real-Time update
    and then Click
    OK
    .
    You come back to the Create Global Collection dialog.
  10. Click OK.
    A global collection called "InventoryGC" is created, and then based on the search criteria devices are added to InventoryGC.
  • In a Fault Tolerant environment, to avoid model mismatch between SpectroSERVERs, perform Online Backup from a Primary MLS/Non-MLS SpectroSERVER to the respective Secondary SpectroSERVER.
  • You must enable the bidirectional integration and run a successful full synchronization of inventory and alarms, before performing the online backup.
  • If the CA UIM-CA Spectrum integration is enabled in a FT setup, it is recommended that you synchronize the Primary and Secondary SpectroSERVERs after the first successful synchronization. This will ensure that you have the integration data backed up in case the Primary/ dedicated SS (specified in the OneClick Admin > UIM Configuration) goes down.
  • It is also recommended that you synchronize the Primary and Secondary SpectroSERVERs, after a successful synchronization job, if you are moving Datacenters from a MLS to a Non-MLS landscape.
Custom Attributes Synchronzation 
Starting from CA Spectrum 10.2.1 release, using the Spectrum and UIM integration, you can synchronize the UIM custom attributes from UIM to Spectrum. When you enable the CA Spectrum-UIM Bidirectional Management integration, the following custom attributes are synced from UIM to CA Spectrum.
  • User Tag 1
  • User Tag 2 
  • Custom 1
  • Custom 2
  • Custom 3
  • Custom 4
  • Custom 5
Follow these steps to view the custom attributes in CA Spectrum:
  1. Open the OneClick Administration page.
  2. Navigate to 
    Administration
     tab > 
    UIM Configuration
     link in the left panel.
  3. Select the 
    CA Spectrum-UIM Bidirectional Management
     option.
    The integration is enabled. 
    After the integration is enabled, the alarms are synced from UIM to Spectrum. 
  4. In the Alarms table, right-click a column heading to open the Table Preferences dialog. 
  5. Select the custom attributes that you want to display.
    The selected custom attributes are added to the Alarms Table. The custom attributes are updated in the Alarms Table for the latest updates. 
The Alarm Details tab also displays the custom attributes and description that is synced from UIM. The Alam Details tab will not be updated for the latest updates. You can see the latest updates only in the Alarm Table.
Disable the Bidirectional Integration
You can disable the CA Spectrum and CA UIM bidirectional integration from the OneClick Administration page.
Follow these steps:
  1. Open the OneClick Administration page.
    The OneClick Administration page opens.
  2. Navigate to
    Administration
    tab > 
    UIM Configuration
    link in the left panel.
    The UIM Configuration window opens.
  3. Clear the 
    CA Spectrum-UIM Bidirectional Management
    option.
    The following dialog appears.
    Disable Bidirectional.png
  4. To confirm, click Ok.
    CA Spectrum-UIM Bidirectional integration is disabled successfully.
Troubleshooting
Symptom: 
EventModel not created on dedicated SpectroSERVER when any SpectroSERVER within the DSS setup is down
Scenario: 
When an alarm is raised on a device that is modeled in a SpectroSERVER apart from SpectroSERVER selected for integration (from the CA Spectrum OneClick Administration Page> UIM Configuration), is present in Global Collection, and the SpectroSERVER, holding the device goes down. EventModel is not created on that SpectroSERVER. 
Resolution:
You need to manually restart the SpectroSERVER which has the EventAdmin modeled.
Symptom: 
Source attribute is Empty or Null for alarms generated from IP Services related logical models.
Resolution: 
You need to clear alarms with Source attribute Empty or Null manually, in CA Spectrum or in CA UIM to maintain consistency across both CA Spectrum and CA UIM applications. 
For more known issues and troubleshooting tips for the integration using the gateway probe, see spectrumgtw Troubleshooting and Known Issues.