Module Documentation

ciscomeapi

The main Cisco Mobility Express API module

ciscomeapi.ciscomeapi.print_table(my_dict: dict, col_list: list = None)

Pretty print a list of dictionaries as a dynamically sized table.

Parameters:
  • my_dict (dict) – The dictionary or list of dictionaries to print
  • col_list (list) – The list of columns to include that correspond to keys in the dictionaryies
class ciscomeapi.ciscomeapi.CiscoME(host: str, username: str, password: str, ssl: bool = True, verify: bool = False)
__init__(host: str, username: str, password: str, ssl: bool = True, verify: bool = False)

Connect to the Mobility Express controller

Parameters:
  • host (str) – The hostname or IP address of the Mobility Express Controller
  • username (str) – Mobility Express administrator username
  • password (str) – Mobility Express administrator username
  • ssl (bool) – If True use https, otherwise http (default True)
  • verify (bool) – If True, verify the SSL certificate (default False)
Returns:

CiscoME object
aps(take: int = 1000) → dict

Returns the list of access points

Parameters:take (int) – The maximum number of items to return
Returns:The access point data
aps_data(take: int = 1000) → dict

Returns the detailed information about access points

Parameters:take (int) – The maximum number of items to return
Returns:The access point data

Blink the AP LED

Parameters:macAddress (str) – The MAC address of the AP of the form “aa:bb:cc:dd:ee:ff”
Returns:errorCode response
client_connection_score() → dict

Returns the table of client connection scores grouped by range

Returns:The connection score data
client_connection_speed() → dict

Returns the table of client connection speeds grouped by range

Returns:The connection speed data
client_table(take: int = 1000, columns: int = 524287) → dict

Returns the table of client data

Parameters:
  • take (int) – The maximum number of items to return
  • columns (int) – The binary value determines which columns are included in the output (19 bits). By default returns all columns.
Returns:

The client data
close()

Close the session to the Mobility Express controller

restart_ap(macAddress: str) → dict

Restart (reload) an AP

Parameters:macAddress (str) – The MAC address of the AP of the form “aa:bb:cc:dd:ee:ff”
Returns:errorCode response
system_information() → dict

Returns system information about the controller (e.g. platform, version, etc.)

Returns:The system information
toggle_ap_led(macAddress: str) → dict

Disable or enable the AP LED

Parameters:macAddress (str) – The MAC address of the AP of the form “aa:bb:cc:dd:ee:ff”
Returns:errorCode response