Catalyst Center-to-PagerDuty Integration

About Catalyst Center-to-PagerDuty integration

You can integrate Catalyst Center with PagerDuty.


Note

PagerDuty is an incident management platform that provides reliable notifications to detect and correct infrastructure problems. For information about PagerDuty, see https://www.pagerduty.com/.

This table displays the supported Catalyst Center-to-PagerDuty integration workflow.

Table 1. Catalyst Center-to-PagerDuty integration workflow
Step Description

Step 1

Review these Catalyst Center-to-PagerDuty integration requirements:

  • The latest Catalyst Center release.

  • PagerDuty

Note

 

PagerDuty integration with Catalyst Center is accomplished using the PagerDuty Events REST APIs and the Catalyst Center Events framework.

Step 2

Configure the integration settings. From the main menu, choose System > Settings > System Configuration > Integration Settings. Enter your callback URL hostname or IP address.

Step 3

Select and subscribe one or more events to forward notifications from Catalyst Center to PagerDuty.

To access an event in Catalyst Center, click the menu icon and choose Platform > Developer Toolkit > Event Notifications > Event Catalog. Event Catalog displays all the events.

Click the Notification tab to subscribe to an event.

Step 4

In the Notifications tab, create a new notification for the event.

Follow the steps in the Create a New Notification wizard and select PagerDuty as the notification channel.

This data must be entered in the Catalyst Center platform GUI for the selected event:

  • PagerDuty Events API URL

  • PagerDuty Integration key (routing key)

For detailed information about this event configuration procedure, see Subscribe Catalyst Center event notifications to PagerDuty.

Step 5

Notifications for the selected event are now forwarded to PagerDuty from Catalyst Center.

These are the supported workflow connections between Catalyst Center issues and PagerDuty events:

  • Open Catalyst Center to trigger PagerDuty.

Step 6

PagerDuty responds to Catalyst Center with one of these REST API responses:

  • 202: The event has been accepted by PagerDuty.

  • 400: Bad Request - Check that the JSON is valid.

  • 429: Too many API calls at a time.

  • 500 or other 5xx: Internal Server Error - the PagerDuty server experienced an error while processing the event.

  • Networking Error: Error while trying to communicate with PagerDuty servers.

Step 7

Review and change (if necessary) the incident status in PagerDuty.

Note

 
See your PagerDuty documentation for information about doing this step.

Step 8

Close the incident in PagerDuty.

Note

 
See your PagerDuty documentation for information about doing this step.

Step 9

PagerDuty integration is a one-way notification from Catalyst Center to PagerDuty. Catalyst Center is not dependent on PagerDuty status to close an issue.

Subscribe Catalyst Center event notifications to PagerDuty

You can configure a Catalyst Center platform event notification to appear in PagerDuty as an alert. Follow the steps described in this procedure to configure a Catalyst Center event notification so that it appears in PagerDuty.

Before you begin

Ensure that you have PagerDuty running on a system that you will integrate with Catalyst Center platform. See your PagerDuty documentation for instructions on setting up PagerDuty.

You must have the appropriate permissions to do the tasks as described in this procedure. For information about role-based access control (RBAC) for the Catalyst Center platform, see the Cisco Catalyst Center Platform User Guide.

Procedure

Step 1

From the main menu, choose Platform > Developer Toolkit > Event Notifications.

The Event Notifications window opens.

Step 2

Click the Notifications tab to view the notification tiles.

Each notification is represented by a tile and contains link to view notification details. From the CHANNELS area in the left pane, click the radio button next to the notification channels to view the existing tiles with the selected channel.

Step 3

Follow the steps in the Create a New Notification wizard to create a new notification.

Click Let's Do It to go directly to the workflow.

Step 4

In the Select Site and Events window, select a site from the drop-down list and select an event or events that support the required notification channel.

Step 5

Click Next.

The Select Channels window opens.

Step 6

In the Select Channels window, select PAGERDUTY as the notification channel.

Click Next to configure these values in the PAGERDUTY Settings window:

  • In the SERVICE CONFIGURATION area, click either Select Existing Instance to use the existing PagerDuty instance or Create New Instance to create a new PagerDuty instance.

  • From the Select Instance drop-down list, select a PagerDuty instance.

  • In the PagerDuty Events API URL field, enter a PagerDuty event API URL.

  • In the PagerDuty Integration Key field, enter a PagerDuty integration key.

  • In the PagerDuty Events API Version field, select an events API version from the drop-down list.

Step 7

Click Next.

The Name and Description window opens.

Step 8

Click Next.

The Summary window opens.

Step 9

In the Summary window, review the configuration settings.

To make any changes, click Edit.

Step 10

Click Finish.

The Done! Your new notification is complete window appears.

For more information, see Work with Event Notifications in the Cisco Catalyst Center Platform User Guide and Create an Event Notification in the Cisco Catalyst Center User Guide.

What to do next

Access PagerDuty to review the events.

The Catalyst Center events will appear in PagerDuty as alerts within the PagerDuty INCIDENTS window. You can review and mark the alert as Resolved in this window.