pycentral

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #go #rust #docker #java #nodejs #awesome #kubernetes #vue #pytorch #openai #mcp

(★ 59)

Aruba Central Python SDK

pycentral Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PyCentral (Python SDK for HPE Aruba Networking Central)

> **⚠️ Pre-release Notice**  
> This is a **pre-release version** of PyCentral-v2, and the features are constantly being updated as the APIs evolve. This version of the SDK allows you to make API calls to New Central, GLP, and Classic Central.  
> If you are looking for the stable version of PyCentral (v1), it is still available and fully supported. PyCentral-v1, which only supports Classic Central, can be found [here](https://pypi.org/project/pycentral/).

A Python SDK for interacting with **Central** via REST APIs.  
Automate onboarding, configuration, monitoring, and management for:
- **New Central**
- **HPE GreenLake Platform (GLP)**
- **Classic Central** (via the `classic` module for backward compatibility)

Upgrading to this pre-release version will not break PyCentral-v1 code. All the PyCentral-v1 code has been moved to the `classic` folder within the PyCentral directory, ensuring backward compatibility. You can find Classic Central PyCentral Documentation [here](#classic-central).

---

## Install

To install the latest pre-release version of PyCentral, use the following command:

```bash
pip3 install --pre pycentral
```

If you already have PyCentral-v1 and would like to upgrade to the pre-release version, use the following command:

```bash
pip3 install --upgrade --pre pycentral
```

---

## Authentication

### Unified Credentials (New Central & GLP)

PyCentral supports a **unified credential** model that lets you use a single set of GLP client credentials to access both GLP and New Central APIs. Instead of providing separate `glp` and `new_central` credential blocks, you provide one `unified` block with your GLP `client_id`, `client_secret`, and `workspace_id`. The SDK generates one token through GLP auth and reuses it for both platforms.

To also make New Central API calls, include `base_url` or `cluster_name` in the unified block. If omitted, only GLP calls are enabled.

```python
token_info = {
    "unified": {
        "client_id": "<glp-client-id>",
        "client_secret": "<glp-client-secret>",
        "workspace_id": "<workspace-id>",
        "cluster_name": "uswest4"  # or "base_url"; omit for GLP-only
    }
}
```
### New Central
You will need:
  - **Base URL or Cluster Name**: Identifies your Central Account's API gateway. Both options function identically. Use whichever is convenient:
    - **Base URL** —  URL for requests to your Central API Gateway. For instructions on how to locate your Base URL, see [Finding Your Base URL in Central](https://developer.arubanetworks.com/new-central/docs/getting-started-with-rest-apis#finding-your-base-url).
    - **Cluster Name** — Name of the cluster where your account is provisioned. A table detailing all cluster names can be found [here](https://developer.arubanetworks.com/new-central/docs/getting-started-with-rest-apis#api-gateway-base-urls). 
  - **Client ID and Client Secret**: These credentials are required to generate an access token to authenticate API requests. You can obtain them by creating a Personal API Client for your New Central Account. Follow the detailed steps in the [Create Client Credentials documentation](https://developer.arubanetworks.com/new-central/docs/generating-and-managing-access-tokens#create-client-credentials).

```yaml
new_central:
  base_url: <api-base-url>
  client_id: <client-id>
  client_secret: <client-secret>
```

### HPE GreenLake Platform (GLP)
If you are working with HPE GreenLake APIs, authentication is slightly different:
   - GLP does not require a Base URL.
   - You only need the **Client ID & Client Secret** for the HPE GreenLake Platform.
```yaml
glp:
  client_id: <client-id>
  client_secret: <client-secret>
```

---

## Example

Before running the script, create a `token.yaml` file in the same directory and populate it with the required credentials as follows:

```yaml
new_central:
  base_url: <api-base-url>
  client_id: <client-id>
  client_secret: <client-secret>
glp:
  client_id: <client-id>
  client_secret: <client-secret>
```

Once you have the `token.yaml` file ready, you can run the following Python script:
```python
import os
from pycentral import NewCentralBase

# Validate token file exists
token_file = "token.yaml"
if not os.path.exists(token_file):
    raise FileNotFoundError(
        f"Token file '{token_file}' not found. Please provide a valid token file."
    )

# Initialize NewCentralBase class with the token credentials for New Central/GLP
with NewCentralBase(token_info=token_file) as conn:
   
    # Make the API call to retrieve device inventory
    resp = conn.command(
        api_method="GET",
        api_path="network-monitoring/v1/device-inventory"
    )
    
    # If the response code is 200, print the device inventory response; otherwise, print the error code and message
    if resp["code"] == 200:
        print(resp["msg"])
    else:
        print(f"Error {resp['code']}: {resp['msg']}")
```

Run the script using the following command:

```bash
python3 demo.py
```

## Compatibility

- **v2** supports **New Central** and **GLP**.
- **Classic Central (v1)** remains in the `classic` module for backward compatibility.
- Existing v1 code will continue to work without changes.

---

## Documentation
- [Getting Started](https://developer.arubanetworks.com/new-central/docs/getting-started-with-python)
- [Authentication](https://developer.arubanetworks.com/new-central/docs/pycentral-quickstart-guide)
- [Quickstart Guide](https://developer.arubanetworks.com/new-central/docs/pycentral-quickstart-guide)

---

## Classic Central

The Classic Central functionality is still fully supported by the SDK and has been moved to a dedicated documentation page. For information on using the SDK with Classic Central, including authentication methods, API calls, and workflow examples, please see the [Classic Central Documentation](https://github.com/aruba/pycentral/blob/master/README.md).

### Documentation

- <a href="https://pycentral.readthedocs.io/en/v1.4.3/" target="_blank">Python Module documentation</a>

### **Use-Cases and Workflows**
- <a href="https://developer.arubanetworks.com/central/docs/python-getting-started" target="_blank">HPE Networking Developer Hub</a>
- <a href="https://github.com/aruba/central-python-workflows/tree/main" target="_blank">central-python-workflows</a>

pycentral

pycentral Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pycentral

pycentral Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README