AirWave API Client

raw JSON →

0.1.11 verified Fri May 01 auth: no python

Python client for Aruba Networks AirWave API. Current version 0.1.11, release cadence: sporadic.

pip install airwaveapiclient

Common errors

error ImportError: cannot import name 'AirWaveAPIClient' from 'airwaveapiclient' ↓

cause Incorrect import path or missing installation.

fix

Run pip install airwaveapiclient and use from airwaveapiclient import AirWaveAPIClient.

error AttributeError: 'AirWaveAPIClient' object has no attribute 'get_ap_parameters' ↓

cause The method was renamed in a recent version.

fix

Use get_access_points() instead of get_ap_parameters().

Warnings

gotcha The library does not support Python 3.12+ due to outdated dependencies (e.g., requests < 2.28). ↓

fix Use Python 3.11 or lower, or pin requests to a compatible version.

deprecated The method `get_ap_parameters()` is deprecated in favor of `get_access_points()`. ↓

fix Use `get_access_points()` instead.

Imports

AirWaveAPIClient

wrong

from airwaveapiclient.client import AirWaveAPIClient

correct

from airwaveapiclient import AirWaveAPIClient

Incorrect path, the top-level import is correct.

AirWaveAPIError

from airwaveapiclient import AirWaveAPIError

Quickstart

Initialize the client with environment variables for host, username, and password.

from airwaveapiclient import AirWaveAPIClient
import os

client = AirWaveAPIClient(
    host=os.environ.get('AIRWAVE_HOST', ''),
    username=os.environ.get('AIRWAVE_USERNAME', ''),
    password=os.environ.get('AIRWAVE_PASSWORD', '')
)
print(client.get_ap_parameters())