GreenLake Activate CLI

The purpose of this is to help manage devices in HPE GreenLake Activate with an easy to use CLI interface. This tool uses the available API calls that HPE GreenLake Activate exposes for manging devices

Features

• Query Activate inventory by:
  • device name
  • mac address
  • serial number
  • folder name
  • folder id
  • provisioning rules
• Move devices between folders
• Create folders in Activate
• Create provisioning rules for folders
• Generate CLI commands for CAP and RAP allowlist entries

Requirements

• Python 3.12 or newer
• An HPE GreenLake Activate API credential
• Network access to activate.arubanetworks.com

Installation

I recommend installing this package with uv. Install uv if it is not already available.

Installing uv on Linux/Mac:

curl -LsSf https://astral.sh/uv/install.sh | sh

Installing uv on Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

To install the latest published package as a global command:

uv tool install greenlake-activate-cli

Verify the installation:

glcli --version

To upgrade or remove the installed CLI:

uv tool upgrade greenlake-activate-cli
uv tool uninstall greenlake-activate-cli

Install With Python and pip

Creating a virtual environment and installing the package:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install greenlake-activate-cli

The glcli command is then available from the venv:

glcli --version

Configuration

Run the CLI glcli configure command.

glcli configure

You will be prompted to enter (paste) in your GreenLake Activate API token. This text is hidden.

This command is essentially doing this:

mkdir -p ~/.config/greenlake-activate-cli
printf 'CREDENTIAL_1=your_api_key_here\n' \
	> ~/.config/greenlake-activate-cli/.env
chmod 600 ~/.config/greenlake-activate-cli/.env

Alternatively, you can set the environment variable manually:

export CREDENTIAL_1="your_api_key_here"

Credential sources are checked in this order:

1. A non-empty CREDENTIAL_1 environment variable.
2. $XDG_CONFIG_HOME/greenlake-activate-cli/.env, when XDG_CONFIG_HOME is set.
3. ~/.config/greenlake-activate-cli/.env.
4. .env in the current directory, retained for development and backward compatibility.

The configuration file format is:

CREDENTIAL_1=<your_api_key_here>

Usage

Query inventory by serial number:

glcli query serial PHWLKAS02 PHWLKAS03

Query inventory by MAC address:

glcli query mac aa:bb:cc:00:11:22 dd:ee:ff:33:44:55

Query inventory by folder ID or folder name:

glcli query folder 5297450
glcli query folder SiteA-South

Query provisioning rules for one folder by ID or name:

glcli query rule folder-id 63111131
glcli query rule folder-name Northwest

Move a device by serial number or MAC address:

glcli move PHWLKAS02 SiteA-South
glcli move aa:bb:cc:00:11:22 5297450

Move multiple devices from a file:

glcli move serials serials.csv SiteA-South
glcli move macs mac_addresses.csv 5297450

Create a new folder in Activate:

glcli create folder Jake_test2

Create a provisioning rule for a folder by ID or name:

glcli create rule folder-id 63061537
glcli create rule folder-name Northwest

Generate allowlist commands for devices in a folder. The --text option allows you to generate a text file with the commands if you prefer.

Example:

glcli generate-allowlist cap folder SiteA-South
glcli generate-allowlist rap folder SiteA-South --description "Remote site"
glcli generate-allowlist cap folder SiteA-South --text

Generate allowlist commands from a CSV file:

glcli generate-allowlist cap file allowlist.csv
glcli generate-allowlist rap file allowlist.csv
glcli generate-allowlist rap file allowlist.csv --text

The CSV must have mac_address and ap_group headers. RAP files must also have a serial header. The optional description column applies to that row. For example:

mac_address,ap_group,serial,description
AA:BB:CC:00:11:22,remote,SN123,North site

The create rule command is strictly for creating provisioning rules. The command prompts for the rule name, provision type (cap or rap), controller IP, and AP group. Perhaps in the future, I'll add the ability to create notification rules.

Serial numbers and MAC addresses can also be loaded from CSV or newline-delimited files:

glcli query serial --file serials.csv
glcli query mac --file mac_addresses.csv

Use --verbose for diagnostic logging:

glcli --verbose query serial PHWLKAS02

Exit codes are 0 for a complete result, 1 when no devices are returned, and 2 when at least one requested identifier is missing.

Troubleshooting

When in doubt, restart your shell.

The installation with uv installs this package in an isolated environment and makes glcli available to run from any directory. If uv reports that its tool directory is not on your PATH, run:

uv tool update-shell

To run the tests for development:

uv run pytest

References

• GreenLake Activate API Documentation