This is the latest documentation for BMC Helix Network Management (formerly known as Netreo).

 

Pager Duty Integration


Integrating the PagerDuty alerting service into your BMC Helix Network Management monitoring workflow is fairly straightforward. Simply follow the steps below to create a new action group that will alert your PagerDuty account with a custom message of your choice that can then be assigned to the alarm configuration of any monitoring check.

First, you'll have to complete some steps in PagerDuty.

  1. Log in to your account at the PagerDuty website.
  2. Create a "Generic API Integration."
    • Instructions on how to do this are available here.
  3. Record the API Integration Key for use in BMC Helix Network Management.

Now you can configure BMC Helix Network Management. Navigate to the Actions Administration page (Administration > Alerts > Actions).

Create a new action group.
Click the Add A Group button at the top of the page. Or, if there is an existing group to which you would like to add a new action, click the add action button in that group's header and skip to the next section.

  1. In the Add Group dialog:
    1. In the "GROUP NAME" field, enter a name for this action group (for example, "PagerDutyAlert").
      • No spaces are allowed in action group names.
    2. In the "MANUAL ALERT ACCESS LEVEL" field, select a user access level for this group.
      • This setting allows users of the selected access level and higher to manually run this action group from within an incident.
    3. Click Add Groupto add this action group to BMC Helix Network Management.
      • Action groups are selected when configuring alarms for monitoring checks.

Create a new action to add to your action group.
If you just created a new action group, the wizard will automatically direct you to the Add Action dialog. Otherwise, click the add action button in an existing action group's header to open the Add Action dialog.

  1. In the Add Action dialog:
    1. In the "ACTION NAME" field, enter a name for this action (for example, "PagerDuty Action").
      • Spaces are allowed in action names.
    2. Click Add Action to add this action to your action group.

Create a new method to add to your action.
If you just created a new action, the wizard will automatically direct you to the Add Method dialog. Otherwise, click the add method button in an existing action's header to open the Add Method dialog.

  1. In the Add Method dialog:
    1. In the "ACTION METHOD TYPE" field, select "Webhook" from the drop-down. (See Action Group for more information on webhooks.)
    2. In the "URL" field, enter: events.pagerduty.com/generic/2010-04-15/create_event.json
    3. In the "PAYLOAD" field, enter:
      [header]
       

{

"Content-Type"  : "application/json"
    1. }
      [header]
       

{

"service_key": "<YOUR API INTEGRATION KEY>",
"event_type": "trigger",
"description": "{EXAMPLE_MACRO1 EXAMPLE_MACRO2}",
"incident_key": "{INCIDENTID}",
"client": "BMC Helix Network Management"
    1. }
      • Be sure to set the "service_key" field to the correct value for your PagerDuty account.
      • Text contained in angle brackets < > should be replaced with your appropriate values.
      • Text contained in curly braces (EXAMPLE_MACRO1 and EXAMPLE_MACRO2 in the example above) represents a series of BMC Helix Network Management macros, and will be translated into readable text before the payload is sent. Replace the example macros above with the macros you would like to use. Multiple macros may be included in the same field by separating them with a blank space. See the list of available macros in the Alert Template Administration page entry.
      • Do not include any angle brackets < > in your payload, but do include curly braces { }.
    2. Click Add Method to add this method to your action.

Add Method Webhook PagerDuty.pngThe Add Method dialog showing the appropriate details for creating a PagerDuty webhook alert. 

Select this action group in the alarm configuration of a monitoring check. When that check opens an incident, PagerDuty will be alerted according to the BMC Helix Network Management incident state change rules.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Network Management