Integrate CA Spectrum and CA UIM for Virtualization Management

Contents
casp102
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 nis API/ NIS Restful API (Wasp Edition)
snmpgtw /SBGW
spectrumgtw
10.1
8.2, 8.3
YES
NA
10.1.1
8.2, 8.3
YES
NA
10.1.2 or higher
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.
NA
8.47, 8.49
10.1.2 / 10.2
8.5.1
NA
8.51
10.2.1
8.5.1
NA
8.6, 8.61
10.2.2
8.5.1 and 8.5.1 SP1
NA
8.64
10.2.3
8.5.1 and 8.5.1 SP1
  • From CA Spectrum 10.2.3, there is a change in the GUI for configuring the Spectrum-UIM integration. The integration configuration is now completely moved to the spectrumgtw probe Admin Console, and if you are setting up the integration for the first time, you can just enable the integration through spectrumgtw probe or disable the integration from the CA Spectrum OneClick Admin pages > UIM Configuration. 
  • To enable and configure the virtualization management capabilities, refer to the VM Server Configuration section of the spectrumgtw Admin Console documentation.
  • 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.
NA
8.65
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.
Contents
This section describes how to set up the integration between the current releases of CA Spectrum and CA UIM for Virtualization Management. It also describes how to use its features to perform specific tasks such as synchronize inventory at regular intervals, manage alarms and events, and run reports.
The following video describes how you can integrate CA Spectrum and CA UIM for Virtualization Management to monitor virtual datacenters and to use CA Spectrum’s root cause analysis feature to rapidly troubleshoot and resolve issues:

Prerequisites for CA Spectrum and CA UIM Integration for Virtualization Management
Consider the following Prerequisites for the integration:
If you have enabled CA Spectrum and CA UIM integration for server management in 9.4 release, while upgrading to CA Spectrum Release 10.1.2, you must configure the latest CA UIM REST API (nisapi_WASP).
If you are integrating CA-UIM with CA Spectrum
till r10.1.1
. Follow these steps:
  1. 8.0.4 probe must be downloaded and configured before enabling the integration. You can download nisapi from the following link:
    Download nisapi 8.0.4 at http://nmscdn.nimsoft.com/nisapi_8.0.0/nisapi_service_host-8.0.4.zip.
  2. To migrate nisrest to nisapi, take the following steps:
    1. Stop svchost service.
    2. Navigate to C:\Program Files (x86)\CA UIM\probes\service\service_host\catalinaBase\webapps
    3. Remove nisrest.war and the nisrest directory
    4. Add latest nisapi to archive.
    5. Deploy nisapi and restart svchost service.
      Migrating nisrest to nisapi is a one time activity that is performed before enabling the integration.
  3. Verify that the VMware (
    vmware
    ) and SNMP Gateway (
    snmpgtw
    ) probes are configured before enabling the CA Spectrum and CA UIM integration.
  4. All the primary SpectroSERVERs should be up and running while enabling the CA Spectrum and CA UIM integration.
  5. Enable QoS metrics and alarms in CA UIM for Spectrum OneClick views and condition-correlation to work.
  6. CA UIM integration must be enabled on the OneClick server, which is configured to Main Location Server (MLS) (preferably server which does not have SRM).
  7. CA Spectrum models virtual machines (VMs) whose PrimaryDNSName and PrimaryIPV4address attribute data are not reported to CA Spectrum by UIM. For UIM to report these attributes, deploy VMware Tools on all the VMs.
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
Deploy and Configure Probes
To optimize the CA Spectrum and CA UIM integration, deploy and configure the following CA UIM probes on CA UIM server:
  • Sends traps from CA UIM to CA Spectrum. The SNMP gateway converts alarms to SNMP trap messages that are readable by any SNMP-based event manager. 
  • The vmware probe automates all common monitoring and data collection tasks, and lets you focus on problems as they arise. The vmware probe collects and stores data and information from the monitored components through VMware Virtual Center (vCenter), or by connecting to ESX servers directly, at customizable intervals. You can define alarms to be generated when specified thresholds are breached or when the service is unavailable. 
  • net_connect (Network Connectivity Monitoring) probe measures network connectivity that is based on "ping" (ICMP ECHO) and the TCP connections to a list of user-defined services. The service can be NetBIOS, Telnet, FTP, and HTTP. The probe supports the CA UIM family of solutions by sending quality of service (QoS) messages.
  • (nisapi) service_host or wasp
    Queries the CA Nimsoft Manager using the Restfull Services API to retrieve the list of CA UIM models to be monitored. Deploy service_host v8.04/ wasp v8.4.2 or higher. 
  • The CPU, Disk, Memory Performance Monitoring (cdm) probe monitors the performance and resource load on the system with the robot. The CA UIM CPU, Disk & Memory (cdm) probe generates alarms that are based on configured threshold values and trending statistics.
    The probe provides the following benefits:
    • Generate alarms that are based on configured threshold values. The probe generates alarms that can trigger corrective actions immediately.
    • Generate trending Quality of Service (QoS) data. The information is measured and sent to the data_engine probe to process and store in the CA UIM database. The historical data facilitates capacity planning for monitored systems in the IT environment. Some examples are as follows:
      • View how disks are filling up over time
      • Plan batch jobs according to the CPU utilization
      • Upgrade systems which consistently operate near capacity
  • The spectrumgtw (Spectrum Gateway) probe provides a bidirectional (CA UIM to CA Spectrum and CA Spectrum to CA UIM) integration between CA Unified Infrastructure Management and CA Spectrum enabling you to perform the following actions:
    • Export and correlate CA Spectrum Inventory from a Global Collection to CA UIM inventory.
    • Bi-directional synchronization of alarms
    • Bi-directional Clear / Update of alarms
    • View symptomatic CA Spectrum alarms in the context for the root-cause alarm in CA UIM
    • Ticket ID synchronization between CA Spectrum and CA UIM
From CA Spectrum 10.2.1, all CA UIM events (apart from events related to VMWare and servers) are no longer considered as generic events. 
Specific events raised on CA UIM from the following probes are mapped to unique events created in CA Spectrum. This allows you to manage the events (raised on CA UIM) from CA Spectrum more efficiently.
Additional event mapping for select metrics from the following probes (along with cdm and net_connect probes) is added from CA Spectrum 10.2.1. Additional event mapping for Please refer to Additional event mapping from CA UIM Probes to CA Spectrum
  • The Log Monitoring (logmon) probe scans ASCII-based systems and application log files by matching specified expressions. Alarms are generated when the log file content matches the defined expression. 
  • The Remote System Probe (rsp) allows you to monitor system metrics. The probe collects performance data in an agentless manner without installing proprietary software on the system.
  •  sqlserver 
    The SQL Server Monitoring (sqlserver) probe constantly monitors the internal performance and space allocation of SQL Server databases. The probe can run locally on the database server or it can be configured to run as a remote client. The probe feeds essential information that is based on predefined criteria to the UIM availability manager for appropriate alert notification, as required. An extensive range of checkpoints can be selected and individually scheduled to meet your monitoring requirements. The probe will run selected SQLs to extract vital information about your SQL Servers. The information is presented to database-administrator as alarms or reports. For more information, see sqlserver Metrics
  • The (Process Monitoring) processes probe monitors the specified processes to detect any error situation. The probe also retrieves information about the process, for example, the CPU usage, memory usage, and so on. For more information, see processes Metrics
You can configure the CA UIM probes through the Probe Configuration interface. For more information, see the CA Unified Infrastructure Management Probe Space.
How to Integrate CA Spectrum and CA UIM for Virtualization Management
From the OneClick Administration page, you can enable the integration between CA Spectrum and CA UIM for Virtualization Management. When you enable the integration all the virtual entities managed by CA UIM appear in CA Spectrum.
If you want to change any details on the Administration page, refresh the page before making any changes.
If you enable the integration for VMware Management, all the entities that are managed by Virtual Host Manager (VHM) such as VMware, Hyper-V, Zones, Huawei SingleCloud, and LPAR through CA Virtual Application Insight Module (VAIM) are disabled permanently and all the existing VHM models are deleted. You must reinstall CA Spectrum for CA VAIM based Virtualization Management.
Follow these steps:
  1. Open the OneClick Administration page.
    The OneClick Administration page opens.
  2. Click the Administration tab.
    Links to various OneClick web server configuration pages is displayed.
  3. Click the UIM Configuration link in the left panel.
    (From CA Spectrum 10.2.3 release) Select the
    Legacy Integration
    radio button.
    The following image illustrates the configuration options that are available in the UIM Configuration window:
    image2018-2-20 13:58:32.png
    (Till CA Spectrum 10.2.2 release)
    The following image illustrates the configuration options that are available in the UIM Configuration window:
    Spectrum UIM VMware Integration_1022.png
    UIM Server Host Name
    Indicates the IP address/hostname of the UIM Server.
    UIM Server Port
    Indicates the server port number of CA UIM.
    UMP Server Host Name
    Indicates the IP address/hostname of UMP.
    UMP Server Port
    Indicates the server port number of UMP. 
    UMP Server Protocol
    Indicates the network protocol to connect to the CA UMP server.
     
    For successful encrypted communication (https protocol) between CA Spectrum and UIM UMP Server, you must import SSL Certificate of UIM UMP Server into Spectrum OneClick Server. To import the certificate, from the OneClick home page select
    Administration
    ,
    SSL Certificates
    , upload the certificate file then click
    Save
    . Restart the OneClick web server for the changes to take effect.
    UIM Group Name
    Indicates the group name whose inventory you want to synchronize from the CA UIM server. 
    Information!
    Inventory from the group you specify in this field is synchronized from CA UIM to CA Spectrum. For more information, see Create and Manage Groups in USM.
    If you leave the UIM/UMP Group Name field blank, all inventory from the specified UIM server is synchronized with CA Spectrum.
  4. Select the SpectroSERVER under which the new models for devices managed by CA UIM are to be created.
  5. To enable the CA UIM integration for VMware, select VMware Management. (
    Till CA Spectrum 10.2.2 and spectrumgtw probe v8.65
    )
     If you are setting up the integration using CA Spectrum 10.2.3 and spectrumgtw probe v8.65, you can no longer enable/disable the VMware Management capability from the UIM Configuration page. To enable and configure the VMware Management capability for VMware, please refer to the spectrumgtw AC documentation.
    The following warning message appears:
    VMware message_101.png
  6. To confirm, click
    OK.
    In the OneClick Admin page, do not enable or disable the '
    VMware Management
    ' or '
    Server Management
    ' options when the MLS is down. This may cause unexpected errors.
    In the CA Spectrum OneClick console, do not create any container of type '
    UIMInventoryContainer
    '.
  7. Click
    Test.
    If test is successful, “
    Test connection to UIM Server was successful
    ”, message appears.
  8. Click
    Save.
    Successfully saved configuration to the database message appears.
    CA UIM integration is now enabled.
If you change any settings on any of the OneClick server other than the integration OneClick server. The message, "Saving details on this OC will change the Integration OC Server. Click [OK] to continue" appears. If you click Save, the integration OneClick server changes and the details are saved. If you click Cancel, the details are saved but the integration OneClick server remains same.
If the Main Location Server (MLS) in a Distributed SpectroSERVER (DSS) setup is down and if it does not have a secondary SpectroSERVER, the configuration information that is specified in the UIM Configuration page fails to save to the database. We recommend that you use the Fault Tolerance (FT) setup for MLS to avoid any inconsistent behavior.
  • 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.
Disable the Integration
You can disable the CA Spectrum and CA UIM Integration for Virtualization Management from the OneClick Administration page.
From CA Spectrum 10.2.3, select the No Integration option from the UIM Configuration page to disable the integration. To disable only VMware integration capabilities you need to disable the VM Server Integration from the VMware Configuration section of the spectrumgtw probe Admin Console. For more information, please refer to the spectrumgtw Admin Console documentation.
Follow these steps(Till CA Spectrum 10.2.2):
  1. Open the OneClick Administration page.
    The OneClick Administration page opens.
  2. Click the Administration tab.
    Links to various OneClick web server configuration pages is displayed.
  3. Click the UIM Configuration link in the left panel.
    The UIM Configuration window opens.
  4. Consider the following scenarios to disable the CA UIM integration:
    • Clear both Server and VMware Management options and click
      Save
      .
      The following message appears:
      Disable Integration_101.png
      Click Ok, CA Spectrum and CA UIM integration for both Server Management and Virtualization Management is disabled.
      Wait for the all the CA UIM Host server models and the folder hierarchy to be cleared from the UIM Manager in the OneClick view after disabling the integration. To validate, search for any UIM Host Server models, using the search option.
    • If you clear the VMware Management check box and click
      Save.
      The following message appears:
      Disable Confirmation_101.png
Click Ok,
CA Spectrum and CA UIM integration for Virtualization Management is disabled.