Integrating CA Spectrum and CA UIM through the Web Server for Server Management

 
casp101
 
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. It is recommended to use the Spectrum Gateway (spectrumgtw) probe for this purpose.
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
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 nisapi package is deployed in wasp as part of the CA UIM installation or upgrade.
NA
YES
We recommend that you go through the ca_spectrum-ca_uim_integration_using_spectrumgtw_probe_-_fact_sheet.pdf to understand the changes to the integration whether you are new to this integration or an existing user.
This section describes how to set up the integration between CA Spectrum and CA UIM through the web server for server management. It also describes how to use its features to perform specific tasks such as synchronize inventory, manage alarms and events, and run reports.
Contents
How to Integrate CA Spectrum and CA UIM through the Web Server
The integration between CA Spectrum and CA UIM through Web Server is designed to support server management. The HostServer models resulting from the integration provides traditional Spectrum capabilities such as layer2 connectivity and fault isolation with the features supported by CA UIM. You can use the Launch-in-Context feature to launch the CA Unified Management Portal (UMP) view from the server models in CA Spectrum to view the server information.
When the CA UIM and CA Spectrum integration is enabled from the OneClick Administration page, CA Spectrum receives the data from CA UIM through the Rest API. Once we get the data from the Rest API, CA UIM hosts are modeled in CA Spectrum.
The following diagram illustrates the CA UIM - CA Spectrum Integration Architecture from CA Spectrum v10.1.2:
Integration Architecture.png
Existing CA Spectrum – CA UIM integration for alarms through southboundgateway and CA UIM’s snmpgtw probe should be stopped by deleting the associated Spectrum profile from CA UIM’s snmpgtw probe.
Alarms sent from CA UIM to CA Spectrum will no longer leverage the SNMP Gateway or Spectrum Southbound gateway. Instead, they will be routed through the new Spectrum Gateway Probe.
Nisapi-service-host is replaced by nisapi-wasp for inventory sync from CA UIM to CA Spectrum. 
The following diagram illustrates the CA UIM - CA Spectrum Integration Architecture till CA Spectrum v10.1.1:
CA Spectrum and CA Nimsoft Integration Architecture
The alert data is sent from CA UIM to the SpectroSERVER of CA Spectrum through the Southbound Gateway component. The received data is mapped to a CA Spectrum event. The Southbound Gateway determines the appropriate EventAdmin model to forward the event.
Metric violation traps that are coming from CA UIM are asserted on the respective Nimsoft host models in CA Spectrum.
 
Review the following process to integrate CA UIM and CA Spectrum through the Web Server:
Prerequisites and Recommendations
Consider the following prerequisites for the CA Spectrum and CA UIM integration (
till CA Spectrum r10.1.1
):
  • Licensed installation of CA Spectrum 10.1 and CA UIM 8.2 or 8.3 provided that nisapi 8.0.4 probe is deployed.
  • The snmpgtw, cdm, and net_connect must be deployed and configured before integrating CA UIM and CA Spectrum through the Web Server.
    Download nisapi 8.0.4 at http://nmscdn.nimsoft.com/nisapi_8.0.0/nisapi_service_host-8.0.4.zip.
  • For Launch-in-Context to work, UMP must be configured to UIM.
Consider the following prerequisites for the CA Spectrum and CA UIM integration from CA Spectrum
r10.1.2
:
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
  • CA Unified Infrastructure Management Server should be at version 8.4.7 or later.
  • Existing CA Spectrum – CA UIM integration for alarms through southboundgateway and CA UIM’s snmpgtw probe should be stopped by deleting the Spectrum profile from CA UIM’s snmpgtw probe
  • EMS 8.4.3
    ,
    NAS
    and
    Trellis
    probes should be deployed and running.
  • spectrumgtw probe must be deployed on a robot connected to primary hub 
  • spectrum-uim-service-impl has to be deployed on the primary robot where Trellis is installed and Trellis has to be restarted.
  • For server/vmware inventory synchronization
    • vmware probe version 6.72 or higher
  • Use the latest ticketing gateway probes for Ticket ID synchronization and ensure the key
    create_incidents_for_spectrum_alarms
    is set to
    “yes”
    to allow probe to create tickets for spectrum alarm
Consider the following recommendations for the integration:
  • If a new SpectroSERVER is added to the Distributed SpectroSERVER (DSS) setup, you must restart the OneClick server.
  • If a child SpectroSERVER is removed from the DSS setup, restart the OneClick server.
  • If anyone of the available SpectroSERVER is initialized to legacy database or another database, restart the OneClick server.
  • Specify a SpectroSERVER that has less load as the dedicated SpectroSERVER for CA UIM integration.
  • Use a OneClick web server which is not integrated with Spectrum Report Manager.
Deploy and Configure Probes
To enable the CA Spectrum and CA UIM integration, deploy and configure the following CA UIM probes on CA UIM server:
  • snmpgtw
    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.
  • cdm
    Monitors performance and load on critical system resources such as CPU, Disk, and Memory. The CA UIM CPU, Disk & Memory (cdm) probe generates alarms that are based on configured threshold values and trending statistics.
  • net_connect
    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
    Queries the CA Nimsoft Manager using the Restfull Services API to retrieve the list of CA UIM models to be monitored. Deploy nisapi 8.0.4, for more information about the download location, see the Prerequisites section above. From CA UIM 8.4.7 onwards,you no longer have to deploy nisapi separately. By default, the CA Spectrum integration uses the nisapi package deployed in wasp as part of a CA UIM installation or upgrade.
     
You can configure the CA UIM probes through the Probe Configuration interface. For more information, see the CA Unified Infrastructure Management Probe Space.
Enable the Integration
You can enable the CA Spectrum and CA UIM integration through the web server from the OneClick Administration page. Specify the CA UIM Configuration information such as CA UIM Server Host Name, CA UIM Server Port, Unified Management Portal (UMP) Server Host Name, and UMP Server Port to enable the integration.
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 CA UIM Configuration link in the left panel.
    The CA UIM Configuration page opens.
    The following image illustrates the configuration options that are available in the CA UIM Configuration window:
    Enable Integration-Server Management_101.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.
  4. Select the SpectroSERVER for the new UIM Host models to be created.
  5. To enable the CA UIM integration, select Enable and click Test.
    If test is successful, Successfully connected to UIM message appears.
  6. 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 OneClick server remains same.
Disable the Integration
You can disable the CA Spectrum and CA UIM Integration from the OneClick Administration page. 
You must disable CA UIM integration from the web server on which the integration is enabled.
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.
    The UIM Configuration window opens.
  4. To disable the CA UIM integration, select Disable and click Save.
    The confirmation dialog appears.
    The following image displays the confirmation dialog that appears after disabling the integration:
    Server management Disable.png
  5. To confirm, click Ok.
    CA UIM integration is disabled successfully.
Wait for the all the 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.
Incremental and Full Synchronization
This Integration supports incremental and full synchronization. When the CA Spectrum and CA UIM integration is enabled, synchronization occurs automatically with the default scheduled timings displayed in the OneClick view.
Incremental Synchronization
Additions and modifications of devices in CA UIM are reflected in CA Spectrum after incremental synchronization. You can set the Incremental Sync interval in the OneClick view.
Full Synchronization
Full synchronization occurs when the CA Spectrum and CA UIM integration is enabled. Thereafter, the full synchronization occurs at a scheduled time based on the schedule that is selected in the OneClick view. During full sync CA Spectrum queries CA UIM for all the hosts that are managed by CA UIM. Once Spectrum receives this data, reconciliation is performed and new hosts (if any) are modeled in Spectrum. The un-managed hosts are removed.
The minimum schedule time for full sync is one day. The last full sync time in the OneClick view displays the previous full sync completion time. The sync times are based on the OneClick tomcat server time.
Do not schedule the incremental or full sync at smaller intervals, you may experience a performance impact if a large number of servers is being monitored by CA UIM.
Schedule full synchronization during non-business hours.
Follow these steps:
  1. Open the CA Spectrum OneClick console.
  2. From the Navigation panel, select
    UIM Manager
    .
    The contents pane for UIM Manager opens.
  3. Click the
    Information
    tab and select
    UIM Sync Configuration
    .
    Information on incremental and full synchronization is displayed.
  4. To schedule incremental sync, click 
    Set
    .
    The Time interval window opens.
  5. Specify the time interval and click Ok.
    Default:
    300 minutes
    Minimum:
    10 minutes
    Incremental sync is now scheduled
  6. To schedule full sync, click the
    Schedule
    button that is available in the
    UIM Sync Configuration
    section.
    The
    Create Schedule
    window opens.
  7. Specify the following Recurrence information:
    • Days
      Default:
      7
      Maximum:
      31
    • Hours
      Default:
      00:01
      Maximum:
      23:59
  8. Click Ok.
    Full sync is scheduled.
Reconciling CA UIM entity data with existing CA Spectrum models
During full synchronization or incremental synchronization, when a new CA UIM entity is reported to CA Spectrum from CA UIM, CA Spectrum will perform a search to identify if this entity was modeled during CA Spectrum discovery and modeling. If such an existing model is found, CA Spectrum will reconcile the CA UIM entity information with the existing model, instead of creating a new model. This search is performed on all landscapes in the Distributed SpectroSERVER (DSS) setup.
In cases where an existing model is not found and reconciliation is not performed, CA Spectrum will model the entity in the SpectroSERVER specified in the
OneClick Admin Configuration
>
UIM Configuration
page.  
CA Spectrum uses the IP Address reported by the entity to perform this search. If IP Address is not reported, the search is performed using the reported MAC address.
If neither (IP or MAC Address) are reported, CA Spectrum will not be able to reconcile that entity even if the entity is discovered and modeled in CA Spectrum.
QoS Metrics
QoS Metric Information provides the metrics for both CPU and memory usage. From the Navigation Pane of OneClick Console, you can access the QoS metrics information of the available NimsoftHost Models. The following metrics are available for each UIM Host Model modeled in CA Spectrum:
  • QoS CPU Usage Metrics
  • QoS Multi Usage Metrics
  • QoS Memory Metrics
  • QoS Disk Metrics
Follow these steps:
  1. From the OneClick Console, select the UIM Host Model available in the Navigation Panel.
    Contents Pane for the selected UIM Host Model is displayed.
  2. Click the Information tab on Contents Pane.
    UIM Host Model information is displayed.
  3. Expand QoS Metric Information SubView.
    QoS Metrics for the selected UIM Host Model is displayed.
    The following image displays the QoS Metrics for the UIM Host Model in CA Spectrum:
    QOS Metrics 101.png
    The following QoS Metrics are supported in this integration:
    • CPU Usage for System
      Specifies the time that CPU spends on system tasks in percent.
    • CPU Usage for User
      Measures the time that CPU spends on user tasks in percent.
    • CPU Usage for Wait
      Measures the time the CPU waits when accessing external memory or another device in percent.
    • CPU Multi Usage for System
      Measures the time the CPU spends on system tasks in percent.
    • CPU Multi Usage for User
      Measures the time that CPU spends on user tasks in percent.
    • CPU Multi Usage for Wait
      Measures the time the CPU waits when accessing external memory or another device in percent.
    • Disk Available
      Measures the amount of total available disk space for the file system. The Disk Available metrics are populated for only Network file systems.
    • Disk Usage
      Measures the amount of total used disk space in the file system.
    • Disk Delta
      Measures the amount of total disk usage change in the file system.
    • Memory Usage
      Measures the amount of total available memory (physical and virtual memory) used in megabytes
    • Physical Memory
      Measures the amount of total available physical memory that is used in megabytes.
    • Swap Memory
      Measures the space on the disk that is used for the swap file in megabytes.
    • Memory Paging
      Measures the amount of memory that is sent or reads from virtual memory in kilobytes/second.
    • Computing Uptime
      Measures the computer uptime in seconds every hour.
    You may experience latency in loading QoS Metrics as the values are generated dynamically from CA UIM server, when queried.
Launch-in-Context
The Launch-in-context feature is used to view the Unified Management Portal (UMP) of the host for the CA UIM host model. This feature provides a detailed information about the UIM host model such as disk usage, cpu usage, processor queue length, paging, and memory usage. The information about the UIM host model is displayed graphically.
If you are launching the UMP view for the first time in a browser, a dialog for user credentials appear. The user credentials dialog does not appear if you are launching the UMP view using the same browser instance.
Follow these steps:
  1. Open the CA Spectrum OneClick console.
  2. From the Navigation panel, select UIM Manager and Servers.
    A complete list of host models is displayed in respective folders.
  3. Right-click a host model and select Launch UIM UMP View.
    The UIM UMP login page opens.
    The following image displays the available host models and the option to launch the UMP view from the OneClick console:
    Launch-In-Context_WS.png
  4. Enter the UIM UMP credentials and click Login.
    The selected model details are displayed and the UIM UMP login is successful.
    The following image displays the UIM UMP view:
    The Launch-in-Context UMP view
Locater Search
You can use the search functionality in the Locater tab to find the CA UIM related devices that are available in the CA Spectrum environment. Search can be performed based on the Operating system type such as Windows, Linux, Solaris, and Other. Using this functionality, you can also search for all the NimsoftHostServer models and CA UIM models that are available in CA Spectrum. The Search results appear in the Results tab of the Contents panel. Detailed information for application models that are selected in the results list appears in the Component Detail panel. Access Locater search from the Locater tab of the Navigation Panel.
Follow these steps:
  1. Open the CA Spectrum OneClick Console.
  2. From the Navigation Panel, Click the Locater tab.
    The Search Options window opens.
  3. Expand UIM Manager and select the models.
    The Locater Search results are displayed in the Contents pane.
    The following figure displays the Locater Search results for UIM Configuration Manager:
    Locater Search Server Management.png
Reports
You can generate asset, alarm, availability, and WEBI reports for the CA UIM hosts. You can access InfoView from the OneClick home page to generate and manage reports. For more information, see the section.
Outage Events
This section lists the events that mark the beginning and end of either a planned or unplanned model outage. The following list of events is used for the calculation of availability reports for UIM Host Server Models.
  • Up events
    • 0x6330057
    • 0x6330000
  • Down events
    • 0x6330003
    • 0x6330056
Standard up and down events are ignored for UIM Host Server Models while calculating the outages. For an existing spectrum model the outage is calculated based on standard up and down events.
Traps and Alarms Support
This integration supports the following alarms:
Generic Alarms
If any threshold violation occur on UIM hosts, generic alarms are raised.
Event Code Range:
0x6330000 – 0x6330005
Disk Alarms
If the disk usage is high or the disk space availability is low on UIM hosts, disk alarms are raised.
Event Code Range:
0x6330030 – 0x6330035
Memory Alarms
If low memory or any threshold violations are noticed on UIM hosts, raise memory alarms.
Event Code Range:
0x6330040 – 0x6330045
CPU Alarms
If CPU utilization is high on UIM hosts, CPU alarms are raised.
Event Code Range:
0x6330050 – 0x6330055
Condition Correlation and Fault Isolation in CA UIM Integration
If a managed device stops responding to polls, the CA Spectrum fault isolation algorithm determines whether to create a critical alarm for the UIM hosts or suppress its alarm state. The unreachable device is the root cause of the alarm.
After the integration of CA Spectrum and CA UIM, the events/alarms are received from both Spectrum polling and CA UIM. Consider the following scenarios to apply condition correlation:
Scenario 1
If a Spectrum event is generated on the UIM host before the UIM event, condition correlation applies and the UIM event suppresses the Spectrum event.
Scenario 2
If a UIM Event is generated on the UIM host before the Spectrum event, condition correlation applies and the events are asserted on their respective host.
Scenario 3
If only Spectrum event is generated on the UIM host, condition correlation cannot be performed until the UIM event is generated and the Spectrum Event is displayed on the UIM host.
Scenario 4
If only UIM event is generated, you cannot perform condition correlation and the Nimsoft Event is displayed on the Nimsoft host.
Debugging
Debugging in CA Spectrum lets you track the data flow from CA UIM to CA Spectrum. It investigates and resolves integration related issues. The Start Client Debug Console contains various debug modules. Turn on CA UIM Integration Information to track alerts and CIs that flow from CA UIM to CA Spectrum.
To use Start Client Debug Console, you must first have a running OneClick client. This debug tool lets you turn on debugging output that can be seen in the Java Web Start log.
Follow these steps:
  1. Open the OneClick Adminstration page.
    The OneClick Adminstration page opens.
  2. Click the Administration tab.
    Links to various OneClick web server configuration pages is displayed.
  3. Click the Debugging tab.
    A panel with various links to view debugging output opens.
  4. Click Web Server Debug Page (Runtime).
    A list of debug modules is displayed.
    The following image displays the list of available debug modules:
    Debug Modules
  5. To enable debug, select On for the UIM Integration Information debug module.
  6. Select Max as Desired Level and click Apply.
    Debug is enabled.
  7. To disable debug, select OFF and click Apply.
    Debug is disabled.