Overview
NetApp OnCommand Insight (OCI) is NetApp's on-premises storage resource manager. NetApp has moved it to end of availability; its successor, Data Infrastructure Insights, sends alerts to SQIBS directly with a webhook. If you still run OCI, this page shows how to send its violations to SQIBS with a small script.
How it works
open opens it, closed closes it.Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.
If you can, move to Data Infrastructure Insights and use NetApp Data Infrastructure Insights with SQIBS, which needs no script.
Step 1: Add the API filter in SQIBS
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in NetApp OnCommand Insight template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Resolve | "state" |
closed |
Resolves the open incident. |
| Trigger | "state" |
open |
Opens an incident. |
| Match | "violationId" |
Ties the closed message to the incident it opened. | |
| Title from | "title" |
Becomes the incident title. | |
| Description from | "description" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
In the API Integration window, click the round
{} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.Step 2: Post violations to SQIBS
OCI notifies about violations by email, SNMP trap and syslog. Have the tool that receives them (your trap or syslog handler) call this script for each new and each closed violation. jq builds the JSON, so quotes in a description cannot break it.
#!/bin/bash
# Called by your OnCommand Insight violation handling with: <state> <violation-id> <title> <description>
curl -s -X POST 'https://<your-endpoint>/sqibs-api/v1/process?from=netapp-oci' \
-H 'Authorization: Bearer <your-token>' -H 'Content-Type: application/json' \
--data "$(jq -n --arg s "$1" --arg id "$2" --arg t "$3" --arg d "$4" \
'{state: $s, violationId: $id, title: $t, description: $d}')"
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Test it
The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.
- Run the script by hand:
./oci-to-sqibs.sh open 42 "Volume latency" "Latency above 20 ms on vol01". - In SQIBS, a new incident opens, titled
Volume latency. - Run it again with
closed 42and SQIBS resolves the incident.
No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in the script.
Fix known issues automatically
Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when OCI reports a capacity violation on an aggregate, SQIBS can run a workflow that removes expired snapshots and reports the free space.
Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.
To set it up, in the same API filter:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.
Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.
Learn more:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.