CLI Reference

cencli

Aruba Central API CLI

cencli [OPTIONS] COMMAND [ARGS]...

Options

-V, -v, --version

Show current cencli version, and latest available version.

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

--install-completion: Install completion for the current shell.

--show-completion: Show completion for the current shell, to copy it or customize the installation.

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

add

Add devices / objects.

cencli add [OPTIONS] COMMAND [ARGS]...

certificate

Upload a Certificate to Aruba Central

cencli add certificate [OPTIONS] CERT_NAME [CERT_FILE]

Options

--passphrase <passphrase>: optional passphrase

-pem: upload certificate in PEM format

-der: upload certificate in DER format

-pkcs12: upload certificate in pkcs12 format

-svr: Type: Server Certificate

-ca: Type: CA

-crl: Type: CRL

-int-ca: Type: Intermediate CA

-ocsp-resp: Type: OCSP responder

-ocsp-signer: Type: OCSP signer

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

CERT_NAME: Required argument

CERT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

device

Add a Device to Aruba Central.

cencli add device [OPTIONS] serial [SERIAL NUM] mac [MAC ADDRESS] group
                  [GROUP]

Options

--license <license>

Assign license subscription(s) to device

Options: advance-70xx | advance-72xx | advance-90xx-sec | advance-base-7005 | advanced-ap | advanced-switch-6100 | advanced-switch-6200 | advanced-switch-6300 | advanced-switch-6400 | advanced-switch-8400 | dm | foundation-70xx | foundation-72xx | foundation-90xx-sec | foundation-ap | foundation-base-7005 | foundation-base-90xx-sec | foundation-switch-6100 | foundation-switch-6200 | foundation-switch-6300 | foundation-switch-6400 | foundation-switch-8400 | foundation-wlan-gw | vgw2g | vgw4g | vgw500m

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

serial: Required argument

[SERIAL NUM]: Required argument

mac: Required argument

[MAC ADDRESS]: Required argument

group: Optional argument

[GROUP]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

group

Add a group

cencli add group [OPTIONS] [GROUP NAME]

Options

--wired-tg

Manage switch configurations via templates

Default: False

--wlan-tg

Manage AP configurations via templates

Default: False

--gw-role <gw_role>

Configure Gateway Role [default: branch]

Options: branch | vpnc | wlan

--aos10: Create AOS10 Group [default: AOS8 IAP]

--mb: Configure Group for MicroBranch APs (AOS10 only)

--ap: Allow APs in group

--sw: Allow ArubaOS-SW switches in group.

--cx: Allow ArubaOS-CX switches in group.

--gw: Allow gateways in group.

--mon-only-sw

Monitor Only for ArubaOS-SW

Default: False

--mon-only-cx

Monitor Only for ArubaOS-CX

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP NAME]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_VERBOSE_DEBUG: Provide a default for --debugv

ARUBACLI_ACCOUNT: Provide a default for --account

guest

Add a guest user to a configured portal

cencli add guest [OPTIONS] PORTAL_ID NAME

Options

--password <password>

--company <company>: Company Name

--phone <phone>: Phone # of guest; Format [+CountryCode][PhoneNumber]

--email <email>: email of guest

--notify-to <notify_to>

Notify to ‘phone’ or ‘email’

Options: phone | email

--disable: add account, but set to disabled

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

PORTAL_ID: Required argument

NAME: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

label

Create a new label

cencli add label [OPTIONS] NAME

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

NAME: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

site

Add a site.

Use ‘cencli batch add sites <IMPORT_FILE>’ to add multiple sites.

Provide geo-loc or address details, (Google Maps “Plus Codes” are supported) not both. Can provide both in subsequent calls, but api does not allow both in same call.

cencli add site [OPTIONS] SITE_NAME [ADDRESS] [CITY] [STATE] [ZIPCODE]
                [COUNTRY]

Options

--lat <LATITUDE>

--lon <LONGITUDE>

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

SITE_NAME: Required argument

ADDRESS: Optional argument

CITY: Optional argument

STATE: Optional argument

ZIPCODE: Optional argument

COUNTRY: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

template

Add/Upload a new template to a template group

cencli add template [OPTIONS] NAME GROUP [TEMPLATE]

Options

--dev-type <dev_type>

Default: ap
Options: ap | sw | cx | gw

--model <model>

Default: ALL

--ver <version>

Default: ALL

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

NAME: Required argument

GROUP: Required argument

TEMPLATE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

webhook

Add a WebHook

cencli add webhook [OPTIONS] NAME URLS...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

NAME: Required argument

URLS: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

wlan

Add WLAN (SSID)

cencli add wlan [OPTIONS] [GROUP NAME|SWARM ID] NAME psk [WPA PASSPHRASE] type
                ['employee'|'guest'] vlan [VLAN] zone [ZONE] ssid [SSID] bw-
                limit-up [LIMIT] bw-limit-down [LIMIT] bw-limit-user-up
                [LIMIT] bw-limit-user-down [LIMIT] portal-profile [PORTAL
                PROFILE]

Options

--hidden

Make WLAN hidden

Default: False

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP NAME|SWARM ID]: Required argument

NAME: Required argument

psk [WPA PASSPHRASE]: Optional argument(s)

type ['employee'|'guest']: Optional argument(s)

vlan [VLAN]: Optional argument(s)

zone [ZONE]: Optional argument(s)

ssid [SSID]: Optional argument(s)

bw-limit-up [LIMIT]: Optional argument(s)

bw-limit-down [LIMIT]: Optional argument(s)

bw-limit-user-up [LIMIT]: Optional argument(s)

bw-limit-user-down [LIMIT]: Optional argument(s)

portal-profile [PORTAL PROFILE]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

archive

Archive devices. This has less meaning/usefulness with the transition to GreenLake.

cencli archive <devices>, followed by cencli unarchive <devices> removes any subscriptions and the devices assignment to the Aruba Central App in GreenLake.

Archive removes the GreenLake assignment, but the device can’t be added to a different account until it’s unarchived.

Just use cencli deleve device … or cencli batch delete devices

cencli archive [OPTIONS] [name|ip|mac|serial] ... (multiple allowed)

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

assign

Assign licenses / labels

cencli assign [OPTIONS] COMMAND [ARGS]...

label

Assign label to device(s)

cencli assign label [OPTIONS] LABEL DEVICES...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

LABEL: Required argument

DEVICES: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

license

Assign Licenses to devices by serial number(s) or enable auto-subscribe for the license type.

Device must already be added to Central. Use ‘[cyan]cencli show inventory[/]’ to see devices that have been added. Use ‘–license’ option with ‘[cyan]cencli add device …[/]’ to add device and assign license in one command.

cencli assign license [OPTIONS]
                      LICENSE:{advance-70xx|advance-72xx|advance-90xx-
                      sec|advance-base-7005|advanced-ap|advanced-
                      switch-6100|advanced-switch-6200|advanced-
                      switch-6300|advanced-switch-6400|advanced-switch-8400|dm
                      |foundation-70xx|foundation-72xx|foundation-90xx-
                      sec|foundation-ap|foundation-base-7005|foundation-
                      base-90xx-sec|foundation-switch-6100|foundation-
                      switch-6200|foundation-switch-6300|foundation-
                      switch-6400|foundation-switch-8400|foundation-wlan-
                      gw|vgw2g|vgw4g|vgw500m} SERIAL_NUMS...

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

LICENSE: Required argument

SERIAL_NUMS: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

batch

Perform batch operations.

cencli batch [OPTIONS] COMMAND [ARGS]...

add

Perform batch Add operations using import data from file.

cencli batch add [OPTIONS] WHAT:{sites|groups|devices|labels} [IMPORT_FILE]

Options

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

archive

Batch archive devices based on import data from file.

This will archive the devices in GreenLake

cencli batch archive [OPTIONS] [IMPORT_FILE]

Options

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

delete

Perform batch Delete operations using import data from file.

cencli delete sites <IMPORT_FILE> and cencli delte groups <IMPORT_FILE>

Do what you’d expect.

cencli batch delete devices <IMPORT_FILE>

Delete devices will remove any subscriptions/licenses from the device and

disassociate the device with the Aruba Central app in GreenLake. It will then remove the device from the monitoring views, along with the historical data for the device.

Note: devices can only be removed from monitoring views if they are in a

down state. This command will delay/wait for any Up devices to go Down after the subscriptions/assignment to Central is removed, but it can also be ran again. It will pick up where it left off, skipping any steps that have already been performed.

cencli batch delete [OPTIONS] WHAT:{sites|groups|devices|labels} [IMPORT_FILE]

Options

--ui-only

Only delete device from UI/Monitoring views. Devices remains assigned and licensed. Devices must be offline.

Default: False

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--debugv

Enable Verbose Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

move

Perform batch Move devices to group and/or site based on import data from file.

By default group/site/label assignment will be processed if found in the import file. Use -G|–group, -S|–site, -L|–label flags to only process specified moves, and ignore others even if found in the import.

i.e. if import includes a definition for group, site, and label, and you only want to process the site move. Use the -S|–site flag, to ignore the other columns.

cencli batch move [OPTIONS] [IMPORT_FILE]

Options

-G, --group

process site move from import.

Default: False

-S, --site

process site move from import.

Default: False

-L, --label

process label assignment from import.

Default: False

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

rename

Perform AP rename in batch from import file or automatically based on LLDP

cencli batch rename [OPTIONS] WHAT:{sites|aps|groups} ['lldp'|IMPORT FILE
                    PATH]

Options

--lldp: Automatic AP rename based on lldp info from upstream switch.

--ap <name|ip|mac|serial>: [LLDP rename] Perform on specified AP

--label <label>: [LLDP rename] Perform on APs with specified label

--group <group>: [LLDP rename] Perform on APs in specified group

--site <name|site id|address|city|state|zip>: [LLDP rename] Perform on APs in specified site

--model <model>: [LLDP rename] Perform on APs of specified model

-Y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--debugv

Enable Verbose Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

['lldp'|IMPORT FILE PATH]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

unarchive

Batch unarchive devices based on import data from file.

This will unarchive the devices (previously archived) in GreenLake

cencli batch unarchive [OPTIONS] [IMPORT_FILE]

Options

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

unsubscribe

Batch Unsubscribe devices

Can Unsubscribe devices specified in import file or all devices in the inventory that have never connected to Aruba Central (-N | –never-connected)

Use (-D | –dis-cen) flag to also dissasociate the devices from the Aruba Central app in Green Lake.

cencli batch unsubscribe [OPTIONS] [IMPORT_FILE]

Options

-N, --never-connected: Remove subscriptions from any devices in inventory that have never connected to Central

-D, --dis-cen

Dissasociate the device from the Aruba Central App in Green Lake

Default: False

--example: Show Example import file format.

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--debugv

Enable Verbose Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

IMPORT_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

verify

Validate batch Add operations using import data from file.

The same file used to import can be used to validate.

cencli batch verify [OPTIONS] WHAT:{sites|groups|devices|labels} IMPORT_FILE

Options

-F

Output only a simple list with failed serials

Default: False

-OK

Output only a simple list with serials that validate OK

Default: False

--out <outfile>: Write output to a file (and display)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

IMPORT_FILE: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

blink

Blink LED

cencli blink [OPTIONS] [name|ip|mac|serial] ACTION:{on|off} SECONDS

Options

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

ACTION: Required argument

SECONDS: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

bounce

Bounce Interface or PoE on Interface

cencli bounce [OPTIONS] WHAT:{poe|interface} [name|ip|mac|serial] PORT

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

[name|ip|mac|serial]: Required argument

PORT: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

clone

Clone Aruba Central Groups

cencli clone [OPTIONS] COMMAND [ARGS]...

group

Clone a group

cencli clone group [OPTIONS] [NAME OF GROUP TO CLONE] [NAME OF GROUP TO
                   CREATE]

Options

--aos10: Upgrade new cloned group to AOS10

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[NAME OF GROUP TO CLONE]: Required argument

[NAME OF GROUP TO CREATE]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

convert

Convert specified j2 template into final form based on variable file.

–var-file is optional, If not provided cencli will look in the same dir as the template for a file with the same name and supported extension.

cencli supports most common extension for variable import: ‘.yaml’, ‘.yml’, ‘.json’, ‘.csv’, ‘.tsv’, ‘.dbf’

cencli convert [OPTIONS] TEMPLATE [VAR_FILE]

Options

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

TEMPLATE: Required argument

VAR_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

delete

Delete Aruba Central Objects.

cencli delete [OPTIONS] COMMAND [ARGS]...

certificate

Delete a certificate

cencli delete certificate [OPTIONS] NAME

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

NAME: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

device

Delete devices.

Unassigns any subscriptions and removes the devices assignment with the Aruba Central app in GreenLake. Which makes it possible to add it to a different GreenLake WorkSpace.

Devices are also removed from the Central monitoring views/UI (after waiting for them to disconnect).

Use –ui-only to remove the device from monitoring views/UI only.

[cyan]cencli unassign license <LICENSE> <DEVICES>[/] can also be used to unassign a specific license from a device(s), (device will remain associated with central App in GreenLake).

cencli delete device [OPTIONS] [name|ip|mac|serial] ... (multiple allowed)

Options

--ui-only

Only delete device from UI/Monitoring views. App assignment and subscriptions remain intact.

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

firmware

Remove Firmware Compliance

cencli delete firmware [OPTIONS] COMMAND [ARGS]...

compliance

Delete/Clear firmware compliance

cencli delete firmware compliance [OPTIONS] DEVICE_TYPE:{ap|sw|cx|gw} [GROUP-
                                  NAME]

Options

--group <group_name>: Filter by group

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

DEVICE_TYPE: Required argument

[GROUP-NAME]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

group

Delete group(s)

cencli delete group [OPTIONS] GROUPS...

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

GROUPS: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

label

Delete a label

cencli delete label [OPTIONS] LABEL

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d

Use default central account

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

LABEL: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

site

Delete sites

cencli delete site [OPTIONS] SITES...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

SITES: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

template

Delete a Template

cencli delete template [OPTIONS] TEMPLATE [group GROUP] [VAL1]

Options

---group <_group>

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

TEMPLATE: Required argument

[group GROUP]: Optional argument

VAL1: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

webhook

Delete WebHook

cencli delete webhook [OPTIONS] ID_

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

ID_: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

wlan

Delete a WLAN (SSID)

cencli delete wlan [OPTIONS] [GROUP NAME|SWARM ID] [WLAN NAME]

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP NAME|SWARM ID]: Required argument

[WLAN NAME]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

kick

Kick (disconnect) WLAN clients

cencli kick [OPTIONS] COMMAND [ARGS]...

all

Disconnect all WLAN clients from an AP optionally for a specific SSID

This command currently only applies to APs

cencli kick all [OPTIONS] [name|ip|mac|serial]

Options

--ssid <ssid>: Kick all users connected to a specific SSID

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

client

Disconnect a WLAN client.

This command relies on [cyan]cached[/] client data to determine the AP the client is connected to. The cache is updated anytime a [cyan]show clients …[/] is ran, or automatically if the client is not found in the cache.

The [cyan]-R[/] flag can be used to force a cache refresh prior to performing the disconnect.

cencli kick client [OPTIONS] [username|ip|mac]

Options

-R, --refresh

Cache is used to determine what AP the client is connected to, which could be stale. This forces a cache update.

Default: False

-D, --drop

(implies -R): Drop all users from existing cache, then refresh. By default any user that has ever connected is retained in the cache.

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[username|ip|mac]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

move

Move device(s) to a defined group and/or site.

cencli move [OPTIONS] [name|ip|mac|serial] ... (multiple allowed) [KW1] [site
            <SITE>] [KW2] [group <GROUP>]

Options

--reset-group: Reset group membership. (move to the defined default group)

-k

Keep config intact for CX switches during move

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Optional argument(s)

KW1: Optional argument

[site <SITE>]: Optional argument

KW2: Optional argument

[group <GROUP>]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

nuke

Factory Default A Switch (ArubaOS-SW only)

cencli nuke [OPTIONS] [name|ip|mac|serial]

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

reboot

Reboot a device

cencli reboot [OPTIONS] [name|ip|mac|serial]

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

refresh

Refresh tokens / cache

cencli refresh [OPTIONS] COMMAND [ARGS]...

cache

Refresh friendly identifier cache.

The cache is the data that is stored locally so you can reference a device by name, ip, or mac vs just serial number.

This is not necessary under normal circumstances as the cli will automatically refresh the cache if you provide an identifier that doesn’t have a match.

cencli refresh cache [OPTIONS]

Options

-d: Use default central account

--debug

Enable Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

token

Refresh Central API access/refresh tokens.

This is not necessary under normal circumstances as the cli will automatically refresh the tokens if they are expired.

cencli refresh token [OPTIONS]

Options

-d: Use default central account

--debug

Enable Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

webhook

Refresh WebHook Token (generate a new token).

Use cencli show webhooks to get the required webhook id (wid).

cencli refresh webhook [OPTIONS]

Options

--wid <wid>: Required WebHook ID

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

remove

Remove a device from a site

cencli remove [OPTIONS] [name|ip|mac|serial] ... (multiple allowed) [site
              <SITE>]

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

[site <SITE>]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

rename

Rename Aruba Central Objects

cencli rename [OPTIONS] COMMAND [ARGS]...

ap

[bright_green]Rename an Access Point[/]

cencli rename ap [OPTIONS] [name|ip|mac|serial] NEW_NAME

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

--debug

Enable Additional Debug Logging

Default: False

Arguments

[name|ip|mac|serial]: Required argument

NEW_NAME: Required argument

Environment variables

ARUBACLI_ACCOUNT: Provide a default for --account

ARUBACLI_DEBUG: Provide a default for --debug

group

[green3]Rename a group.[/] [red]AOS8 Only use clone for AOS10 groups[/]

pile_of_poo:[red]WARNING: the API endpoint has limited scope where this command will work.[/]:pile_of_poo:
pile_of_poo:[red]Clone (or build a new group) are the only options if it does not work.[/]:pile_of_poo

cencli rename group [OPTIONS] [GROUP NAME] NEW_NAME

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

--debug

Enable Additional Debug Logging

Default: False

Arguments

[GROUP NAME]: Required argument

NEW_NAME: Required argument

Environment variables

ARUBACLI_ACCOUNT: Provide a default for --account

ARUBACLI_DEBUG: Provide a default for --debug

site

office: [bright_green]Rename A Site.[/] :office:

cencli rename site [OPTIONS] [name|site id|address|city|state|zip] NEW_NAME

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

--debug

Enable Additional Debug Logging

Default: False

Arguments

[name|site id|address|city|state|zip]: Required argument

NEW_NAME: Required argument

Environment variables

ARUBACLI_ACCOUNT: Provide a default for --account

ARUBACLI_DEBUG: Provide a default for --debug

reset

Reset overlay control connection (OTO/ORO)

cencli reset [OPTIONS] [WHAT]:[overlay] [name|ip|mac|serial]

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Optional argument

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

save

Save Device Running Config to Startup

cencli save [OPTIONS] [name|ip|mac|serial]

Options

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

set

Set Firmware Compliance

cencli set [OPTIONS] COMMAND [ARGS]...

firmware

Set Firmware Compliance

cencli set firmware [OPTIONS] COMMAND [ARGS]...

compliance

Set firmware compiance

cencli set firmware compliance [OPTIONS] DEVICE_TYPE:{ap|sw|cx|gw} [GROUP
                               NAME] [VERSION]

Options

--at <at>: When to schedule upgrade. format: ‘mm/dd/yyyy_hh:mm’ or ‘dd_hh:mm’ (implies current month) [default: Now]

-U, --allow-unsupported

Allow Unsupported (custom) version.

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

DEVICE_TYPE: Required argument

[GROUP NAME]: Required argument

VERSION: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

show

Show Details about Aruba Central Objects

cencli show [OPTIONS] COMMAND [ARGS]...

alerts

Show Alerts/Notifications (for past 24 hours by default). Notification must be Configured.

cencli show alerts [OPTIONS]

Options

--group <Device Group>: Filter by Group

--label <Device Label>: Filter by Label

--site <name|site id|address|city|state|zip>: Filter by Site

--start <start>: Start time of range to collect alerts, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect alerts, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect alerts for last <past>, d=days, h=hours, m=mins i.e.: 3h Default: 24 hours

--device <name|ip|mac|serial>: Filter alerts by device

--severity <severity>

Filter by alerts by severity.

Options: critical | major | minor | warning | info

--search <search>: Filter by alerts with search term in name/description/category.

--ack, --no-ack: Show only acknowledged (–ack) or unacknowledged (–no-ack) alerts

--type <alert_type>

Filter by alert type

Options: device | client | user | ids

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

Default: time
Options: time | severity | type | description | acknowledged

-r: Reverse Output order

-v

Show alerts with original field names and minimal formatting (vertically)

Default: False

-vv

Show raw unformatted response from Central API Gateway

Default: False

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

all

Show details for All devices

cencli show all [OPTIONS]

Options

--group <group>: Filter by Group

--site <site>: Filter by Site

--label <label>: Filter by Label

--pub-ip <pub_ip>: Filter by Public IP

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--stats

Show device statistics

Default: False

--clients

Calculate client count (per device)

Default: False

-v: additional details (include devices in Inventory that have yet to connect)

--sort <sort_by>

Field to sort by

Options: name | model | ip | mac | serial | group | site | status | type | labels | version | uptime | ap | ap_ip | ap_serial | ap_port | switch | switch_ip | switch_serial | switch_port | untagged_vlan | tagged_vlans | healthy

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

aps

Show details for APs

cencli show aps [OPTIONS] [name|ip|mac|serial] ... (multiple allowed)

Options

--group <group>: Filter by Group

--site <site>: Filter by Site

--label <label>: Filter by Label

--pub-ip <Public IP Address>: Filter by Public IP

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--stats

Show device statistics

Default: False

--clients

Calculate client count (per AP)

Default: False

--ssids

Calculate SSID count (per AP)

Default: False

-n, --neighbors: Show AP neighbors [requires –site]

--sort <sort_by>

Field to sort by

Options: name | model | ip | mac | serial | group | site | status | type | labels | version | uptime | ap | ap_ip | ap_serial | ap_port | switch | switch_ip | switch_serial | switch_port | untagged_vlan | tagged_vlans | healthy

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

archived

Show archived devices

cencli show archived [OPTIONS]

Options

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

branch

Show branch health

cencli show branch [OPTIONS] COMMAND [ARGS]...

health

Show Branch Health statistics

cencli show branch health [OPTIONS] [name|site id|address|city|state|zip]

Options

--wan-down

Show branches with wan uplinks or tunnels Down.

Default: False

--down: Show branches with down devices.

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|site id|address|city|state|zip]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

certs

Show certificates/details

cencli show certs [OPTIONS] [certificate name|certificate hash]

Options

-r: Reverse output order

--sort <sort_by>

Options: name | type | expiration | expired | md5_checksum | sha1_checksum

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[certificate name|certificate hash]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

clients

Show clients/details

cencli show clients [OPTIONS]
                    [FILTER]:[wired|wireless|all|mac|device|denylisted]
                    [name|ip|mac|serial]

Options

--group <Group>: Filter by Group

--site <Site>: Filter by Site

--label <Label>: Filter by Label

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--sort <sort_by>

Options: name | mac | vlan | ip | role | network | dot11 | connected_device | site | group | last_connected

-r: Reverse output order

-v: additional details (vertically)

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug: Enable Additional Debug Logging

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

FILTER: Optional argument

[name|ip|mac|serial]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

config

Show Effective Group/Device Config (UI Group) or cencli config. Examples: ‘cencli show config GROUPNAME –gw’, ‘cencli show config DEVICENAME’, ‘cencli show config cencli’

cencli show config [OPTIONS] [NAME|IP|MAC|SERIAL|GROUPNAME|cencli] [DEVICE]

Options

--gw: Show group level config for gateways.

--ap: Show group level config for APs.

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[NAME|IP|MAC|SERIAL|GROUPNAME|cencli]: Required argument

DEVICE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

devices

Show details for devices

cencli show devices [OPTIONS] [name|ip|mac|serial|'all'] ... (multiple
                    allowed)

Options

--group <group>: Filter by Group

--site <site>: Filter by Site

--label <label>: Filter by Label

--pub-ip <pub_ip>: Filter by Public IP

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--stats

Show device statistics

Default: False

--clients

Calculate client count (per device)

Default: False

-v: additional details (include devices in Inventory that have yet to connect)

--sort <sort_by>

Field to sort by

Options: name | model | ip | mac | serial | group | site | status | type | labels | version | uptime | ap | ap_ip | ap_serial | ap_port | switch | switch_ip | switch_serial | switch_port | untagged_vlan | tagged_vlans | healthy

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial|'all'] ... (multiple allowed): Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

dhcp

“Show DHCP pool or lease details (gateways only)”

cencli show dhcp [OPTIONS] WHAT:{clients|server} [name|ip|mac|serial] (Valid
                 for Gateways Only)

Options

--no-res

Filter out reservations

Default: False

--sort <sort_by>: Field to sort by

-r: Reverse sort order

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

-vv: Show raw response (no formatting) (vertically)

Arguments

WHAT: Required argument

[name|ip|mac|serial] (Valid for Gateways Only): Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

events

Show Event Logs (last 4 hours by default)

cencli show events [OPTIONS] [LOG_ID]

Options

--group <Device Group>: Filter by Group

--label <Device Label>: Filter by Label

--site <name|site id|address|city|state|zip>: Filter by Site

--start <start>: Start time of range to collect events, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect events, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect events for last <past>, d=days, h=hours, m=mins i.e.: 3h

--device <name|ip|mac|serial>: Filter events by device

--client-mac <client_mac>: Filter events by client MAC address

--bssid <bssid>: Filter events by bssid

--hostname <hostname>: Filter events by hostname (fuzzy match)

--dev-type <ap|switch|gw|client>

Filter events by device type

Options: ap | switch | gw | client

--description <description>: Filter events by description (fuzzy match)

--event-type <event_type>: Filter events by type (fuzzy match)

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

-r: Reverse Output order Default order: newest on bottom.

-v

Show logs with original field names and minimal formatting (vertically)

Default: False

-vv

Show raw unformatted response from Central API Gateway

Default: False

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[LOG_ID]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

firmware

Show Firmware / compliance details

cencli show firmware [OPTIONS] COMMAND [ARGS]...

compliance

Show firmware compliance details for a group/device type

cencli show firmware compliance [OPTIONS] DEVICE_TYPE:{ap|sw|cx|gw} [GROUP-
                                NAME]

Options

--group <group_name>: Filter by group

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

DEVICE_TYPE: Required argument

[GROUP-NAME]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

list

Show available firmware list for a specific device or a type of device

cencli show firmware list [OPTIONS] [name|ip|mac|serial]

Options

--dev-type <dev_type>

Get firmware list for a device type

Options: ap | sw | cx | gw

-s, --swarm: Get available firmware for IAP cluster associated with provided device

--swarm-id <swarm_id>: Get available firmware for specified IAP cluster

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

gateways

Show details for gateways

cencli show gateways [OPTIONS] [name|ip|mac|serial]

Options

--group <group>: Filter by Group

--site <site>: Filter by Site

--label <label>: Filter by Label

--pub-ip <Public IP Address>: Filter by Public IP

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--stats

Show device statistics

Default: False

--clients

Calculate client count (per switch)

Default: False

--sort <sort_by>

Field to sort by

Options: name | model | ip | mac | serial | group | site | status | type | labels | version | uptime | ap | ap_ip | ap_serial | ap_port | switch | switch_ip | switch_serial | switch_port | untagged_vlan | tagged_vlans | healthy

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

groups

Show groups/details

cencli show groups [OPTIONS]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-v: Verbose: include additional group properties

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

guests

Show Guests configured for a Portal

You need to use cencli show portals to get the portal id friendly name and completion for portals coming soon

cencli show guests [OPTIONS] PORTAL_ID

Options

--sort <sort_by>: Field to sort by

-r

Sort in descending order

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

PORTAL_ID: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

hook-proxy

Show WebHook Proxy details/logs

cencli show hook-proxy [OPTIONS] [WHAT]:[logs|pid|port]

Options

-f

follow tail on log file (implies show hook-proxy logs)

Default: False

-b

Brief output for ‘pid’ and ‘port’

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

interfaces

Show interfaces/details

Command is valid for switches and gateways

cencli show interfaces [OPTIONS] [name|ip|mac|serial] [SLOT]

Options

--sort <sort_by>: Field to sort by

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

SLOT: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

inventory

Show device inventory / all devices that have been added to Aruba Central.

cencli show inventory [OPTIONS] [DEV_TYPE]:[all|ap|gw|vgw|sw|cx|switch]

Options

--sub, --no-sub: Show devices with applied subscription/license, or devices with no subscription/license applied.

-v: include additional details for devices that have connected to Aruba Central

--sort <sort_by>

Field to sort by

Options: type | model | sku | mac | serial | services

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

DEV_TYPE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

labels

Show labels/details

cencli show labels [OPTIONS]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

last

Re-display output from Last command. (No API Calls)

cencli show last [OPTIONS]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

-r: Reverse Output order

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

lldp

Show AP lldp neighbor. Command only applies to APs at this time.

cencli show lldp [OPTIONS] [name|ip|mac|serial] ... (multiple allowed)

Options

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

logs

Show Audit Logs or cencli logs. Audit Logs will displays prior 48 hours if no time options are provided.

cencli show logs [OPTIONS] [LOG_ID]

Options

-f

follow tail on log file (implies show logs)

Default: False

--user <user>: Filter logs by user

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--all

Display all available audit logs. Overrides default of 48h

Default: False

--device <name|ip|mac|serial>: Filter logs by device

--ip <ip>: Filter logs by device IP address

--description <description>: Filter logs by description (fuzzy match)

--class <_class>: Filter logs by classification (fuzzy match)

-n <count>: Collect Last n logs

--cencli

Show cencli logs

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

Options: time | app | class | type | description | target | ip | user | id

-r: Reverse Output order Default order: newest on bottom.

-v

Show logs with original field names and minimal formatting (vertically)

Default: False

-vv

Show raw unformatted response from Central API Gateway

Default: False

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[LOG_ID]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

notifications

Show alert/notification configuration.

Display alerty types, notification targets, and rules.

cencli show notifications [OPTIONS]

Options

--search <search>: Filter by alerts with search term in name/description/category.

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

Default: category

-r: Reverse Output order Default order: newest on bottom.

-vv

Show unformatted response from Central API Gateway

Default: False

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

ospf

Show OSPF details

cencli show ospf [OPTIONS] COMMAND [ARGS]...

area

Show OSPF area information for a device

cencli show ospf area [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>

Options: area | area_type | interface_count | spf_run_count | default_cost | summary_enable

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

database

Show OSPF database for a device

cencli show ospf database [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>

Options: area | lsa_type | ls_id | router_id | age | seq_no | checksum | link_count | route_tag

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

interfaces

Show OSPF Interfaces for a device

cencli show ospf interfaces [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>

Options: name | area | ip | state | oper_state | type | cost | nbrs | DR_rtr_id | DR_IP | BDR_rtr_id | BDR_IP | auth | priority | hello_interval | dead_interval | rexmt_interval

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

neighbors

Show OSPF Neighbors for a device

cencli show ospf neighbors [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>

Options: router_id | ip | priority | interface_name | interface_state | neighbor_state | area | options | dead_timer | rexmt_timer

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

overlay

Show Overlay (OTO/ORO) Information

cencli show overlay [OPTIONS] COMMAND [ARGS]...

connection

Show overlay connection (OTO/ORO) details

cencli show overlay connection [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>: Field to sort by

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

interfaces

Show overlay interfaces

cencli show overlay interfaces [OPTIONS] [name|ip|mac|serial]

Options

--sort <sort_by>

Field to sort by

Options: name | endpoint | state | uptime | routes

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

routes

Show gateway routes advertised or learned from route/tunnel orchestrator

cencli show overlay routes [OPTIONS] [name|ip|mac|serial]

Options

-a, --advertised

Show advertised routes [default: show learned routes]

Default: False

-b, --best

Return only best/preferred route for each destination

Default: False

--sort <sort_by>

Field to sort by

Options: destination | interface | nexthop | protocol | flags | metric | best | learn_time

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

poe

Show (switch) poe details for an interface

cencli show poe [OPTIONS] [name|ip|mac|serial] [PORT]

Options

--port <_port>

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

PORT: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

portals

Show Configured Guest Portals

cencli show portals [OPTIONS]

Options

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

roaming

Show wireless client roaming history.

If ip or username are provided the client cache is used to lookup the clients mac address. The cache is updated anytime a show clients … is ran, or automatically if the client is not found in the cache.

The -R flag can be used to force a cache refresh prior to performing the disconnect.

cencli show roaming [OPTIONS] [username|ip|mac]

Options

--start <start>: Start time of range to collect roaming history, format: yyyy-mm-ddThh:mm (24 hour notation), default past 3 hours.

--end <end>: End time of range to collect roaming history, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect roaming history for last <past>, d=days, h=hours, m=mins i.e.: 3h

-R, --refresh

Cache is used to determine mac if username or ip are provided. This forces a cache update prior to lookup.

Default: False

-D, --drop

(implies -R): Drop all users from existing cache, then refresh. By default any user that has ever connected is retained in the cache.

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format [default]

Default: False

--sort <sort_by>

Options: name | mac | vlan | ip | role | network | dot11 | connected_device | site | group | last_connected

-r: Reverse output order

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

-d: Use default central account

--debug: Enable Additional Debug Logging

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[username|ip|mac]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

routes

Show device routing table

cencli show routes [OPTIONS] [name|ip|mac|serial]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format [default]

Default: False

--sort <sort_by>

Options: destination | interface | nexthop | protocol | flags | metric | best | learn_time

-r: Reverse output order

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

run

Show last known running config for a device

Not supported for CX. Gateways and APs returns typical CLI format. AOS-SW returns a JSON (unless –yaml flag is provided).

cencli show run [OPTIONS] [name|ip|mac|serial]

Options

--yaml

Applies to AOS-SW: Output in YAML format [default: JSON]

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

sites

Show sites/details

cencli show sites [OPTIONS] [name|site id|address|city|state|zip]

Options

-s: Calculate # of sites per state

-c: Calculate # of sites per country

--sort <sort_by>

Default: name
Options: name | id | address | city | state | zipcode | country | associated_devices

-r: Reverse output order

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|site id|address|city|state|zip]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

subscription

Show subscription/license details or stats

cencli show subscription [OPTIONS] [WHAT]:[details|stats|names|auto]

Options

--sort <sort_by>

Options: name | sku | status | type | key | network | start_date | end_date

-r

Sort in descending order

Default: False

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

-vv: Show raw response (no formatting) (vertically)

Arguments

WHAT: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

swarms

[cyan]Show Swarms (IAP Clusters)[/]

cencli show swarms [OPTIONS]

Options

--group <Device Group>: Filter by Group

--status <up|down>

Filter by swarm status

Options: up | down | Up | Down | UP | DOWN

--up: Filter by swarms that are Up

--down: Filter by swarms that are Down

--pub-ip <Public IP Address>: Filter by swarm Public IP

--name <name>: Filter by swarm/cluster name

--sort <sort_by>: Field to sort by

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

switches

Show details for switches

cencli show switches [OPTIONS] [name|ip|mac|serial]

Options

--group <group>: Filter by Group

--site <site>: Filter by Site

--label <label>: Filter by Label

--pub-ip <Public IP Address>: Filter by Public IP

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--stats

Show device statistics

Default: False

--clients

Calculate client count (per switch)

Default: False

--sort <sort_by>

Field to sort by

Options: name | model | ip | mac | serial | group | site | status | type | labels | version | uptime | ap | ap_ip | ap_serial | ap_port | switch | switch_ip | switch_serial | switch_port | untagged_vlan | tagged_vlans | healthy

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

task

Show status of previously issued task/command.

Requires task_id which is provided in the response of the previously issued command.

Example: [cyan]cencli bounce interface idf1-6300-sw 1/1/11[/] will queue the command: and provide the task_id.

cencli show task [OPTIONS] TASK_ID

Options

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

TASK_ID: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

templates

Show templates/details

cencli show templates [OPTIONS] [NAME] [GROUP]...

Options

--group <_group>: Get Templates for Group

--dev-type <device_type>

Filter by Device Type

Options: ap | sw | cx | gw

--version <version>: [Templates] Filter by dev version Template is assigned to

--model <model>: [Templates] Filter by model

--sort <sort_by>

Options: device_type | group | model | name | template_hash | version

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

NAME: Optional argument

GROUP: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

token

Show current access token from cache

cencli show token [OPTIONS]

Options

--no-refresh

Do not refresh tokens first

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

tshoot

Show troubleshooting session details or available commands

cencli show tshoot [OPTIONS] COMMAND [ARGS]...

commands

[cyan]Show available troubleshooting commands for a given device type.[/]

Use [cyan]cencli tshoot…[/] to start a troubleshooting session.

cencli show tshoot commands [OPTIONS] [ap|gw|cx|sw|mas]

Options

--sort <sort_by>

Default: id
Options: id | category

-r: Reverse output order

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug: Enable Additional Debug Logging

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[ap|gw|cx|sw|mas]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

results

[cyan]Show Troubleshooting results from an existing session.[/]

Use [cyan]cencli tshoot…[/] to start a troubleshooting session.

cencli show tshoot results [OPTIONS] [name|ip|mac|serial] [SESSION_ID]

Options

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug: Enable Additional Debug Logging

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

SESSION_ID: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

tunnels

Show Branch Gateway/VPNC Tunnel details

cencli show tunnels [OPTIONS] [name|ip|mac|serial]
                    [TIME_RANGE]:[3H|1D|1W|1M|3M]

Options

--json

Output in JSON

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format [default]

Default: False

--sort <sort_by>

-r: Reverse output order

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

-d: Use default central account

--debug: Enable Additional Debug Logging

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

TIME_RANGE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

upgrade

Show firmware upgrade status

cencli show upgrade [OPTIONS] [name|ip|mac|serial]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

variables

Show Variables for all or specific device

cencli show variables [OPTIONS] [name|ip|mac|serial|all]

Options

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in table format

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial|all]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

version

Show current cencli version, and latest available version.

cencli show version [OPTIONS]

Options

--debug

Enable Additional Debug Logging

Default: False

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

vlans

Show VLANs for device or site

Command applies to sites, gateways, or switches

cencli show vlans [OPTIONS] [name|ip|mac|serial] (vlans for a device) OR
                  [name|site id|address|city|state|zip] (vlans for a site)

Options

--up: Filter by devices that are Up

--down: Filter by devices that are Down

--sort <sort_by>

Field to sort by

Options: name | pvid | untagged | tagged | status | mgmt | jumbo | voice | igmp | oper_state_reason

-r

Sort in descending order

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] (vlans for a device) OR [name|site id|address|city|state|zip] (vlans for a site): Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

webhooks

Show configured webhooks

cencli show webhooks [OPTIONS]

Options

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--sort <sort_by>

Options: name | updated | wid | urls | retry-policy | token | token-created

-r: Reverse Output order Default order: newest on bottom.

--pager

Enable Paged Output

Default: False

--out <outfile>: Output to file (and terminal)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

wids

Show Wireless Intrusion Detection data

cencli show wids [OPTIONS] COMMAND [ARGS]...

all

Show All WIDS Classifications

cencli show wids all [OPTIONS] [GROUP-NAME] [LABEL] [SITE-NAME]

Options

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager, --no-pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP-NAME]: Optional argument

[LABEL]: Optional argument

[SITE-NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

interfering

Show interfering APs

cencli show wids interfering [OPTIONS] [GROUP-NAME] [LABEL] [SITE-NAME]

Options

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP-NAME]: Optional argument

[LABEL]: Optional argument

[SITE-NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

neighbor

Show Neighbor APs

cencli show wids neighbor [OPTIONS] [GROUP-NAME] [LABEL] [SITE-NAME]

Options

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP-NAME]: Optional argument

[LABEL]: Optional argument

[SITE-NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

rogues

Show Detected Rogue APs

cencli show wids rogues [OPTIONS] [GROUP-NAME] [LABEL] [SITE-NAME]

Options

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP-NAME]: Optional argument

[LABEL]: Optional argument

[SITE-NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

suspect

Show Suspected Rogue APs

cencli show wids suspect [OPTIONS] [GROUP-NAME] [LABEL] [SITE-NAME]

Options

--start <start>: Start time of range to collect logs, format: yyyy-mm-ddThh:mm (24 hour notation)

--end <end>: End time of range to collect logs, formnat: yyyy-mm-ddThh:mm (24 hour notation)

--past <past>: Collect Logs for last <past>, d=days, h=hours, m=mins i.e.: 3h

--sort <sort_by>

-r: Reverse Output order.

-v

Show raw unformatted response (vertically)

Default: False

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager, --no-pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP-NAME]: Optional argument

[LABEL]: Optional argument

[SITE-NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

wlans

Show WLAN(SSID)/details

cencli show wlans [OPTIONS] [WLAN NAME]

Options

--group <Device Group>: Filter by Group

--label <Device Label>: Filter by Label

--site <site identifier>: Filter by device status

--swarm-id <swarm_id>: Filter by swarm

--sort <sort_by>

Field to sort by [default: SSID]

Options: ssid | security | type | clients | enabled | rf_band | mac_auth | access_type | group

-r: Reverse output order

--json

Output in JSON

Default: False

--yaml

Output in YAML

Default: False

--csv

Output in CSV

Default: False

--table

Output in table format

Default: False

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-v: get more details for SSIDs across all AP groups

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[WLAN NAME]: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

start

Start WebHook Proxy Service on this system in the background

Currently 2 webhook automations: For Both automations the URL to configure as the webhook destination is [cyan]http://localhost/api/webhook[/] (currently http)

[cyan]hook-proxy[/]:

Gathers status of all branch tunnels at launch, and utilizes webhooks to keep a local DB up to date.
Presents it’s own REST API that can be polled for branch/tunnel status: See [cyan]http://localhost:port/api/docs[/] for available endpoints / schema details.

[cyan]hook2snow[/]:

[bright_red]!!![/]This integration is incomplete, as the customer that requested it ended up going a different route with the webhooks.
Queries alerts API at launch to gather any “Open” items.
Receives webhooks from Aruba Central, and creates or resolves incidents in Service-Now via SNOW REST API

[italic]Requires optional hook-proxy component ‘[bright_green]pip3 install -U centralcli[hook-proxy][reset]’

cencli start [OPTIONS] [WHAT]:[hook-proxy|hook2snow]

Options

--port <port>

Port to listen on (overrides config value if provided)

Default: 9443

-Y, -y: Bypass confirmation prompts use ‘-yy’ to bypass all prompts (including killing current process if running)

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

stop

Stop WebHook Proxy (background process).

cencli stop [OPTIONS] WHAT:{hook-proxy|hook2snow}

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WHAT: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

sync

Sync/Refresh device config with Aruba Central

Only valid for gateways (aka controllers)

cencli sync [OPTIONS] [name|ip|mac|serial]

Options

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

test

Test Webhook or run a centralcli function directly (all Aruba Central API endpoints are available)

cencli test [OPTIONS] COMMAND [ARGS]...

method

Dev testing commands to run CentralApi methods from command line.

!!WARNING!! This is a development aid. Every API endpoint in Aruba Central has a corresponding method/function in Central CLI. The functions are generated by a script that parses the JSON, and are generally best-effort not tested. Once required by a command in Central CLI they are coppied, tweaked if necessary and renamed (those are tested).

The auto generated functions follow a consistent naming format. {swagger drop down text}_{method ie get}_{descriptive stuff from schema} i.e.: configuration_add_blacklist_clients

Tab completion returns available methods. Use –doc to get details on arguments for the provided method.

Args:: method (str, optional): CentralAPI method to test. kwargs (List[str], optional): list of args kwargs to pass to function.
format: arg1 arg2 keyword=value keyword2=value: or arg1, arg2, keyword = value, keyword2=value

Examples: cencli test method platform_get_devices all_ap

Use –doc flag to see documentation for usage of a method. cencli test method platform_get_devices –doc

Displays all attributes of Response object

cencli test method [OPTIONS] METHOD [KWARGS]...

Options

--doc

Get details on required args/keyword args for provided method.

Default: False

--json: Output in JSON

--yaml: Output in YAML

--csv: Output in CSV

--table: Output in Table

--outfile <outfile>: Output to file (and terminal)

--pager, --no-pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

METHOD: Required argument

KWARGS: Optional argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_VERBOSE_DEBUG: Provide a default for --debugv

ARUBACLI_ACCOUNT: Provide a default for --account

Output is displayed in yaml by default.

webhook

Test WebHook

cencli test webhook [OPTIONS] WID

Options

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WID: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

tshoot

Run Troubleshooting commands on devices

cencli tshoot [OPTIONS] COMMAND [ARGS]...

ap-dpi

Show DPI (valid on APs)

[cyan]Returns the output of the following DPI related commands.[/]

[cyan]-[/] show dpi-stats session [cyan]-[/] show dpi debug status [cyan]-[/] show datapath session dpi [cyan]-[/] show datapath dpi-classification-cache [cyan]-[/] show dpi-classification-cache

cencli tshoot ap-dpi [OPTIONS] [name|ip|mac|serial]

Options

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

ap-overlay

Show AP Overlay details

[cyan]Returns the output of the following commands useful in troubleshooting overlay AP / gateway tunnels.[/]

[cyan]-[/] show ata endpoint [cyan]-[/] show show overlay tunnel config [cyan]-[/] show overlay ssid-cluster status

cencli tshoot ap-overlay [OPTIONS] [name|ip|mac|serial]

Options

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

command

[cyan]Send a user provided troubleshooting commands to a device and wait for results.[/]

Returns response (from device) to troubleshooting commands. Commands must be supported by the API, use [cyan]show tshoot commands <dev-type>[/] to see available commands

cencli tshoot command [OPTIONS] [name|ip|mac|serial] CMD...

Options

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

CMD: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

inventory

Show Inventory (valid on Gateways)

cencli tshoot inventory [OPTIONS] [name|ip|mac|serial]

Options

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

ping

Ping a host from a Central managed device

cencli tshoot ping [OPTIONS] [name|ip|mac|serial] HOST

Options

-m: ping using VRF mgmt, (only applies to cx)

-r <repititions>: repititions (only applies to switches)

--out <outfile>: Output to file (and terminal)

--pager

Enable Paged Output

Default: False

-vv: Show raw response (no formatting but still honors –yaml, –csv … if provided)

-d: Use default central account

--debug

Enable Additional Debug Logging

Default: False

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

HOST: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

unarchive

unacrchive devices.

Remove previously archived devices from archive.

Specify device by serial. (archived devices will not be in Inventory cache for name lookup)

cencli unarchive [OPTIONS] [name|ip|mac|serial] ... (multiple allowed)

Options

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

unassign

Unassign licenses / labels

cencli unassign [OPTIONS] COMMAND [ARGS]...

label

Unassign label from device(s)

cencli unassign label [OPTIONS] LABEL DEVICES...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

LABEL: Required argument

DEVICES: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

license

Unssign Licenses from devices by serial number(s) or disable auto-subscribe for the license type.

cencli unassign license [OPTIONS]
                        LICENSE:{advance-70xx|advance-72xx|advance-90xx-
                        sec|advance-base-7005|advanced-ap|advanced-
                        switch-6100|advanced-switch-6200|advanced-
                        switch-6300|advanced-switch-6400|advanced-switch-8400|
                        dm|foundation-70xx|foundation-72xx|foundation-90xx-
                        sec|foundation-ap|foundation-base-7005|foundation-
                        base-90xx-sec|foundation-switch-6100|foundation-
                        switch-6200|foundation-switch-6300|foundation-
                        switch-6400|foundation-switch-8400|foundation-wlan-
                        gw|vgw2g|vgw4g|vgw500m} [name|ip|mac|serial] ...
                        (multiple allowed)

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

LICENSE: Required argument

[name|ip|mac|serial] ... (multiple allowed): Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

update

Update existing Aruba Central objects.

cencli update [OPTIONS] COMMAND [ARGS]...

config

Update group, device level config (ap or gw) or cencli config.

cencli update config [OPTIONS] GROUP|DEVICE CLI_FILE [VAR_FILE]

Options

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--gw: Show group level config for gateways.

--ap: Show group level config for APs.

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

GROUP|DEVICE: Required argument

CLI_FILE: Required argument

VAR_FILE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

group

Update group properties.

cencli update group [OPTIONS] [GROUP NAME]

Options

--wired-tg: Manage switch configurations via templates

--wlan-tg: Manage AP configurations via templates

--gw-role <gw_role>

Options: branch | vpnc | wlan

--aos10: Create AOS10 Group (default AOS8/IAP)

--mb: Configure Group for MicroBranch APs (AOS10 only

--ap: Allow APs in group

--sw: Allow ArubaOS-SW switches in group.

--cx: Allow ArubaOS-CX switches in group.

--gw: Allow gateways in group. If No device types specified all are allowed.

--mo-sw, --no-mo-sw: Monitor Only for ArubaOS-SW

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP NAME]: Required argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_VERBOSE_DEBUG: Provide a default for --debugv

ARUBACLI_ACCOUNT: Provide a default for --account

site

[bright_green]Update details for an existing site.[/]

Provide [cyan]geo-loc[/] or [cyan]address[/] details, not both. [italic]Google Maps “Plus Codes” are supported for address field.[/]

If address is provided assoicated geo coordinates are automatically populated. If geo coordinates are provided, any address associated with the site is cleared.

[italic green3]Wrap Arguments that contain spaces in quotes i.e. “5402 Champions Hill Dr”[/]

cencli update site [OPTIONS] SITE_NAME [ADDRESS] [CITY] [STATE] [ZIPCODE]
                   [COUNTRY]

Options

--new-name <new_name>: Change Site Name

--lat <LATITUDE>

--lon <LONGITUDE>

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

--debug

Enable Additional Debug Logging

Default: False

Arguments

SITE_NAME: Required argument

ADDRESS: Optional argument

CITY: Optional argument

STATE: Optional argument

ZIPCODE: Optional argument

COUNTRY: Optional argument

Environment variables

ARUBACLI_ACCOUNT: Provide a default for --account

ARUBACLI_DEBUG: Provide a default for --debug

template

Update an existing template

cencli update template [OPTIONS] IDENTIFIER [TEMPLATE]

Options

--group <group>: The template group the template belongs to

--dev-type <device_type>

Filter by Device Type

Options: ap | sw | cx | gw

--version <version>: [Templates] Filter by version

--model <model>: [Templates] Filter by model

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

IDENTIFIER: Required argument

TEMPLATE: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

variables

Update existing or add new Variables for a device/template

cencli update variables [OPTIONS] [name|ip|mac|serial] VAR_VALUE...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

VAR_VALUE: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

webhook

Update webhook details (name/urls)

cencli update webhook [OPTIONS] WID NAME URLS...

Options

-Y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

WID: Required argument

NAME: Required argument

URLS: Required argument(s)

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

upgrade

Upgrade Firmware

cencli upgrade [OPTIONS] COMMAND [ARGS]...

device

Upgrade firmware on a specific device

cencli upgrade device [OPTIONS] [name|ip|mac|serial] [VERSION]

Options

--at <at>: When to schedule upgrade. format: ‘mm/dd/yyyy_hh:mm’ or ‘dd_hh:mm’ (implies current month) [default: Now]

-R

Automatically reboot device after firmware download (APs will reboot regardless)

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

VERSION: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

group

Update devices by group.

Device type must be provided. For switches you can/should filter to a specific switch model via the –model flag.

cencli upgrade group [OPTIONS] [GROUP NAME] [VERSION]

Options

--at <at>: When to schedule upgrade. format: ‘mm/dd/yyyy hh:mm’ or ‘dd hh:mm’ (implies current month) [Default: Now]

--dev-type <dev_type>

Required Upgrade a specific device type

Options: ap | sw | cx | gw | switch

--model <model>: [applies to switches only] Upgrade a specific switch model

-R

Automatically reboot device after firmware download (APs will reboot regardless)

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[GROUP NAME]: Required argument

VERSION: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account

swarm

Upgrade firmware for an IAP cluster

cencli upgrade swarm [OPTIONS] [name|ip|mac|serial] [VERSION]

Options

--at <at>: When to schedule upgrade. format: ‘mm/dd/yyyy hh:mm’ or ‘dd hh:mm’ (implies current month) [Default: Now]

-R

Automatically reboot device after firmware download

Default: False

-Y, -y

Bypass confirmation prompts - Assume Yes

Default: False

--debug

Enable Additional Debug Logging

Default: False

-d: Use default central account

--account <account>

The Aruba Central Account to use (must be defined in the config)

Default: central_info

Arguments

[name|ip|mac|serial]: Required argument

VERSION: Optional argument

Environment variables

ARUBACLI_DEBUG: Provide a default for --debug

ARUBACLI_ACCOUNT: Provide a default for --account