Aruba Central API CLI (cencli)
- CLI Reference
- cencli
- add
- archive
- assign
- batch
- blink
- bounce
- clone
- convert
- delete
- kick
- move
- nuke
- reboot
- refresh
- remove
- rename
- reset
- save
- show
- alerts
- all
- aps
- archived
- branch
- certs
- clients
- config
- devices
- dhcp
- events
- firmware
- gateways
- groups
- guests
- hook-proxy
- interfaces
- inventory
- labels
- last
- lldp
- logs
- notifications
- ospf
- overlay
- poe
- portals
- roaming
- routes
- run
- sites
- subscription
- swarms
- switches
- task
- templates
- token
- tshoot
- tunnels
- upgrade
- variables
- version
- vlans
- webhooks
- wids
- wlans
- start
- stop
- sync
- test
- tshoot
- unarchive
- unassign
- update
- upgrade
- cencli
- centralcli
- centralcli package
- centralcli.central module
CentralApi
CentralApi.DevType
CentralApi.add_devices()
CentralApi.add_template()
CentralApi.add_visitor()
CentralApi.add_webhook()
CentralApi.archive_devices()
CentralApi.assign_devices_to_group()
CentralApi.assign_label_to_devices()
CentralApi.assign_licenses()
CentralApi.central_acknowledge_notifications()
CentralApi.central_get_notification_config()
CentralApi.check_image_available()
CentralApi.clear_ts_session()
CentralApi.clone_group()
CentralApi.configuration_clean_up_and_update_wlan_v2()
CentralApi.configuration_update_wlan_v2()
CentralApi.cop_delete_device_from_inventory()
CentralApi.create_group()
CentralApi.create_label()
CentralApi.create_site()
CentralApi.create_wlan()
CentralApi.delete_ap()
CentralApi.delete_certificate()
CentralApi.delete_firmware_compliance()
CentralApi.delete_gateway()
CentralApi.delete_group()
CentralApi.delete_label()
CentralApi.delete_site()
CentralApi.delete_stack()
CentralApi.delete_switch()
CentralApi.delete_template()
CentralApi.delete_webhook()
CentralApi.delete_wlan()
CentralApi.disable_auto_subscribe()
CentralApi.do_multi_group_snapshot()
CentralApi.enable_auto_subscribe()
CentralApi.get_alerts()
CentralApi.get_all_clients()
CentralApi.get_all_devicesv2()
CentralApi.get_all_groups()
CentralApi.get_all_sites()
CentralApi.get_all_templates()
CentralApi.get_all_templates_in_group()
CentralApi.get_all_webhooks()
CentralApi.get_ap_config()
CentralApi.get_ap_lldp_neighbor()
CentralApi.get_ap_settings()
CentralApi.get_archived_devices()
CentralApi.get_audit_logs()
CentralApi.get_audit_logs_events()
CentralApi.get_auto_subscribe()
CentralApi.get_brach_health()
CentralApi.get_bssids()
CentralApi.get_certificates()
CentralApi.get_client_details()
CentralApi.get_client_roaming_history()
CentralApi.get_clients()
CentralApi.get_controller_vlans()
CentralApi.get_default_group()
CentralApi.get_denylist_clients()
CentralApi.get_dev_by_type()
CentralApi.get_dev_details()
CentralApi.get_device_configuration()
CentralApi.get_device_inventory()
CentralApi.get_device_ip_routes()
CentralApi.get_devices()
CentralApi.get_dhcp_clients()
CentralApi.get_dhcp_server()
CentralApi.get_dirty_diff()
CentralApi.get_events()
CentralApi.get_firmware_compliance()
CentralApi.get_fw_version_list()
CentralApi.get_gateway_ports()
CentralApi.get_gateway_vlans()
CentralApi.get_gateways_by_group()
CentralApi.get_group_for_dev_by_serial()
CentralApi.get_groups_properties()
CentralApi.get_gw_tunnels()
CentralApi.get_labels()
CentralApi.get_ospf_area()
CentralApi.get_ospf_database()
CentralApi.get_ospf_interface()
CentralApi.get_ospf_neighbor()
CentralApi.get_overlay_connection()
CentralApi.get_overlay_interfaces()
CentralApi.get_overlay_routes_advertised()
CentralApi.get_overlay_routes_learned()
CentralApi.get_per_ap_config()
CentralApi.get_portals()
CentralApi.get_sdwan_dps_policy_compliance()
CentralApi.get_site_details()
CentralApi.get_site_vlans()
CentralApi.get_sku_types()
CentralApi.get_snapshots_by_group()
CentralApi.get_subscription_stats()
CentralApi.get_subscriptions()
CentralApi.get_swarm_details()
CentralApi.get_swarms()
CentralApi.get_switch_poe_details()
CentralApi.get_switch_ports()
CentralApi.get_switch_stacks()
CentralApi.get_switch_vlans()
CentralApi.get_task_status()
CentralApi.get_template()
CentralApi.get_template_details_for_device()
CentralApi.get_topo_for_site()
CentralApi.get_ts_commands()
CentralApi.get_ts_output()
CentralApi.get_ts_session_id()
CentralApi.get_upgrade_status()
CentralApi.get_uplink_info_by_gw()
CentralApi.get_uplink_state_by_group()
CentralApi.get_uplink_tunnel_stats_by_gw()
CentralApi.get_valid_subscription_names()
CentralApi.get_variables()
CentralApi.get_variablised_template()
CentralApi.get_vc_firmware()
CentralApi.get_visitors()
CentralApi.get_vlan_info_by_gw()
CentralApi.get_wired_clients()
CentralApi.get_wireless_clients()
CentralApi.get_wlan()
CentralApi.get_wlans()
CentralApi.kick_users()
CentralApi.kms_get_ap_state()
CentralApi.kms_get_client_record()
CentralApi.kms_get_hash()
CentralApi.kms_get_health()
CentralApi.kms_get_synced_aps()
CentralApi.move_devices_to_group()
CentralApi.move_devices_to_site()
CentralApi.preprovision_device_to_group()
CentralApi.refresh_webhook_token()
CentralApi.remove_devices_from_site()
CentralApi.remove_label_from_devices()
CentralApi.replace_ap_config()
CentralApi.replace_per_ap_config()
CentralApi.reset_overlay_connection()
CentralApi.send_bounce_command_to_device()
CentralApi.send_command_to_device()
CentralApi.send_command_to_swarm()
CentralApi.send_speed_test()
CentralApi.start_ts_session()
CentralApi.strip_none()
CentralApi.test_webhook()
CentralApi.unarchive_devices()
CentralApi.unassign_licenses()
CentralApi.update_ap_settings()
CentralApi.update_ap_system_config()
CentralApi.update_cx_properties()
CentralApi.update_device_template_variables()
CentralApi.update_existing_template()
CentralApi.update_group_name()
CentralApi.update_group_properties()
CentralApi.update_site()
CentralApi.update_ssh_creds()
CentralApi.update_webhook()
CentralApi.upgrade_firmware()
CentralApi.upload_certificate()
CentralApi.verify_device_addition()
CentralApi.wids_get_all()
CentralApi.wids_get_interfering_aps()
CentralApi.wids_get_neighbor_aps()
CentralApi.wids_get_rogue_aps()
CentralApi.wids_get_suspect_aps()
WlanType
get_conn_from_file()
multipartify()
silence_event_loop_closed()
- centralcli.caas module
- centralcli.cache module
Cache
Cache.LicenseTypes
Cache.account_completion()
Cache.all
Cache.check_fresh()
Cache.client_completion()
Cache.clients
Cache.completion()
Cache.dev_ap_completion()
Cache.dev_ap_gw_completion()
Cache.dev_client_completion()
Cache.dev_completion()
Cache.dev_gw_completion()
Cache.dev_gw_switch_site_completion()
Cache.dev_kwarg_completion()
Cache.dev_site_completion()
Cache.dev_switch_ap_completion()
Cache.dev_switch_completion()
Cache.dev_switch_gw_completion()
Cache.dev_template_completion()
Cache.device_types
Cache.devices
Cache.devices_by_serial
Cache.event_completion()
Cache.event_ids
Cache.events
Cache.get_client_identifier()
Cache.get_dev_identifier()
Cache.get_devices_with_inventory()
Cache.get_event_identifier()
Cache.get_group_identifier()
Cache.get_hooks_by_serial()
Cache.get_identifier()
Cache.get_label_identifier()
Cache.get_log_identifier()
Cache.get_site_identifier()
Cache.get_template_identifier()
Cache.group_completion()
Cache.group_dev_ap_gw_completion()
Cache.group_dev_gw_completion()
Cache.group_names
Cache.groups
Cache.handle_multi_match()
Cache.hook_active
Cache.hook_config
Cache.hook_data
Cache.insert()
Cache.inventory
Cache.inventory_by_serial
Cache.label_completion()
Cache.label_names
Cache.labels
Cache.license_names
Cache.licenses
Cache.logs
Cache.method_test_completion()
Cache.null_completion()
Cache.remove_completion()
Cache.send_cmds_completion()
Cache.site_completion()
Cache.sites
Cache.smg_kw_completion()
Cache.template_completion()
Cache.templates
Cache.update_client_db()
Cache.update_dev_db()
Cache.update_event_db()
Cache.update_group_db()
Cache.update_hook_config_db()
Cache.update_hook_data_db()
Cache.update_inv_db()
Cache.update_label_db()
Cache.update_license_db()
Cache.update_log_db()
Cache.update_site_db()
Cache.update_template_db()
CacheResponses
CentralObject
get_cencli_devtype()
- centralcli.cleaner module
epoch_convert()
get_alerts()
get_all_groups()
get_all_webhooks()
get_audit_logs()
get_branch_health()
get_certificates()
get_client_roaming_history()
get_clients()
get_device_inventory()
get_devices()
get_dhcp()
get_event_logs()
get_fw_version_list()
get_labels()
get_lldp_neighbor()
get_ospf_interface()
get_ospf_neighbor()
get_overlay_interfaces()
get_overlay_routes()
get_portals()
get_subscriptions()
get_template_details_for_device()
get_vlans()
parse_caas_response()
pre_clean()
routes()
short_key()
short_value()
show_groups()
show_interfaces()
show_ts_commands()
simple_kv_formatter()
sites()
sort_result_keys()
strip_no_value()
strip_outer_keys()
wids()
- centralcli.config module
- centralcli.constants module
AlertSeverity
AlertTypes
AllDevTypes
ArgToWhat
BatchAddArgs
BatchApArgs
BatchDelArgs
BatchRenameArgs
BlinkArgs
BounceArgs
CacheArgs
CertFormat
CertTypes
ClientArgs
DeleteArgs
DevTypes
DhcpArgs
EnableDisableArgs
EventDevTypeArgs
GatewayRole
GenericDevTypes
IdenMetaVars
KickArgs
LibToAPI
LibToGenericPlural
LicenseTypes
LicenseTypes.advance_70xx
LicenseTypes.advance_72xx
LicenseTypes.advance_90xx_sec
LicenseTypes.advance_base_7005
LicenseTypes.advanced_ap
LicenseTypes.advanced_switch_6100
LicenseTypes.advanced_switch_6200
LicenseTypes.advanced_switch_6300
LicenseTypes.advanced_switch_6400
LicenseTypes.advanced_switch_8400
LicenseTypes.dm
LicenseTypes.foundation_70xx
LicenseTypes.foundation_72xx
LicenseTypes.foundation_90xx_sec
LicenseTypes.foundation_ap
LicenseTypes.foundation_base_7005
LicenseTypes.foundation_base_90xx_sec
LicenseTypes.foundation_switch_6100
LicenseTypes.foundation_switch_6200
LicenseTypes.foundation_switch_6300
LicenseTypes.foundation_switch_6400
LicenseTypes.foundation_switch_8400
LicenseTypes.foundation_wlan_gw
LicenseTypes.vgw2g
LicenseTypes.vgw4g
LicenseTypes.vgw500m
LogAppArgs
LogSortBy
NotifyToArgs
RefreshWhat
RemoveArgs
ResetArgs
SendCmdArg2
SendCmdArgs
SendConfigDevIdens
ShowArg2
ShowArgs
ShowArgs.all
ShowArgs.ap
ShowArgs.aps
ShowArgs.cache
ShowArgs.certs
ShowArgs.clients
ShowArgs.device
ShowArgs.devices
ShowArgs.gateway
ShowArgs.gateways
ShowArgs.group
ShowArgs.groups
ShowArgs.log
ShowArgs.logs
ShowArgs.site
ShowArgs.sites
ShowArgs.switch
ShowArgs.switches
ShowArgs.template
ShowArgs.templates
ShowArgs.variables
ShowHookProxyArgs
ShowInventoryArgs
SiteStates
SiteStates.AK
SiteStates.AL
SiteStates.AR
SiteStates.AS
SiteStates.AZ
SiteStates.Alabama
SiteStates.Alaska
SiteStates.American_Samoa
SiteStates.Arizona
SiteStates.Arkansas
SiteStates.CA
SiteStates.CO
SiteStates.CT
SiteStates.California
SiteStates.Colorado
SiteStates.Connecticut
SiteStates.DC
SiteStates.DE
SiteStates.Delaware
SiteStates.District_of_Columbia
SiteStates.FL
SiteStates.Florida
SiteStates.GA
SiteStates.GU
SiteStates.Georgia
SiteStates.Guam
SiteStates.HI
SiteStates.Hawaii
SiteStates.IA
SiteStates.ID
SiteStates.IL
SiteStates.IN
SiteStates.Idaho
SiteStates.Illinois
SiteStates.Indiana
SiteStates.Iowa
SiteStates.KS
SiteStates.KY
SiteStates.Kansas
SiteStates.Kentucky
SiteStates.LA
SiteStates.Louisiana
SiteStates.MA
SiteStates.MD
SiteStates.ME
SiteStates.MI
SiteStates.MN
SiteStates.MO
SiteStates.MP
SiteStates.MS
SiteStates.MT
SiteStates.Maine
SiteStates.Maryland
SiteStates.Massachusetts
SiteStates.Michigan
SiteStates.Minnesota
SiteStates.Mississippi
SiteStates.Missouri
SiteStates.Montana
SiteStates.NC
SiteStates.ND
SiteStates.NE
SiteStates.NH
SiteStates.NJ
SiteStates.NM
SiteStates.NV
SiteStates.NY
SiteStates.Nebraska
SiteStates.Nevada
SiteStates.New_Hampshire
SiteStates.New_Jersey
SiteStates.New_Mexico
SiteStates.New_York
SiteStates.North_Carolina
SiteStates.North_Dakota
SiteStates.Northern_Mariana_Islands
SiteStates.OH
SiteStates.OK
SiteStates.OR
SiteStates.Ohio
SiteStates.Oklahoma
SiteStates.Oregon
SiteStates.PA
SiteStates.PR
SiteStates.Pennsylvania
SiteStates.Puerto_Rico
SiteStates.RI
SiteStates.Rhode_Island
SiteStates.SC
SiteStates.SD
SiteStates.South_Carolina
SiteStates.South_Dakota
SiteStates.TN
SiteStates.TX
SiteStates.Tennessee
SiteStates.Texas
SiteStates.UM
SiteStates.US_Virgin_Islands
SiteStates.UT
SiteStates.United_States_Minor_Outlying_Islands
SiteStates.Utah
SiteStates.VA
SiteStates.VI
SiteStates.VT
SiteStates.Vermont
SiteStates.Virginia
SiteStates.WA
SiteStates.WI
SiteStates.WV
SiteStates.WY
SiteStates.Washington
SiteStates.West_Virginia
SiteStates.Wisconsin
SiteStates.Wyoming
SortAlertOptions
SortCertOptions
SortClientOptions
SortDevOptions
SortDevOptions.ap
SortDevOptions.ap_ip
SortDevOptions.ap_port
SortDevOptions.ap_serial
SortDevOptions.group
SortDevOptions.healthy
SortDevOptions.ip
SortDevOptions.labels
SortDevOptions.mac
SortDevOptions.model
SortDevOptions.name
SortDevOptions.serial
SortDevOptions.site
SortDevOptions.status
SortDevOptions.switch
SortDevOptions.switch_ip
SortDevOptions.switch_port
SortDevOptions.switch_serial
SortDevOptions.tagged_vlans
SortDevOptions.type
SortDevOptions.untagged_vlan
SortDevOptions.uptime
SortDevOptions.version
SortInventoryOptions
SortOptions
SortOspfAreaOptions
SortOspfDatabaseOptions
SortOspfInterfaceOptions
SortOspfInterfaceOptions.BDR_IP
SortOspfInterfaceOptions.BDR_rtr_id
SortOspfInterfaceOptions.DR_IP
SortOspfInterfaceOptions.DR_rtr_id
SortOspfInterfaceOptions.area
SortOspfInterfaceOptions.auth
SortOspfInterfaceOptions.cost
SortOspfInterfaceOptions.dead_interval
SortOspfInterfaceOptions.hello_interval
SortOspfInterfaceOptions.ip
SortOspfInterfaceOptions.name
SortOspfInterfaceOptions.nbrs
SortOspfInterfaceOptions.oper_state
SortOspfInterfaceOptions.priority
SortOspfInterfaceOptions.rexmt_interval
SortOspfInterfaceOptions.state
SortOspfInterfaceOptions.type
SortOspfNeighborOptions
SortOspfNeighborOptions.area
SortOspfNeighborOptions.dead_timer
SortOspfNeighborOptions.interface_name
SortOspfNeighborOptions.interface_state
SortOspfNeighborOptions.ip
SortOspfNeighborOptions.neighbor_state
SortOspfNeighborOptions.options
SortOspfNeighborOptions.priority
SortOspfNeighborOptions.rexmt_timer
SortOspfNeighborOptions.router_id
SortOverlayInterfaceOptions
SortRouteOptions
SortSiteOptions
SortSubscriptionOptions
SortTemplateOptions
SortTsCmdOptions
SortVlanOptions
SortWebHookOptions
SortWlanOptions
StartArgs
StatusOptions
SubscriptionArgs
TSDevTypes
TemplateLevel1
TunnelTimeRange
UpgradeArgs
WhatToPretty
do_load_pycentral()
get_cencli_devtype()
- centralcli.exceptions module
- centralcli.logger module
MyLogger
MyLogger.DEBUG
MyLogger.caption
MyLogger.critical()
MyLogger.debug()
MyLogger.debugv()
MyLogger.error()
MyLogger.exception()
MyLogger.fatal()
MyLogger.follow()
MyLogger.get_logger()
MyLogger.info()
MyLogger.level_name
MyLogger.log_print()
MyLogger.print_file()
MyLogger.setLevel()
MyLogger.show()
MyLogger.warning()
- centralcli.response module
BatchRequest
LoggedRequests
RateLimit
Response
Session
Session.MAX_TOKENS
Session.RATE
Session.aio_session
Session.api_call()
Session.batch_request()
Session.delete()
Session.exec_api_call()
Session.get()
Session.get_token_from_user()
Session.handle_pagination()
Session.patch()
Session.pause()
Session.post()
Session.put()
Session.refresh_token()
Session.request()
get_multiline_input()
- centralcli.utils module
Convert
Mac
Utils
Utils.Output
Utils.TTY
Utils.ask()
Utils.chunker()
Utils.color()
Utils.do_pretty()
Utils.generate_template()
Utils.get_multiline_input()
Utils.is_reachable()
Utils.isserial()
Utils.json_print()
Utils.listify()
Utils.output()
Utils.spinner()
Utils.strip_none()
Utils.tty
Utils.unique()
Utils.unlistify()
Utils.user_input_bool()
Utils.valid_file()
Utils.validate_config()
- centralcli.central module
- centralcli package