greenlake-activate-cli 0.1.0__tar.gz

greenlake_activate_cli-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: greenlake-activate-cli
+Version: 0.1.0
+Summary: A CLI tool used to interact with HPE GreenLake Activate
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv>=1.2.3
+Requires-Dist: requests>=2.34.2
+Requires-Dist: rich>=15.0.0
+Requires-Dist: typer>=0.27.2
+
+# GreenLake Activate CLI
+
+The purpose of this is to help manage devices in HPE GreenLake Activate with an easy to use CLI interface.
+
+# Setup
+
+## Requirements
+
+- Python 3.14 or newer
+- An HPE GreenLake Activate API credential
+- Network access to `activate.arubanetworks.com`
+
+The CLI uses the following Python packages, which are installed automatically:
+
+- Typer
+- Requests
+- Rich
+- Python Dotenv
+
+## Install With uv
+
+[Install uv](https://docs.astral.sh/uv/getting-started/installation/) if it is not
+already available. For a published release, install the CLI as a global command:
+
+```sh
+uv tool install greenlake-activate-cli
+```
+
+This installs the CLI in an isolated environment and makes `glcli` available from
+any directory. If uv reports that its tool directory is not on your `PATH`, run:
+
+```sh
+uv tool update-shell
+```
+
+Restart your shell, then verify the installation:
+
+```sh
+glcli --help
+```
+
+To upgrade or remove the installed CLI:
+
+```sh
+uv tool upgrade greenlake-activate-cli
+uv tool uninstall greenlake-activate-cli
+```
+
+`pipx` is an alternative isolated installer:
+
+```sh
+pipx install greenlake-activate-cli
+```
+
+For development from a source checkout, clone the repository and run:
+
+```sh
+git clone <repository-url>
+cd greenlake_activate_cli
+uv sync
+```
+
+The `uv sync` command creates the project environment, installs the application and
+its dependencies, and makes the `glcli` command available through `uv run`:
+
+```sh
+uv run glcli --help
+```
+
+To install the development dependencies, including the test suite, use:
+
+```sh
+uv sync --dev
+```
+
+## Install With Python and pip
+
+Create a virtual environment, activate it, and install the project from the cloned
+repository:
+
+```sh
+python3.14 -m venv .venv
+. .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install .
+```
+
+The `glcli` command is then available directly:
+
+```sh
+glcli --help
+```
+
+## Configure Credentials
+
+The recommended configuration file is:
+
+```sh
+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
+```
+
+The CLI also accepts the environment variable directly:
+
+```sh
+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:
+
+```plain
+CREDENTIAL_1=<your_api_key_here>
+```
+
+Do not commit `.env` or share the credential. If no source contains `CREDENTIAL_1`,
+the CLI reports the supported locations and exits before sending an inventory query.
+
+# Usage
+
+Query inventory by serial number:
+
+```sh
+glcli query serial PHWLKAS02 PHWLKAS03
+```
+
+Query inventory by MAC address:
+
+```sh
+glcli query mac aa:bb:cc:00:11:22 dd:ee:ff:33:44:55
+```
+
+Query inventory by folder ID or folder name:
+
+```sh
+glcli query folder 5297450
+glcli query folder SiteA-South
+glcli query folder SiteA-South 5389522
+```
+
+Folder names are matched case-insensitively and exactly. Numeric values are treated
+as folder IDs. Folder names are resolved through Activate before the inventory query;
+unknown or ambiguous names are rejected. Folder queries currently accept positional
+values only and do not support `--file`.
+
+Serial numbers and MAC addresses can also be loaded from CSV or newline-delimited files:
+
+```sh
+glcli query serial --file serials.csv
+glcli query mac --file mac_addresses.csv
+```
+
+The file reader uses the first column. Serial files may use a `serial`, `serialNumber`,
+`serial_number`, `serial number`, or `sn` header.
+
+Use `--verbose` for diagnostic logging:
+
+```sh
+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.
+
+Run the offline tests with:
+
+```sh
+uv run pytest
+```

greenlake_activate_cli-0.1.0/README.md

@@ -0,0 +1,177 @@
+# GreenLake Activate CLI
+
+The purpose of this is to help manage devices in HPE GreenLake Activate with an easy to use CLI interface.
+
+# Setup
+
+## Requirements
+
+- Python 3.14 or newer
+- An HPE GreenLake Activate API credential
+- Network access to `activate.arubanetworks.com`
+
+The CLI uses the following Python packages, which are installed automatically:
+
+- Typer
+- Requests
+- Rich
+- Python Dotenv
+
+## Install With uv
+
+[Install uv](https://docs.astral.sh/uv/getting-started/installation/) if it is not
+already available. For a published release, install the CLI as a global command:
+
+```sh
+uv tool install greenlake-activate-cli
+```
+
+This installs the CLI in an isolated environment and makes `glcli` available from
+any directory. If uv reports that its tool directory is not on your `PATH`, run:
+
+```sh
+uv tool update-shell
+```
+
+Restart your shell, then verify the installation:
+
+```sh
+glcli --help
+```
+
+To upgrade or remove the installed CLI:
+
+```sh
+uv tool upgrade greenlake-activate-cli
+uv tool uninstall greenlake-activate-cli
+```
+
+`pipx` is an alternative isolated installer:
+
+```sh
+pipx install greenlake-activate-cli
+```
+
+For development from a source checkout, clone the repository and run:
+
+```sh
+git clone <repository-url>
+cd greenlake_activate_cli
+uv sync
+```
+
+The `uv sync` command creates the project environment, installs the application and
+its dependencies, and makes the `glcli` command available through `uv run`:
+
+```sh
+uv run glcli --help
+```
+
+To install the development dependencies, including the test suite, use:
+
+```sh
+uv sync --dev
+```
+
+## Install With Python and pip
+
+Create a virtual environment, activate it, and install the project from the cloned
+repository:
+
+```sh
+python3.14 -m venv .venv
+. .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install .
+```
+
+The `glcli` command is then available directly:
+
+```sh
+glcli --help
+```
+
+## Configure Credentials
+
+The recommended configuration file is:
+
+```sh
+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
+```
+
+The CLI also accepts the environment variable directly:
+
+```sh
+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:
+
+```plain
+CREDENTIAL_1=<your_api_key_here>
+```
+
+Do not commit `.env` or share the credential. If no source contains `CREDENTIAL_1`,
+the CLI reports the supported locations and exits before sending an inventory query.
+
+# Usage
+
+Query inventory by serial number:
+
+```sh
+glcli query serial PHWLKAS02 PHWLKAS03
+```
+
+Query inventory by MAC address:
+
+```sh
+glcli query mac aa:bb:cc:00:11:22 dd:ee:ff:33:44:55
+```
+
+Query inventory by folder ID or folder name:
+
+```sh
+glcli query folder 5297450
+glcli query folder SiteA-South
+glcli query folder SiteA-South 5389522
+```
+
+Folder names are matched case-insensitively and exactly. Numeric values are treated
+as folder IDs. Folder names are resolved through Activate before the inventory query;
+unknown or ambiguous names are rejected. Folder queries currently accept positional
+values only and do not support `--file`.
+
+Serial numbers and MAC addresses can also be loaded from CSV or newline-delimited files:
+
+```sh
+glcli query serial --file serials.csv
+glcli query mac --file mac_addresses.csv
+```
+
+The file reader uses the first column. Serial files may use a `serial`, `serialNumber`,
+`serial_number`, `serial number`, or `sn` header.
+
+Use `--verbose` for diagnostic logging:
+
+```sh
+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.
+
+Run the offline tests with:
+
+```sh
+uv run pytest
+```

greenlake_activate_cli-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "greenlake-activate-cli"
+version = "0.1.0"
+description = "A CLI tool used to interact with HPE GreenLake Activate"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "python-dotenv>=1.2.3",
+    "requests>=2.34.2",
+    "rich>=15.0.0",
+    "typer>=0.27.2",
+]
+
+[project.scripts]
+glcli = "glcli.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]

greenlake_activate_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

greenlake_activate_cli-0.1.0/src/glcli/activate_login.py

@@ -0,0 +1,67 @@
+import os
+import logging
+from pathlib import Path
+
+import requests
+from dotenv import dotenv_values
+
+logger = logging.getLogger(__name__)
+REQUEST_TIMEOUT = 30
+ENVIRONMENT_VARIABLE = "CREDENTIAL_1"
+
+
+def user_config_path() -> Path:
+    """Return the user-level configuration path for the current platform."""
+    config_home = os.environ.get("XDG_CONFIG_HOME")
+    if config_home:
+        return Path(config_home) / "greenlake-activate-cli" / ".env"
+    return Path.home() / ".config" / "greenlake-activate-cli" / ".env"
+
+
+def credential_config_paths() -> tuple[Path, Path]:
+    """Return user-level and project-local credential file paths."""
+    return user_config_path(), Path.cwd() / ".env"
+
+
+def load_credentials() -> str:
+    """Load credentials using environment, user config, then local config."""
+    credential = os.environ.get(ENVIRONMENT_VARIABLE, "").strip()
+    if credential:
+        return credential
+
+    user_path, local_path = credential_config_paths()
+    for path in (user_path, local_path):
+        if not path.is_file():
+            continue
+        credential = str(dotenv_values(path).get(ENVIRONMENT_VARIABLE) or "").strip()
+        if credential:
+            return credential
+
+    raise RuntimeError(
+        f"{ENVIRONMENT_VARIABLE} is not configured. Set it in the environment, "
+        f"or create {user_path} or {local_path} with {ENVIRONMENT_VARIABLE}=<token>."
+    )
+
+def create_activate_session(credential_1:str) -> requests.Session:
+    """Login and return session."""
+    if not credential_1:
+        raise RuntimeError("CREDENTIAL_1 is not configured")
+
+    login_url = "https://activate.arubanetworks.com/LOGIN"
+    login_data = {
+        'credential_0': "username",
+        'credential_1': credential_1
+    }
+    logger.debug("Attempting to authenticate to: %s", login_url)
+    session = requests.session()
+    response = session.post(login_url, data=login_data, timeout=REQUEST_TIMEOUT)
+
+    logger.debug("Login status code: %s", response.status_code)
+    if response.status_code != 200:
+        logger.error("Login failed: %s", response.text)
+        raise RuntimeError("Activate login failed")
+
+    logger.info("Authenticated to Activate")
+    logger.debug("Full login response: %s", response.text)
+
+    return session

greenlake_activate_cli-0.1.0/src/glcli/cli.py

@@ -0,0 +1,124 @@
+import logging
+from pathlib import Path
+
+import typer
+from glcli.activate_login import create_activate_session, load_credentials
+from glcli.data_parsing import parse_inventory_response
+from glcli.query_inventory import query_inventory, read_identifiers_from_file
+from glcli.query_folder import resolve_folder_ids
+from glcli.display_data import display_inventory_sn
+from rich.logging import RichHandler
+
+logger = logging.getLogger(__name__)
+app = typer.Typer(help="Interact with HPE GreenLake Activate via CLI.")
+query_app = typer.Typer(help="Query Activate inventory.")
+app.add_typer(query_app, name="query")
+
+def setup_logging(verbose: bool):
+    logging.basicConfig(
+        level=logging.DEBUG if verbose else logging.INFO,
+        format="%(levelname)s %(name)s: %(message)s" if verbose else "%(message)s",
+        handlers=[RichHandler(rich_tracebacks=True, show_path=verbose)],
+    )
+    logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+
+def _load_credential() -> str:
+    try:
+        return load_credentials()
+    except RuntimeError as exc:
+        typer.echo(f"Error: {exc}", err=True)
+        raise typer.Exit(code=1) from exc
+
+def _query(identifier_type: str, identifiers: list[str], file: Path | None = None) -> None:
+    if file is not None:
+        identifiers = read_identifiers_from_file(file, identifier_type)
+
+    identifiers = [identifier.strip().upper() for identifier in identifiers if identifier.strip()]
+    if not identifiers:
+        raise typer.BadParameter("At least one identifier is required")
+
+    identifiers = list(dict.fromkeys(identifiers))
+    credential = _load_credential()
+    try:
+        session = create_activate_session(credential)
+        query_result, missing = query_inventory(session, identifier_type, identifiers)
+    finally:
+        if "session" in locals():
+            session.close()
+
+    extracted_data = parse_inventory_response(query_result)
+
+    if missing:
+        print(f"Not found: ({len(missing)}): {', '.join(missing)}")
+
+    display_inventory_sn(extracted_data)
+
+    if not extracted_data:
+        raise typer.Exit(code=1)
+    if missing:
+        raise typer.Exit(code=2)
+
+
+def _query_folder(values: list[str]) -> None:
+    values = [value.strip() for value in values if value.strip()]
+    if not values:
+        raise typer.BadParameter("At least one folder ID or name is required")
+
+    values = list(dict.fromkeys(values))
+    credential = _load_credential()
+    session = None
+    try:
+        session = create_activate_session(credential)
+        try:
+            folder_ids = resolve_folder_ids(session, values)
+        except ValueError as exc:
+            raise typer.BadParameter(str(exc)) from exc
+        query_result, missing = query_inventory(session, "folder", folder_ids)
+    finally:
+        if session is not None:
+            session.close()
+
+    extracted_data = parse_inventory_response(query_result)
+    display_inventory_sn(extracted_data)
+
+    if not extracted_data:
+        raise typer.Exit(code=1)
+
+
+@app.callback()
+def main_callback(
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="Enable debugging output to console."),
+) -> None:
+    setup_logging(verbose)
+
+
+@query_app.command("serial")
+def query_serial(
+    serials: list[str] | None = typer.Argument(None, metavar="SERIAL"),
+    file: Path | None = typer.Option(None, "--file", "-f", help="CSV or text file containing serial numbers."),
+) -> None:
+    _query("serial", serials or [], file)
+
+
+@query_app.command("mac")
+def query_mac(
+    macs: list[str] | None = typer.Argument(None, metavar="MAC"),
+    file: Path | None = typer.Option(None, "--file", "-f", help="CSV or text file containing MAC addresses."),
+) -> None:
+    _query("mac", macs or [], file)
+
+
+@query_app.command("folder")
+def query_folder(
+    folders: list[str] = typer.Argument(..., metavar="FOLDER_ID_OR_NAME"),
+) -> None:
+    _query_folder(folders)
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()

greenlake_activate_cli-0.1.0/src/glcli/data_parsing.py

@@ -0,0 +1,45 @@
+import json
+import logging
+
+logger = logging.getLogger(__name__)
+
+def parse_inventory_response(response:str) -> list[dict]:
+    """Function to extract the data that I want to get from Activate."""
+
+    try:
+        json_obj = json.loads(response)
+    except json.JSONDecodeError as exc:
+        raise ValueError("Inventory response is not valid JSON") from exc
+
+    if not isinstance(json_obj, dict):
+        raise ValueError("Inventory response must be a JSON object")
+
+    extracted_data: list[dict] = [] # each device is a dictionary
+    devices = json_obj.get("devices")
+
+    if isinstance(devices, list):
+       for device in devices:
+          if not isinstance(device, dict):
+              continue
+
+          serial = device.get("serialNumber")
+          mac = device.get("mac")
+          status = device.get("status")
+          additional_data = device.get("additionalData")
+          if not isinstance(additional_data, dict):
+              additional_data = {}
+          folder = additional_data.get("folder")
+          folder_id = additional_data.get("folderId")
+
+          device_dict = {
+              "serial":serial,
+              "mac":mac,
+              "status":status,
+              "folder":folder,
+              "folderId":folder_id,
+
+          }
+          extracted_data.append(device_dict)
+
+    logger.debug("Extracted data:\n%s", extracted_data)
+    return extracted_data

greenlake_activate_cli-0.1.0/src/glcli/display_data.py

@@ -0,0 +1,14 @@
+from rich import print
+from rich.markup import escape
+
+def display_inventory_sn(extracted_data:list[dict]):
+    """Function to display output on the CLI when querying by SN"""
+
+    indent = " " * 5
+    for device in extracted_data:
+        print()
+        print(f"[yellow]Serial[/yellow]: [white]{escape(str(device['serial']))}[/white]")
+        print(f"{indent}[yellow]MAC Address[/yellow]: [white]{escape(str(device['mac']))}[/white]")
+        print(f"{indent}[yellow]Status[/yellow]: [white]{escape(str(device['status']))}[/white]")
+        print(f"{indent}[yellow]Folder[/yellow]: [white]{escape(str(device['folder']))}[/white]")
+        print(f"{indent}[yellow]Folder ID[/yellow]: [white]{escape(str(device['folderId']))}[/white]")