pycentral’s Module Documentation

Introduction

• About pycentral package
• Installation Instructions
• Getting Started
  • Package Structure

Module Documentation

• pycentral
  • Indices and tables
  • pycentral package
    • pycentral.audit_logs module
      • Audit
        • Audit.get_eventlogs()
        • Audit.get_eventlogs_detail()
        • Audit.get_traillogs()
        • Audit.get_traillogs_detail()
    • pycentral.base module
      • ArubaCentralBase
        • ArubaCentralBase.command()
        • ArubaCentralBase.createToken()
        • ArubaCentralBase.getToken()
        • ArubaCentralBase.handleTokenExpiry()
        • ArubaCentralBase.loadToken()
        • ArubaCentralBase.oauthAccessToken()
        • ArubaCentralBase.oauthCode()
        • ArubaCentralBase.oauthLogin()
        • ArubaCentralBase.refreshToken()
        • ArubaCentralBase.requestUrl()
        • ArubaCentralBase.storeToken()
        • ArubaCentralBase.validateOauthParams()
        • ArubaCentralBase.validateRefreshTokenParams()
      • BearerAuth
    • pycentral.base_utils module
      • clusterBaseURL
        • clusterBaseURL.getAllBaseURLs()
        • clusterBaseURL.getBaseURL()
      • console_logger()
      • get_url()
      • parseInputArgs()
      • tokenLocalStoreUtil()
      • valid_url()
    • pycentral.configuration module
      • ApConfiguration
        • ApConfiguration.change_wlan_status()
        • ApConfiguration.get_ap_config()
        • ApConfiguration.replace_ap()
      • ApSettings
        • ApSettings.get_ap_settings()
        • ApSettings.update_ap_settings()
      • Devices
        • Devices.get_device_templates_from_hash()
        • Devices.get_devices_config_details()
        • Devices.get_devices_configuration()
        • Devices.get_devices_group()
        • Devices.get_devices_group_templates()
        • Devices.get_devices_templates()
        • Devices.get_switch_variablized_templates()
        • Devices.move_devices()
        • Devices.set_switch_ssh_credentials()
      • Groups
        • Groups.clone_create_group()
        • Groups.create_group()
        • Groups.delete_group()
        • Groups.get_config_mode_groups()
        • Groups.get_groups()
      • Templates
        • Templates.create_template()
        • Templates.delete_template()
        • Templates.get_template()
        • Templates.get_template_text()
        • Templates.update_template()
      • Variables
        • Variables.create_template_variables()
        • Variables.create_template_variables_file()
        • Variables.delete_template_variables()
        • Variables.get_all_template_variables()
        • Variables.get_template_variables()
        • Variables.replace_template_variables()
        • Variables.replace_template_variables_file()
        • Variables.update_template_variables()
        • Variables.update_template_variables_file()
      • Wlan
        • Wlan.create_full_wlan()
        • Wlan.create_wlan()
        • Wlan.delete_wlan()
        • Wlan.disable_wlan()
        • Wlan.enable_wlan()
        • Wlan.get_all_wlans()
        • Wlan.get_wlan()
        • Wlan.update_full_wlan()
        • Wlan.update_wlan()
    • pycentral.device_inventory module
      • Inventory
        • Inventory.add_devices()
        • Inventory.archive_devices()
        • Inventory.get_inventory()
        • Inventory.unarchive_devices()
    • pycentral.firmware_management module
      • Firmware
        • Firmware.cancel_scheduled_upgrade()
        • Firmware.check_firmware_status()
        • Firmware.check_firmware_support()
        • Firmware.get_firmware_swarm()
        • Firmware.list_firmware_all_swarms()
        • Firmware.list_supported_version()
        • Firmware.upgrade_firmware()
    • pycentral.licensing module
      • AutoLicense
        • AutoLicense.assign_autolicense_services()
        • AutoLicense.assign_msp_autolicense_services()
        • AutoLicense.disable_autolicensing_services()
        • AutoLicense.disable_msp_autolicense_services()
        • AutoLicense.get_autolicense_services()
        • AutoLicense.get_license_status()
        • AutoLicense.get_msp_autolicense_services()
      • Subscriptions
        • Subscriptions.assign_device_subscription()
        • Subscriptions.assign_msp_subscription_all()
        • Subscriptions.assign_subscription_all()
        • Subscriptions.get_enabled_services()
        • Subscriptions.get_services_license_config()
        • Subscriptions.get_user_subscription_keys()
        • Subscriptions.get_user_subscription_status()
        • Subscriptions.unassign_device_subscription()
        • Subscriptions.unassign_msp_subscription_all()
        • Subscriptions.unassign_subscription_all()
    • pycentral.monitoring module
      • Sites
        • Sites.associate_devices()
        • Sites.create_site()
        • Sites.delete_site()
        • Sites.find_site_id()
        • Sites.get_sites()
        • Sites.unassociate_devices()
        • Sites.update_site()
    • pycentral.msp module
      • MSP
        • MSP.assign_devices_to_customers()
        • MSP.create_customer()
        • MSP.delete_customer()
        • MSP.edit_msp_resources()
        • MSP.get_all_customers()
        • MSP.get_country_code()
        • MSP.get_country_codes_list()
        • MSP.get_customer_details()
        • MSP.get_customer_devices_and_subscriptions()
        • MSP.get_customer_id()
        • MSP.get_customer_users()
        • MSP.get_customers()
        • MSP.get_customers_per_group()
        • MSP.get_msp_all_devices_and_subscriptions()
        • MSP.get_msp_devices_and_subscriptions()
        • MSP.get_msp_id()
        • MSP.get_msp_resources()
        • MSP.get_msp_users()
        • MSP.unassign_all_customer_device()
        • MSP.unassign_devices_from_customers()
        • MSP.update_customer()
    • pycentral.rapids module
      • Rogues
        • Rogues.list_interfering_aps()
        • Rogues.list_neighbor_aps()
        • Rogues.list_rogue_aps()
        • Rogues.list_suspect_aps()
      • WIDS
        • WIDS.list_client_attacks()
        • WIDS.list_infrastructure_attacks()
        • WIDS.list_wids_attacks()
    • pycentral.refresh_api_token module
      • RefreshApiToken
        • RefreshApiToken.refresh_token()
    • pycentral.topology module
      • Topology
        • Topology.ap_lldp_neighbors()
        • Topology.get_device_details()
        • Topology.get_edge_details()
        • Topology.get_topology()
        • Topology.get_uplink_details()
        • Topology.tunnel_details()
    • pycentral.user_management module
      • Roles
        • Roles.create_user_role()
        • Roles.delete_user_role()
        • Roles.get_user_role()
        • Roles.get_user_roles()
        • Roles.update_user_role()
      • Users
        • Users.create_user()
        • Users.delete_user()
        • Users.get_user()
        • Users.get_users()
        • Users.list_users()
        • Users.update_user()
    • pycentral.visualrf module
      • ClientLocation
        • ClientLocation.get_client_location()
        • ClientLocation.get_floor_clients()
      • FloorPlan
        • FloorPlan.get_ap_location()
        • FloorPlan.get_building_floors()
        • FloorPlan.get_campus_buildings()
        • FloorPlan.get_campus_list()
        • FloorPlan.get_floor_aps()
        • FloorPlan.get_floor_image()
        • FloorPlan.get_floor_info()
      • RougueLocation
        • RougueLocation.get_floor_rogueaps()
        • RougueLocation.get_rogueap_location()
    • Subpackages
      • pycentral.workflows package
        • pycentral.workflows.workflows_utils module
          • dict_list_to_csv()
          • get_conn_from_file()
          • get_file_contents()
        • Module contents

License

• LICENSE

Indices and tables

• Index

• Module Index

• Search Page