PyCentral Documentation¶

PyCentral is a Python SDK that makes it easier to interact with Central and the HPE GreenLake Platform (GLP) through REST APIs. Instead of building and managing low-level HTTP requests, developers can:

Authenticate securely
Configure and manage devices and subscriptions
Monitor performance and collect analytics
Run troubleshooting workflows

PyCentral handles authentication, request formatting, and error handling, while exposing simple Python functions. This lets you configure, monitor, and troubleshoot your network without dealing with raw REST API calls.

Overview¶

PyCentral(v2) is the latest version of the SDK, designed for compatibility and simplicity:

Backwards Compatible → Works with PyCentral v1 scripts, with no breaking changes.
Multi-Platform Support → Works across Classic Central, New Central, and GLP.
Use MSPBase for MSP-level and tenant-scoped API workflows with unified credentials.
Simplified Token Management → Built-in OAuth2.0 support (no manual refresh needed).
Simplified Automation → Modules for configuration, monitoring, devices, subscriptions, and troubleshooting.

Versions¶

PyCentral-v2 is currently in pre-release, and we welcome feedback here as we continue improving it. Today, there are two versions of PyCentral, each designed for different versions of Central

Version	Supports	Notes
v1	Classic Central	Legacy Version
v2(pre-release)	Central( or new Central), GLP, Classic Central	Backwards compatible with v1

Quick Example¶

from pycentral import NewCentralBase

central_credential = {
   "new_central": {
       "base_url": "https://us5.api.central.arubanetworks.com",
       "client_id": "client_id",
       "client_secret": "client_secret",
   }
}

# Initialize NewCentralBase class with the token credentials for Central/GLP
central_conn = NewCentralBase(token_info=central_credential)

# Central API Call
central_resp = central_conn.command(
    api_method="GET", api_path="network-monitoring/v1/devices"
)

# Check response status and print results or error message
if central_resp["code"] == 200:
    print(central_resp["msg"])
else:
    print(f"Error - Response code {central_resp['code']}")
    print(central_resp["msg"])

Getting Started¶

Installation - Install PyCentral
Authentication - Configure credentials
Quick Start - Basic usage examples

Module Documentation¶

Browse the complete module documentation:

Base Module - Core connection classes
Exceptions - Exceptions used throughout PyCentral
GLP - HPE GreenLake Platform management
Monitoring - Monitoring modules
MSP - MSP modules
Profiles - Configuration profile management
Scopes - Scope management modules
Troubleshooting - Troubleshooting Modules
Streaming - Streaming API Modules
Utils - Utilities used throughout PyCentral
Classic - Legacy PyCentral module reference