CA Spectrum

CA Spectrum Infrastructure Manager is a network infrastructure management software by CA, Inc. Spectrum enables the modeling of LAN, WAN, wired, wireless, physical, and virtual networks. Build this integration to correlate alerts from CA Spectrum into high-level incidents in BigPanda.

Supported Versions:
CA Spectrum Version 9.4.x

Type:
Custom Spectrum Scripts, Python (Version 2.6.x - 2.7.x)

Using Sample Code

These samples are meant to provide a helpful starting point for your custom integration. Though you may be able to copy some of the samples and use them without modifications, your system administrators must review and test all scripts and methods before using them, as per good practices.

How It Works

CA Spectrum delivers advanced scalability and features that enable your organization
to effectively monitor and manage its dynamic, complex IT infrastructure—including physical, virtual and cloud environments as well as software defined networks (SDN). CA Spectrum is a single platform that features proactive network change management, fault isolation and root cause analysis. With CA Spectrum, you can track, manage and optimize not only the network infrastructure but the business services running on top of it.

Prerequisites

  • CA Spectrum

  • CA Spectrum Alarm Notification Manager (SANM)

  • CA Spectrum AlarmNotifier & AlarmNotifier Enhancements

  • BigPanda Account

  • CA Spectrum Admin User With Read/Write Access

Step 1: In BigPanda, create an App Key.

  1. In BigPanda, click the Integrations tab at the top of the screen.

  2. In the left pane, click New Integration.

  3. On the Monitoring tab, click Alerts REST API.

  4. In Step 1, enter the name of the integration. For example, enter SpectrumSANM.

  5. Click Generate App Key.

Step 2. Download one of the BigPanda-provided wrappers or use a custom wrapper.

On your CA Spectrum server, install the BigPanda Alerts API Python module.

The easiest way is to use pip by running the following command:

  • sudo pip install bigpanda

For more detailed information, refer to the module documentation by running: (help(bigpanda))

Step 3. Write a custom script to send alerts to BigPanda via the Alerts API.

  1. On your CA Spectrum server, locate the directory path to your AlarmNotifier.
    This directory is typically located at: <$SPECROOT>/Notifier.
    Your executable scripts are also located in this directory by default.

  2. Create the following custom Python script in the directory.

import bigpanda
import sys

status = sys.argv[1]
host = sys.argv[2]
check_name = sys.argv[3]

bigpanda_client = bigpanda.Client(api_token="<your token key>", app_key="<your app key>")
alert = bigpanda_client.alert(status, hostname, check_name)
alert.send()
  1. In BigPanda, go to the Alerts API Integration page where you created the app key for this integration

  2. Copy the api_token and app_key values, and paste them into your script.

  3. Save the Python script file as BigPanda_API.py.

  4. Set executable rights access to the Python script for your CA Spectrum Admin user.

Step 4: Configure your monitoring system to call your custom script.

  1. Create an AlarmNotifier. See chapter 5 of your CA Spectrum & Alarm Notification User Manual.

  2. Edit the SetScript, UpdateScript, and ClearScript that are executed by the AlarmNotifier.
    For this example, we describe how to edit the SetScript. Apply the same customizations to each script that can be executed by your AlarmNotifier.

  3. Add code to your SetScript that executes your custom Python script.
    The following example shows how AlarmNotifier attributes in the SetScript are passed to the Python Alert API script.

echo "*******************************************************************"
 echo "Sending Alert to BigPanda:”
 echo ""
 echo "($RCVRS)"
 echo "*******************************************************************"
 echo_info | tee -i /tmp/set_alarm.$PID
  python BigPanda_API.py $SEV $SERVER $EVENTMSG

alarm_id=$AID status=$TIVSTAT Spectrum_Base SPECTRUM
 rm -f /tmp/set_alarm.$PID
else
 echo " "
 echo "*****************************************************"
 echo “There was an error“
 echo "*****************************************************"
 echo_info

This relatively simple example demonstrates specific details about how to integrate with the BigPanda Alerts API. For more details about how the API works, see Alert Correlation Logic.

Step 5: Test the integration by sending a test alert.

  1. Restart the AlarmNotifier application service.

  2. Test the custom SetScript & Python Alert API script by generating an alert on a system that is monitored by Spectrum.

CA Spectrum


CA Spectrum Infrastructure Manager is a network infrastructure management software by CA, Inc. Spectrum enables the modeling of LAN, WAN, wired, wireless, physical, and virtual networks. Build this integration to correlate alerts from CA Spectrum into high-level incidents in BigPanda.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.