CA UIM (Unified Infrastructure Management) Integration Guide

This integration requires use of our v1 REST API which is currently in a decommissioning period, please contact support to gain access to a v1 REST API key to configure this integration.

For more information about the v1 REST API deprecation, take a look at our FAQ here: https://v2.developer.pagerduty.com/v2/docs/v1-rest-api-decommissioning-faq

We are working with partners to upgrade integrations to use our v2 REST API.

CA UIM (Unified Infrastructure Management, formerly Nimsoft Monitor) is a scalable IT monitoring solution that provides 360-degree visibility into systems and infrastructure performance. It delivers a single, unified architecture for both traditional and cloud environments, enabling you to proactively monitor performance and availability to ensure that your customers are up and running.

If you have any questions or require assistance in configuring this integration, please contact our support team at support@pagerduty.com.

Here is a short video demonstrating the integration:

Click here to access the email based integration guide.

Click here to view the comprehensive probe guide for the PagerDuty gateway.

In PagerDuty

  1. From the Configuration menu, select Services.
  2. On your Services page:If you are creating a new service for your integration, click +Add New Service.If you are adding your integration to an existing service, click the name of the service you want to add the integration to. then click the Integrations tab and click the +New Integration button.RS-Add-New-ServiceRS-Add-Integration-Existing-Service
  3. Select your app from the Integration Type menu and enter an Integration Name.If you are creating a new service for your integration, in General Settings, enter a Name for your new service. Then, in Incident Settings, specify the Escalation Policy, Notification Urgency, and Incident Behavior for your new service.
  4. Click the Add Service or Add Integration button to save your new integration. You will be redirected to the Integrations page for your service.
    RS-Integration-Settings
  5. Copy the Integration Key for your new integration: RS_API_pd_3
  6. From the Configuration menu, select API Access.
    apiaccess-0
  7. On your API Access page, click the +Create New API Key button.apiaccess-1
  8. In the dialog that pops up, you’ll be prompted to enter a Description for your key, and choose an API version. You will also have the option to create the key as Read-only; leaving this box unchecked will create a full access key._int3__API_Keys_-_PagerDuty A note about versioning: API v2.0 is designed to make it easier for new integrations to communicate with PagerDuty. Most existing PagerDuty integrations will require an API v1.0 key. If you have questions on which API version to use, please contact support@pagerduty.com
  9. Once you have filled in your options, click Create Key.
  10. Once you click Create Key, you will see a dialog displaying your key and confirming the options you filled in on the previous step. Make sure to copy this key into any application that needs it now, as you will not have access to the key after this step. If you lose a key that you created previously and need access to it again, you should remove the key and create a new one. Click Close once you have successfully copied your key.api__2_

In CA UIM

  1. Download the PagerDuty Gateway probe
  2. Open the CA UIM Infrastructure Manager.
  3. Drop the pagerdutygtw probe into your UIM archive.
  4. Deploy the pagerdutygtw probe to your primary UIM hub.
  5. You should now see a Marketplace folder under your UIM hub.Screenshot_2016-03-30_15_18_36
  6. Now you will need to create a queue to route messages to PagerDuty:
    1. Go to your primary hub and open the hub probe.Screenshot_2016-03-30_15_30_23
    2. Go to the Queues tab and and click create a new queue.
    3. Name the queue  pagerduty.
    4. For Type select attach from the drop-down menu.
    5. Then, for the Subject, select the alarm types that will be sent to PagerDuty. The subjects required are the following (you can copy and paste these to prevent potential errors):
      alarm_new,alarm_update,alarm_assign,alarm_close
    6. Click OK to save the changes.ca_uim__1_
  7. Use the Probe Utility (select the pagerdutygtw probe and press ctrl+p) to call the set_api callback. (note: you will need to be an admin to complete these steps). Now, we need to give the probe specific access rights. 

  8. Select set_admin from the drop-down menu and provide the UIM username and password. Then, click the green play button. ca_uim__11_
  9. Next, in the probe utility, select set_api from the drop-down menu, then fill in the following:
    1. To get your user_id go to your My Profile page in PagerDuty, and grab the alphanumeric number in the URL: Lisa_Thompson_-_PagerDuty
    2. For the user_id enter in your alphanumeric user id number.ca_uim__7_
    3. In the subdomain field, enter in your PagerDuty subdomain (note: .pagerduty.com is not required).
    4. Earlier (step 6 under the ‘In PagerDuty’ section of this guide) we created an API access key, in the api_key field enter in your PagerDuty API access key.
    5. After adding in the API access key, click the ‘play’ button and you should receive a ‘Command Status: OK’ at the bottom right-hand corner .ca_uim__10_
  10. Now we are ready to tell the pagerdutygtw probe which UIM alarms should be forwarded to PagerDuty. Double-click on the pagerdutygtw probe.ca_uim__14_

    Note:  The following instructions are provided as a simple example to forward “critical” UIM alarms to PagerDuty.  For more advanced mappings between UIM and PagerDuty, please reference the PagerDuty Gateway documentation referenced at the beginning of this guide.

  11. Navigate to the alarm_triggers section and configure the settings as desired to choose which UIM alarms will be sent to PagerDuty.
    1. Set the alarm to active and select yes.
    2. Enter in your PagerDuty integration key in the service_key field.ca_uim__13_
  12. Within the users section of the probe, create a new key for each PagerDuty user called “uimuser”, and be sure to enter the users UIM user name here. This will keep the alarm records in sync to know who did what (and assumes that user IDs may be different between the 2 systems).ca_uim__15_
  13. To test the integration, open the CA UIM nas probe. Right-click on the lower half of the status tab and choose send test alarm. Make sure the test alert severity is critical. ca_uim__16_

 

FAQ

Is this probe bi-directional?

Yes it is! Alerts that are acknowledged in PagerDuty or in CA UIM are automatically synchronized between the two products.

Can I integrate CA UIM with multiple PagerDuty services?

Yes! You can configure sending alarms to different PagerDuty services in the Alarm Trigger section.

 How can I troubleshoot this integration/see the logs for this integration?

You can view the logs by right-clicking on the probe and selecting view logs.

How can I see what version of the probe I am using? 

By clicking open the probe, which shows the content/probe package.

I’m getting an error in the logs that reads “waiting for probe to finish starting.” How do I fix this?

Go to Marketplace under the main UIM hub. Right click on the probe (pagerdutygtw) and select “Restart”. If that does not work, disable and then re-enable the probe.