Welcome to airwaveapiclient’s documentation!

https://secure.travis-ci.org/mtoshi/airwaveapiclient.svg?branch=master https://coveralls.io/repos/mtoshi/airwaveapiclient/badge.svg?branch=master&service=github Latest Version Documentation Status

Contents:

Introduction

Airwaveapiclient is a utility tool for Aruba Networks AirWave users. This module connects to AirWave and gets the information such as the access point list, detail, client, etc.

Supported features

Currently airwaveapiclient can:

  • Get access point list (XML).
  • Get access point detail (XML).
  • Get client detail (XML).
  • Get rogue detail (XML).
  • Get latest report (XML).
  • Make access point graph url.

Requirements

Python

  • Python2.7
  • Python3.3
  • Python3.4

AirWave

Checked below versions.

  • AirWave 7.5
  • AirWave 8.0

Installation

PyPI

1
pip install airwaveapiclient

Github

1
2
3
git clone https://github.com/mtoshi/airwaveapiclient
cd airwaveapiclient
sudo python setup.py install

User Guide

AirWaveAPIClient

init

login

logout

ap_list

ap_detail

client_detail

rogue_detail

latest_report

APList

init

APDetail

init

APGraph

class ap_graph.APGraph(url, obj)[source]

Aruba networks AirWave Graph.

Attributes:

url (str):AirWave URL.
path (str):Graph path.
default_start_time(int):
 Graph start default time.
default_end_time(int):
 Graph end default time.

init

APGraph.__init__(url, obj)[source]

Initialize AirWaveAPIClient.

Args:

url (str):AirWave URL.
obj (collections.OrderedDict):
 APList element.

Usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
>>> from airwaveapiclient import AirWaveAPIClient
>>> from airwaveapiclient import APGraph
>>> from airwaveapiclient import APList
>>>
>>> url = 'http://192.168.1.1/'
>>>
>>> airwave = AirWaveAPIClient(username='admin',
>>>                            password='xxxxx',
>>>                            url=url)
>>>
>>> airwave.login()
>>> ap_list = airwave.ap_list()
>>>
>>> objs = APList(ap_list)
>>> for obj in objs:
...     ap_graph = APGraph(url, obj)
...     ap_graph.client_count_802dot11an()
...
'http://x.x.x.x/nf/rrd_graph?
    end=0s&id=1&radio_index=2&start=-7200s&type=ap_client_count'
'http://x.x.x.x/nf/rrd_graph?
    end=0s&id=2&radio_index=2&start=-7200s&type=ap_client_count'
'http://x.x.x.x/nf/rrd_graph?
    end=0s&id=3&radio_index=2&start=-7200s&type=ap_client_count'
>>> airwave.logout()

client_count_802dot11bgn

APGraph.client_count_802dot11bgn(start=None, end=None)[source]

RRD graph URL for access point client count of radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.client_count_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=1&start=-3600s&type=ap_client_count'

client_count_802dot11an

APGraph.client_count_802dot11an(start=None, end=None)[source]

RRD graph URL for access point client count of radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.client_count_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=2&start=-3600s&type=ap_client_count'

client_count_802dot11ac

APGraph.client_count_802dot11ac(start=None, end=None)[source]

RRD graph URL for access point client count of radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.client_count_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=2&start=-3600s&type=ap_client_count'

bandwidth_802dot11bgn

APGraph.bandwidth_802dot11bgn(start=None, end=None)[source]

RRD graph URL for access point bandwidth of radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.bandwidth_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=1&start=-3600s&type=ap_bandwidth'

bandwidth_802dot11an

APGraph.bandwidth_802dot11an(start=None, end=None)[source]

RRD graph URL for access point bandwidth of radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.bandwidth_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=2&start=-3600s&type=ap_bandwidth'

bandwidth_802dot11ac

APGraph.bandwidth_802dot11ac(start=None, end=None)[source]

RRD graph URL for access point bandwidth of radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.bandwidth_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=3&radio_index=2&start=-3600s&type=ap_bandwidth'

dot11_counters_802dot11bgn

APGraph.dot11_counters_802dot11bgn(start=None, end=None)[source]

RRD graph URL for access point dot11 counters of radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.dot11_counters_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=1&start=-3600s&type=dot11_counters'

dot11_counters_802dot11an

APGraph.dot11_counters_802dot11an(start=None, end=None)[source]

RRD graph URL for access point dot11 counters of radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.dot11_counters_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=1&radio_index=2&start=-3600s&type=dot11_counters'

dot11_counters_802dot11ac

APGraph.dot11_counters_802dot11ac(start=None, end=None)[source]

RRD graph URL for access point dot11 counters of radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
>>> ap_graph.dot11_counters_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    end=-0s&id=3&radio_index=2&start=-3600s&type=dot11_counters'

radio_channel_802dot11bgn

APGraph.radio_channel_802dot11bgn(start=None, end=None)[source]

RRD graph URL for radio channel for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_channel_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=radio_channel'

radio_channel_802dot11an

APGraph.radio_channel_802dot11an(start=None, end=None)[source]

RRD graph URL for radio channel for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_channel_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=1&start=-3600s&type=radio_channel'

radio_channel_802dot11ac

APGraph.radio_channel_802dot11ac(start=None, end=None)[source]

RRD graph URL for radio channel for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_channel_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=1&start=-3600s&type=radio_channel'

radio_noise_802dot11bgn

APGraph.radio_noise_802dot11bgn(start=None, end=None)[source]

RRD graph URL for radio noise for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_noise_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=radio_noise'

radio_noise_802dot11an

APGraph.radio_noise_802dot11an(start=None, end=None)[source]

RRD graph URL for radio noise for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_noise_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=1&start=-3600s&type=radio_noise'

radio_noise_802dot11ac

APGraph.radio_noise_802dot11ac(start=None, end=None)[source]

RRD graph URL for radio noise for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_noise_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=1&start=-3600s&type=radio_noise'

radio_power_802dot11bgn

APGraph.radio_power_802dot11bgn(start=None, end=None)[source]

RRD graph URL for radio power for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_power_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=radio_power'

radio_power_802dot11an

APGraph.radio_power_802dot11an(start=None, end=None)[source]

RRD graph URL for radio power for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_power_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_power'

radio_power_802dot11ac

APGraph.radio_power_802dot11ac(start=None, end=None)[source]

RRD graph URL for radio power for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_power_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_power'

radio_errors_802dot11bgn

APGraph.radio_errors_802dot11bgn(start=None, end=None)[source]

RRD graph URL for radio errors for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_errors_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=radio_errors'

radio_errors_802dot11an

APGraph.radio_errors_802dot11an(start=None, end=None)[source]

RRD graph URL for radio errors for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_errors_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_errors'

radio_errors_802dot11ac

APGraph.radio_errors_802dot11ac(start=None, end=None)[source]

RRD graph URL for radio errors for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_errors_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_errors'

radio_goodput_802dot11bgn

APGraph.radio_goodput_802dot11bgn(start=None, end=None)[source]

RRD graph URL for radio goodput for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_goodput_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=radio_goodput'

radio_goodput_802dot11an

APGraph.radio_goodput_802dot11an(start=None, end=None)[source]

RRD graph URL for radio goodput for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_goodput_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_goodput'

radio_goodput_802dot11ac

APGraph.radio_goodput_802dot11ac(start=None, end=None)[source]

RRD graph URL for radio goodput for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.radio_goodput_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=radio_goodput'

channel_utilization_802dot11bgn

APGraph.channel_utilization_802dot11bgn(start=None, end=None)[source]

RRD graph URL for channel utilization for radio type IEEE802.11BGN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.channel_utilization_802dot11bgn(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=1&radio_interface=2&start=-3600s&type=channel_utilization'

channel_utilization_802dot11an

APGraph.channel_utilization_802dot11an(start=None, end=None)[source]

RRD graph URL for channel utilization for radio type IEEE802.11AN.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.channel_utilization_802dot11an(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=channel_utilization'

channel_utilization_802dot11ac

APGraph.channel_utilization_802dot11ac(start=None, end=None)[source]

RRD graph URL for channel utilization for radio type IEEE802.11AC.

Args:

start (int, optional):
 Graph start time(seconds ago). Default is -7200.
end (int, optional):
 Graph end time(seconds ago). Default is None.

Returns:

str:Graph URL string.

Usage:

1
2
3
4
>>> ap_graph.channel_utilization_802dot11ac(start=-3600)
'https://x.x.x.x/nf/rrd_graph?
    ap_uid=00%3A00%3A10%3A00%3A00%3A03&
    end=-0s&radio_index=2&radio_interface=2&start=-3600s&type=channel_utilization'

Report

init

Sample code

History

0.1.7 (2015-09-14)

  • Changed some structures for stable into the APGraph methods.
  • Changed documentation.

0.1.6 (2015-09-09)

  • Added care of non existent graph url.
  • Changed documentation.

0.1.5 (2015-09-07)

  • Changed documentation.

0.1.4 (2015-09-07)

  • Added latest report API.
  • Changed documentation.

0.1.3 (2015-08-17)

  • Added 802.11ac graph url.
  • Changed documentation.

0.1.2 (2015-08-03)

  • Changed documentation.

0.1.1 (2015-08-02)

  • Changed documentation.

0.1.0 (2015-08-01)

  • First release

Indices and tables