HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In

Featured Usecases and Workflows

Commonly used use-cases and workfows

This page consists of the commonly used use-cases and workflows involving API and automation on AOS8 based Mobility Conductors, Mobility Controllers and Access Points.

Use-case Categorization

An API interface can be used for multiple workflows to perform network automation. Utilizing the plethora of endpoints available on the Mobility Conductor, it is simple to construct a variety of automation workflows. We have identified some automation workflows, that enables multiple use-cases as mentioned below:

Day 1 Automation

Suppose, a customer has a new wireless site coming up. What are the typical tasks one follows on Day 1 of installation:

  • Create node-hierarchy
  • Add MDs to these node hierarchy
  • Allowlist APs
  • Create AP groups and add APs to them
  • Create SSIDs.

This is just a typical list of sample tasks. There can be more tasks depending on different cases. All of these tasks can be automated using APIs.

Some of these examples can be found under Day 1 Tasks under Use Cases section and also Examples under Ansible section

Run-Time Automation

Run time automation can be used to achieve tasks that needs to be done after initial installation is complete. Some sample tasks can be like:

  • Adding a new VLAN on the MCR/MD/Standalone.
  • Creating a new AP group
  • Adding a new Radius server
  • Adding a new SSID

Some of these examples can be found under Run-Time Tasks under Use Cases section and also Examples under Ansible section

Monitoring Automation

Monitoring automation can be achieved in two ways:

  • Use 'showcommand' API
  • Use various GET APIs to fetch information.

Scripts can be written to continuously monitor the system or even monitor it on demand. Custom dashboards can be created with the data received from these APIs.

Some of these examples can be found under Monitoring Tasks under Use Cases section and also Examples under Ansible section

Use case DescriptionTool
Day 0/1 AutomationAnsible
Runtime AutomationAnsible
Monitoring AutomationAnsible
Using SSH Interface for configurationAnsible