# Aruba Central API CLI
[](https://pypi.org/project/centralcli)
[](https://central-api-cli.readthedocs.io/en/latest/?badge=latest)
[](https://pepy.tech/project/centralcli)
[](https://pypi.org/project/centralcli/)
[](https://lbesson.mit-license.org/)
A CLI app for interacting with Aruba Central Cloud Management Platform. With cross-platform shell support. Auto Completion, easy device/site/group/template identification (fuzzy match), support for batch import, and a lot more.
> As commands are built out the CLI hierarchy may evolve. Refer to the [documentation](https://central-api-cli.readthedocs.org) or help text for CLI structure/syntax.
## Features
- Cross Platform Support
- Auto/TAB Completion
- Specify device, site, etc. by fuzzy match of multiple fields (i.e. name, mac, serial#, ip address)
- Multiple output formats
- Output to file
- Numerous import formats (csv, yaml, json, etc.)
- Multiple account support (easily switch between different central accounts `--account myotheraccount`)
- Batch Operation based on data from input file. i.e. Add sites in batch based on data from a csv.
- Automatic Token refresh. With prompt to paste in a new token if it becomes invalid.
> If using Tokens, dedicate the token to the CLI alone, using it in swagger or on another system, will eventually lead to a refresh that invalidates the tokens on the other systems using it.
- You can also use username/Password Auth. which will facilitate automatic retrieval of new Tokens even if they do become invalid.
## Installation
Requires python 3.8+ and pip
> Use `python3 -V` to determine version, but pip won't allow it to install if Python is not >= 3.8
### simple
```shell
# On Debian based system if pip is not a recognized command
sudo apt install python3-pip
# Install centralcli
pip install centralcli
# optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.
pip install centralcli[speedups]
```
### ideal
> It's ideal to install in a virtual environment (venv) on *nix based systems. A virtualenv is an isolated environment. This is prefered as it avoids any potential package conflicts with any system executables that use the system-wide python. When installing in a venv some steps have to be taken to ensure the venv is in PATH so `cencli` is a recognized command, and tab completion is retained. The venv either needs to be activated or the venv/bin directory needs to be added to PATH for completion to work. If this is something foriegn to you, you can install pipx which is like pip but installs packages in virtual environments and automatically takes care of the rest.
**Option 1 via pipx:**
> The first section below is for Debian based systems refer to [pipx documentation](https://pipx.pypa.io/stable/installation/) for instructions on other OSs.
```shell
# install pipx (Debian)
sudo apt update
sudo apt install pipx
pipx ensurepath
sudo pipx ensurepath --global # optional refer to pipx docs
# install central CLI
pipx install centralcli --include-deps
# optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.
pipx install centralcli[speedups] --force # force if centralcli was already installed and you are just adding speedups
```
**Option 2 manual installation in a venv:**
> The example below is for Debian based systems, where `apt` is referenced but should be easy to translate to other OSs given you have some familiarity with the package management commands (i.e. `dnf`). On Windows python should install with pip. The pip commands are still valid.
```shell
# (Debian) If you don't have pip
sudo apt update
sudo apt install python3-pip
# Install virtualenv
python3 -m pip install virtualenv # Alternatively on Debian based systems: 'sudo apt install python3-virtualenv'
# create a directory to store the venv in
cd ~ # ensure you are in your home dir
mkdir .venvs # creates hidden .venvs dir to store venv in
cd .venvs # change to that directory
export DEB_PYTHON_INSTALL_LAYOUT='deb' # Just ensures the directory structure for simpler instructions (Ubuntu 22.04 changed the dir layout of venvs without it)
python3 -m virtualenv centralcli --prompt cencli # prompt is optional
source centralcli/bin/activate # activates the venv
# Install centralcli
pip install centralcli
# optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.
pip install centralcli[speedups]
which centralcli # Should return ~/.venvs/centralcli/bin/centralcli
# for BASH shell Update .bashrc to update PATH on login (keep the single quotes)
echo 'export PATH="$PATH:$HOME/.venvs/centralcli/bin"' >> ~/.bashrc
# for zsh or others, do the equivalent... i.e. update .zshrc in a similar manner
```
### Upgrading the CLI
`pip3 install -U centralcli`
### if you don't have python
- You can get it for any platform @ [https://www.python.org](https://www.python.org)
- On Windows 10 it's also available in the Windows store.
## Configuration
✨ pre-populating the config as described below is optional. Central CLI will prompt for the information it needs on first run if no config exists.
> It's still a good idea to look over the example config to see the optional config items.
Refer to [config.yaml.example](https://github.com/Pack3tL0ss/central-api-cli/blob/master/config/config.yaml.example) to guide in the creation of config.yaml and place in the config directory.
Central CLI will look in \<Users home dir\>/.config/centralcli, and \<Users home dir\>\\.centralcli.
i.e. on Windows `c:\Users\wade\.centralcli` or on Linux `/home/wade/.config/centralcli`
Once `config.yaml` is populated per [config.yaml.example](https://github.com/Pack3tL0ss/central-api-cli/blob/master/config/config.yaml.example), run some test commands to validate the config.
For Example `cencli show all`
```bash
wade@wellswa6:~ $ cencli show all
All Devices
─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
name type model ip mac serial group site labels version status
─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
6100F-48-LAB cx 6100 48G CL4 4SFP+ Swch 10.0.40.11 --redacted-- --redacted-- WadeLab8x 10.08.1010 Down
(JL675A)
SDBranch1:7008 gw A7008 192.168.240.101 --redacted-- --redacted-- Branch1 Antigua Branch View 10.3.0.0_82528 Up
br1-2930F-sw sw Aruba2930F-8G-PoE+-2SFP+ 10.101.5.4 --redacted-- --redacted-- Branch1 Antigua Branch View 16.11.0002 Up
Switch(JL258A)
br1-315.0c88-ap ap 315 10.101.6.200 --redacted-- --redacted-- Branch1 Antigua Branch View 10.3.0.0_82528 Up
MB1-505h ap 505H 10.10.1.101 --redacted-- --redacted-- MicroBranch1 Champions Hill 10.3.0.0_82528 Up
6200F-Bot cx 6200F 48G CL4 4SFP+740W Swch 10.0.40.16 --redacted-- --redacted-- WadeLab8x Pommore 10.08.1010 Down
(JL728A)
6200F-Top cx 6200F 48G CL4 4SFP+740W Swch 10.0.40.6 --redacted-- --redacted-- WadeLab8x Pommore 10.08.1010 Down
(JL728A)
APGW1 gw A9004-LTE 10.0.35.10 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up
APGW2 gw A9004 10.0.35.20 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up
VPNC1 gw A7005 172.30.0.242 --redacted-- --redacted-- VPNC WadeLab Branch View 10.3.0.0_82528 Up
VPNC2 gw A7005 172.30.0.243 --redacted-- --redacted-- VPNC WadeLab Branch View 10.3.0.0_82528 Up
av-555.11b8-ap ap 555 10.0.31.155 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
barn-303p.2c30-ap ap 303P 10.1.30.151 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up
barn-4100i cx 4100i 12G CL4/6 POE 2SFP+ DIN 10.1.30.152 --redacted-- --redacted-- WadeLab WadeLab 10.08.1010 Up
Sw (JL817A)
barn-518.2816-ap ap 518 10.1.30.101 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up
bsmt-515.51s9-ap ap 515 10.0.30.233 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
craft-2930F sw Aruba2930F-8G-PoE+-2SFP+ 10.0.30.5 --redacted-- --redacted-- WadeLab WadeLab 16.11.0002 Up
Switch(JL258A)
garage-345.5136-ap ap 345 10.0.31.148 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
ktcn-505H.206c-ap ap 505H 10.0.30.212 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
lwrptio-575.0824-ap ap 575 10.0.30.219 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
zrm-535.70be-ap ap 535 10.0.31.101 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down
─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
Show all displays fields common to all device types. To see all columns for a given device type use show <DEVICE TYPE>
API Rate Limit: 925 of 1000 remaining.
```
Use `cencli ?` to become familiar with the command options.
### Auto Completion
The CLI supports auto-completion. To configure auto-completion run `cencli --install-completion`. This will auto-detect the type of shell you are running in, and install the necessary completion into your profile. You'll need to exit the shell and start a new session for it to take effect.
> Note for OSX 11: Additional step, edit .zshrc and add "autoload -Uz compinit && compinit -i" then exit and start new session.
## Usage Notes
### Caching & Friendly identifiers
- Caching: The CLI caches information on all devices, sites, groups and templates along with some other items. It's a minimal amount per device, and is done to allow human friendly identifiers. The API typically accepts serial #, site id, etc. This function allows you to specify a device by name, IP, mac (any format), and serial.
The lookup sequence for a device:
1. Exact Match of any of the identifier fields (name, ip, mac, serial)
2. case insensitive match
3. case insensitive match disregarding all hyphens and underscores (in case you type 6200f_bot and the device name is 6200F-Bot)
4. Case insensitive Fuzzy match with implied wild-card, otherwise match any devices that start with the identifier provided. `cencli show switches 6200F` will result in a match of `6200F-Bot`.
5. If a typo was made, and an item is a close match, you will be prompted to confirm that's what you meant.
> If there is no match found, a cache update is triggered, and the match rules are re-tried.
- Caching works in a similar manner for groups, templates, and sites. Sites can match on name and nearly any address field. So if you only had one site in San Antonio you could specify that site with `show sites 'San Antonio'` \<-- Note the use of quotes because there is a space in the name.
- **Multiple Matches**: If a provided identifier is ambiguous, meaning there are multiple matches. You will be prompted to select the intended device from a list of the matches.
### Output Formats
There are a number of output formats available. Most commands default to what is likely the easiest to view given the number of fields. Otherwise longer outputs are typically displayed vertically by default. If the output can reasonably fit, it's displayed in tabular format horizontally.
You can specify the output format with command line flags `--json`, `--yaml`, `--csv`, `--table` rich is tabular format with folding (multi line within the same row) and truncating.
> Most outputs will evolve to support an output with the most commonly desired fields by default and expanded vertical output via the `-v` option (not implemented yet.). Currently the output is tabular horizontally if the amount of data is likely to fit most displays, and vertical otherwise.
### File Output
Just use `--out \<filename\>` (or \<path\\filename\>), and specify the desired format.
## CLI Tree
Use `?` or `--help` from the cli, which you can do at any level. `ccenli ?`, `cencli bounce --help` etc.
You can also see the entire supported tree via the [CLI Reference Guide](https://central-api-cli.readthedocs.io/en/latest/cli.html).
*NOTE: The Reference Guide documents a few commands that are hidden in the CLI*
Raw data
{
"_id": null,
"home_page": "https://github.com/Pack3tL0ss/central-api-cli",
"name": "centralcli",
"maintainer": "Wade Wells (Pack3tL0ss)",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "wade@consolepi.org",
"keywords": "cli, Aruba, Aruba Networks, Aruba Central, HPE, API, RESTFUL, REST",
"author": "Wade Wells (Pack3tL0ss)",
"author_email": "wade@consolepi.org",
"download_url": "https://files.pythonhosted.org/packages/1a/53/3ca38bfd432f15b634eeccedf43ba8d1c8104fdc2355cc0613a89cd81345/centralcli-7.3.0.tar.gz",
"platform": null,
"description": "# Aruba Central API CLI\n\n[](https://pypi.org/project/centralcli)\n[](https://central-api-cli.readthedocs.io/en/latest/?badge=latest)\n[](https://pepy.tech/project/centralcli)\n[](https://pypi.org/project/centralcli/)\n[](https://lbesson.mit-license.org/)\n\nA CLI app for interacting with Aruba Central Cloud Management Platform. With cross-platform shell support. Auto Completion, easy device/site/group/template identification (fuzzy match), support for batch import, and a lot more.\n\n > As commands are built out the CLI hierarchy may evolve. Refer to the [documentation](https://central-api-cli.readthedocs.org) or help text for CLI structure/syntax.\n\n\n\n## Features\n\n- Cross Platform Support\n- Auto/TAB Completion\n- Specify device, site, etc. by fuzzy match of multiple fields (i.e. name, mac, serial#, ip address)\n- Multiple output formats\n- Output to file\n- Numerous import formats (csv, yaml, json, etc.)\n- Multiple account support (easily switch between different central accounts `--account myotheraccount`)\n- Batch Operation based on data from input file. i.e. Add sites in batch based on data from a csv.\n- Automatic Token refresh. With prompt to paste in a new token if it becomes invalid.\n > If using Tokens, dedicate the token to the CLI alone, using it in swagger or on another system, will eventually lead to a refresh that invalidates the tokens on the other systems using it.\n- You can also use username/Password Auth. which will facilitate automatic retrieval of new Tokens even if they do become invalid.\n\n## Installation\n\nRequires python 3.8+ and pip\n> Use `python3 -V` to determine version, but pip won't allow it to install if Python is not >= 3.8\n\n### simple\n\n```shell\n# On Debian based system if pip is not a recognized command\nsudo apt install python3-pip\n\n# Install centralcli\npip install centralcli\n\n# optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.\npip install centralcli[speedups]\n```\n\n### ideal\n> It's ideal to install in a virtual environment (venv) on *nix based systems. A virtualenv is an isolated environment. This is prefered as it avoids any potential package conflicts with any system executables that use the system-wide python. When installing in a venv some steps have to be taken to ensure the venv is in PATH so `cencli` is a recognized command, and tab completion is retained. The venv either needs to be activated or the venv/bin directory needs to be added to PATH for completion to work. If this is something foriegn to you, you can install pipx which is like pip but installs packages in virtual environments and automatically takes care of the rest.\n\n**Option 1 via pipx:**\n\n> The first section below is for Debian based systems refer to [pipx documentation](https://pipx.pypa.io/stable/installation/) for instructions on other OSs.\n ```shell\n # install pipx (Debian)\n sudo apt update\n sudo apt install pipx\n pipx ensurepath\n sudo pipx ensurepath --global # optional refer to pipx docs\n\n # install central CLI\n pipx install centralcli --include-deps\n\n # optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.\n pipx install centralcli[speedups] --force # force if centralcli was already installed and you are just adding speedups\n ```\n\n**Option 2 manual installation in a venv:**\n\n> The example below is for Debian based systems, where `apt` is referenced but should be easy to translate to other OSs given you have some familiarity with the package management commands (i.e. `dnf`). On Windows python should install with pip. The pip commands are still valid.\n ```shell\n # (Debian) If you don't have pip\n sudo apt update\n sudo apt install python3-pip\n\n # Install virtualenv\n python3 -m pip install virtualenv # Alternatively on Debian based systems: 'sudo apt install python3-virtualenv'\n\n # create a directory to store the venv in\n cd ~ # ensure you are in your home dir\n mkdir .venvs # creates hidden .venvs dir to store venv in\n cd .venvs # change to that directory\n export DEB_PYTHON_INSTALL_LAYOUT='deb' # Just ensures the directory structure for simpler instructions (Ubuntu 22.04 changed the dir layout of venvs without it)\n python3 -m virtualenv centralcli --prompt cencli # prompt is optional\n source centralcli/bin/activate # activates the venv\n\n # Install centralcli\n pip install centralcli\n\n # optional install speedups for centralcli (this pulls in additional optional dependencies, that can improve performance.) Minimal impact in most scenarios.\n pip install centralcli[speedups]\n\n which centralcli # Should return ~/.venvs/centralcli/bin/centralcli\n\n # for BASH shell Update .bashrc to update PATH on login (keep the single quotes)\n echo 'export PATH=\"$PATH:$HOME/.venvs/centralcli/bin\"' >> ~/.bashrc\n\n # for zsh or others, do the equivalent... i.e. update .zshrc in a similar manner\n ```\n\n### Upgrading the CLI\n\n`pip3 install -U centralcli`\n\n### if you don't have python\n\n- You can get it for any platform @ [https://www.python.org](https://www.python.org)\n- On Windows 10 it's also available in the Windows store.\n\n## Configuration\n\u2728 pre-populating the config as described below is optional. Central CLI will prompt for the information it needs on first run if no config exists.\n> It's still a good idea to look over the example config to see the optional config items.\n\nRefer to [config.yaml.example](https://github.com/Pack3tL0ss/central-api-cli/blob/master/config/config.yaml.example) to guide in the creation of config.yaml and place in the config directory.\n\nCentral CLI will look in \\<Users home dir\\>/.config/centralcli, and \\<Users home dir\\>\\\\.centralcli.\ni.e. on Windows `c:\\Users\\wade\\.centralcli` or on Linux `/home/wade/.config/centralcli`\n\nOnce `config.yaml` is populated per [config.yaml.example](https://github.com/Pack3tL0ss/central-api-cli/blob/master/config/config.yaml.example), run some test commands to validate the config.\n\nFor Example `cencli show all`\n\n```bash\nwade@wellswa6:~ $ cencli show all\n All Devices\n \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n name type model ip mac serial group site labels version status\n \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n 6100F-48-LAB cx 6100 48G CL4 4SFP+ Swch 10.0.40.11 --redacted-- --redacted-- WadeLab8x 10.08.1010 Down\n (JL675A)\n SDBranch1:7008 gw A7008 192.168.240.101 --redacted-- --redacted-- Branch1 Antigua Branch View 10.3.0.0_82528 Up\n br1-2930F-sw sw Aruba2930F-8G-PoE+-2SFP+ 10.101.5.4 --redacted-- --redacted-- Branch1 Antigua Branch View 16.11.0002 Up\n Switch(JL258A)\n br1-315.0c88-ap ap 315 10.101.6.200 --redacted-- --redacted-- Branch1 Antigua Branch View 10.3.0.0_82528 Up\n MB1-505h ap 505H 10.10.1.101 --redacted-- --redacted-- MicroBranch1 Champions Hill 10.3.0.0_82528 Up\n 6200F-Bot cx 6200F 48G CL4 4SFP+740W Swch 10.0.40.16 --redacted-- --redacted-- WadeLab8x Pommore 10.08.1010 Down\n (JL728A)\n 6200F-Top cx 6200F 48G CL4 4SFP+740W Swch 10.0.40.6 --redacted-- --redacted-- WadeLab8x Pommore 10.08.1010 Down\n (JL728A)\n APGW1 gw A9004-LTE 10.0.35.10 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up\n APGW2 gw A9004 10.0.35.20 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up\n VPNC1 gw A7005 172.30.0.242 --redacted-- --redacted-- VPNC WadeLab Branch View 10.3.0.0_82528 Up\n VPNC2 gw A7005 172.30.0.243 --redacted-- --redacted-- VPNC WadeLab Branch View 10.3.0.0_82528 Up\n av-555.11b8-ap ap 555 10.0.31.155 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n barn-303p.2c30-ap ap 303P 10.1.30.151 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up\n barn-4100i cx 4100i 12G CL4/6 POE 2SFP+ DIN 10.1.30.152 --redacted-- --redacted-- WadeLab WadeLab 10.08.1010 Up\n Sw (JL817A)\n barn-518.2816-ap ap 518 10.1.30.101 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82528 Up\n bsmt-515.51s9-ap ap 515 10.0.30.233 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n craft-2930F sw Aruba2930F-8G-PoE+-2SFP+ 10.0.30.5 --redacted-- --redacted-- WadeLab WadeLab 16.11.0002 Up\n Switch(JL258A)\n garage-345.5136-ap ap 345 10.0.31.148 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n ktcn-505H.206c-ap ap 505H 10.0.30.212 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n lwrptio-575.0824-ap ap 575 10.0.30.219 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n zrm-535.70be-ap ap 535 10.0.31.101 --redacted-- --redacted-- WLNET WadeLab 10.3.0.0_82463 Down\n \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n Show all displays fields common to all device types. To see all columns for a given device type use show <DEVICE TYPE>\n API Rate Limit: 925 of 1000 remaining.\n\n```\n\nUse `cencli ?` to become familiar with the command options.\n\n### Auto Completion\n\nThe CLI supports auto-completion. To configure auto-completion run `cencli --install-completion`. This will auto-detect the type of shell you are running in, and install the necessary completion into your profile. You'll need to exit the shell and start a new session for it to take effect.\n> Note for OSX 11: Additional step, edit .zshrc and add \"autoload -Uz compinit && compinit -i\" then exit and start new session.\n\n## Usage Notes\n\n### Caching & Friendly identifiers\n\n- Caching: The CLI caches information on all devices, sites, groups and templates along with some other items. It's a minimal amount per device, and is done to allow human friendly identifiers. The API typically accepts serial #, site id, etc. This function allows you to specify a device by name, IP, mac (any format), and serial.\n\nThe lookup sequence for a device:\n\n 1. Exact Match of any of the identifier fields (name, ip, mac, serial)\n 2. case insensitive match\n 3. case insensitive match disregarding all hyphens and underscores (in case you type 6200f_bot and the device name is 6200F-Bot)\n 4. Case insensitive Fuzzy match with implied wild-card, otherwise match any devices that start with the identifier provided. `cencli show switches 6200F` will result in a match of `6200F-Bot`.\n 5. If a typo was made, and an item is a close match, you will be prompted to confirm that's what you meant.\n\n> If there is no match found, a cache update is triggered, and the match rules are re-tried.\n\n- Caching works in a similar manner for groups, templates, and sites. Sites can match on name and nearly any address field. So if you only had one site in San Antonio you could specify that site with `show sites 'San Antonio'` \\<-- Note the use of quotes because there is a space in the name.\n\n- **Multiple Matches**: If a provided identifier is ambiguous, meaning there are multiple matches. You will be prompted to select the intended device from a list of the matches.\n\n### Output Formats\n\nThere are a number of output formats available. Most commands default to what is likely the easiest to view given the number of fields. Otherwise longer outputs are typically displayed vertically by default. If the output can reasonably fit, it's displayed in tabular format horizontally.\n\nYou can specify the output format with command line flags `--json`, `--yaml`, `--csv`, `--table` rich is tabular format with folding (multi line within the same row) and truncating.\n\n> Most outputs will evolve to support an output with the most commonly desired fields by default and expanded vertical output via the `-v` option (not implemented yet.). Currently the output is tabular horizontally if the amount of data is likely to fit most displays, and vertical otherwise.\n\n### File Output\n\nJust use `--out \\<filename\\>` (or \\<path\\\\filename\\>), and specify the desired format.\n\n## CLI Tree\n\nUse `?` or `--help` from the cli, which you can do at any level. `ccenli ?`, `cencli bounce --help` etc.\n\nYou can also see the entire supported tree via the [CLI Reference Guide](https://central-api-cli.readthedocs.io/en/latest/cli.html).\n*NOTE: The Reference Guide documents a few commands that are hidden in the CLI*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI for interacting with Aruba Central (Cloud Management Platform). Facilitates bulk imports, exports, reporting. A handy tool if you have devices managed by Aruba Central.",
"version": "7.3.0",
"project_urls": {
"Documentation": "https://central-api-cli.readthedocs.org",
"Homepage": "https://github.com/Pack3tL0ss/central-api-cli",
"Repository": "https://github.com/Pack3tL0ss/central-api-cli"
},
"split_keywords": [
"cli",
" aruba",
" aruba networks",
" aruba central",
" hpe",
" api",
" restful",
" rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57db0c5105a99d7306a0df49084bf18bff610265de59f3c6c03fa8b8c19938ab",
"md5": "28ed1c05edd7e5aefb9ea6d7837c57b0",
"sha256": "62b097ed9ee5b749a31531cd2254e4d497d238be765003b7bdb9c8a39717c50a"
},
"downloads": -1,
"filename": "centralcli-7.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28ed1c05edd7e5aefb9ea6d7837c57b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 545678,
"upload_time": "2024-11-16T07:00:50",
"upload_time_iso_8601": "2024-11-16T07:00:50.069099Z",
"url": "https://files.pythonhosted.org/packages/57/db/0c5105a99d7306a0df49084bf18bff610265de59f3c6c03fa8b8c19938ab/centralcli-7.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a533ca38bfd432f15b634eeccedf43ba8d1c8104fdc2355cc0613a89cd81345",
"md5": "2fa84922d7de12d301162d4f234574d8",
"sha256": "46e866e02a7bacc73bc4f14af154402d1a96992c3d687877765ebfda3a6946db"
},
"downloads": -1,
"filename": "centralcli-7.3.0.tar.gz",
"has_sig": false,
"md5_digest": "2fa84922d7de12d301162d4f234574d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 507038,
"upload_time": "2024-11-16T07:00:52",
"upload_time_iso_8601": "2024-11-16T07:00:52.414943Z",
"url": "https://files.pythonhosted.org/packages/1a/53/3ca38bfd432f15b634eeccedf43ba8d1c8104fdc2355cc0613a89cd81345/centralcli-7.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 07:00:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Pack3tL0ss",
"github_project": "central-api-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "centralcli"
}
JSON
