Apstra AOS 2.1 IBA Probe Library
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
aospy
docs
templates
.gitignore
README.md
setup.py

README.md

IBA Probes

The devices managed by Apstra AOS generate large amounts of data over time. On its own, this data is voluminous and unhelpful. Through Intent-Based Analytics (IBA), AOS allows the operator to combine intent from the AOS graph database with current and historic data from devices to reason about the network at-large.

For a detailed explaination of AOS IBA, please watch our recent webinar "Intent-Based Analytics: Prevent Network Outages and Gray Failures"!

Probes are the basic unit of abstraction in IBA. Operators can configure, create, and delete probes. Generally, a given probe consumes some set of data from the network, does various successive aggregations and calculations on it, and optionally specifies some conditions of said aggregations and calculations on which anomalies are raised.

IBA workflow

Below is a collection of commonly used probes that can be used out of the box with AOS. They also serve as examples to help build custom probes yourself.

Getting Started

You can find the setup instructions and try these out in your environment here.

To access each tutorial directly, click on the links below:

East West Traffic

Generates Probe to Calculate Total East/West Traffic     

ECMP Imbalance

Generates Probe to Calculate ECMP Imbalance on fabric ports   

External ECMP Imbalance

Generates Probe to Calculate ECMP Imbalance on external facing fabric ports 

Headroom

Generates Probe to Calculate Headroom

Hot Cold Interface

Generates Probe to Determine Hot/Cold Fabric Interface Counters

Interface Flapping

Generates Probe to Determine if Interfaces are Flapping

MLAG Imbalance

Generates Probe to Calculate MLAG Imbalance

Specific Hot Cold Interface

Generates Probe to Determine Hot/Cold for Specific Interface Counters

Specific Interface Flapping

Generates Probe to Determine if Interfaces are Flapping

Using AOS Web UI to create the probes

Follow the steps below to create the probes under aospy folder using AOS Web UI

  1. In a terminal window, go to the directory where you cloned this repository
  2. Type python to enter the python interactive shell
  3. Within the python shell, do the following
  >>> from aospy.ibaprobelib.mlag_imbalance import mlag_imbalance_probe
  >>> import json; print json.dumps(mlag_imbalance_probe('mlag imbalance', 120, 10000))
  1. Go to AOS Web UI > Blueprints > Blueprint > Analytics > Create Probe > Import Probe
  2. Paste the JSON output and create the probe

More probes

You can find many more probes in the templates subfolder. Refer to its readme for more info on how to use these