PanoramicData.Aruba.Api 1.2.13

dotnet add package PanoramicData.Aruba.Api --version 1.2.13
                    
NuGet\Install-Package PanoramicData.Aruba.Api -Version 1.2.13
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PanoramicData.Aruba.Api" Version="1.2.13" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="PanoramicData.Aruba.Api" Version="1.2.13" />
                    
Directory.Packages.props
<PackageReference Include="PanoramicData.Aruba.Api" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add PanoramicData.Aruba.Api --version 1.2.13
                    
#r "nuget: PanoramicData.Aruba.Api, 1.2.13"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package PanoramicData.Aruba.Api@1.2.13
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=PanoramicData.Aruba.Api&version=1.2.13
                    
Install as a Cake Addin
#tool nuget:?package=PanoramicData.Aruba.Api&version=1.2.13
                    
Install as a Cake Tool

License: MIT

NuGet version

Codacy Badge

Aruba.Api

NuGet Codacy Badge License: MIT .NET

Need help with APIs or .NET? Panoramic Data are experts in APIs and .NET, and we can help with your development. Contact us or see our software services.

A modern, strongly-typed .NET 11.0 client for the HPE Aruba Networking Central (New Central) REST API.

Supports .NET 11.0.

It handles OAuth 2.0 authentication, token refresh, transient-error retries and read-only safety for you, and exposes each API area through clean, Refit-backed interfaces.

This client targets New Central (the HPE GreenLake-hosted Aruba Central). It is not for the legacy/classic Aruba Central API.

Upgrading from 1.1? Version 1.2 replaces the four per-device troubleshooting interfaces with one shared ITroubleshooting and moves common device properties onto shared base classes. See the migration guide for every change, the reasoning, and before/after code.

Installation

dotnet add package PanoramicData.Aruba.Api

Getting your credentials

  1. In New Central, create API client credentials — see Create client credentials. You will receive a client_id and client_secret.
  2. Find your account's regional base URL — see Finding your Base URL.

The client exchanges your client_id / client_secret for a bearer token using the OAuth 2.0 client_credentials grant against HPE GreenLake SSO (https://sso.common.cloud.hpe.com), then calls the regional API gateway. Tokens are cached in memory and refreshed automatically.

Quick start

using Aruba.Api;

using var client = new ArubaCentralClient(new ArubaCentralClientOptions
{
    BaseAddress = ArubaCentralClusters.UsWest, // or new Uri("https://<your-cluster>.api.central.arubanetworks.com")
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
});

// List access points (paged)
var aps = await client.AccessPoints.GetAllAsync(new ListQuery { Limit = 100 });
foreach (var ap in aps.Items)
{
    Console.WriteLine($"{ap.DeviceName} ({ap.SerialNumber}) - {ap.Status} - {ap.ClientCount} clients");
}

// Get site health
var sites = await client.SiteHealth.GetAllSitesHealthAsync();

// List alerts
var alerts = await client.Alerts.GetAllAsync(new ListQuery { Limit = 50 });

Safe by default: the client is read-only unless you opt in. IsReadOnly defaults to true, so every GET works out of the box, but any mutating call (POST/PUT/PATCH/DELETE) throws an InvalidOperationException before the request is sent. See Performing writes below.

Cursor-based paging

List endpoints return a PagedResponse<T> with Items, Count, Total and Next. Pass Next back via ListQuery to fetch the following page:

string? cursor = null;
do
{
    var page = await client.Clients.GetAllAsync(new ListQuery { Limit = 500, Next = cursor });
    Process(page.Items);
    cursor = page.Next;
}
while (cursor is not null);

Read-only safety (default)

IsReadOnly defaults to true — a client you construct without thinking about it can never mutate your tenant. Any non-GET request throws an InvalidOperationException before it leaves the process. This makes monitoring/reporting integrations safe by construction.

Performing writes (opt in)

To call mutating endpoints (clear alerts, update a device, manage webhooks, run troubleshooting commands, …) you must explicitly set IsReadOnly = false:

using var writeClient = new ArubaCentralClient(new ArubaCentralClientOptions
{
    BaseAddress = ArubaCentralClusters.Europe,
    ClientId = id,
    ClientSecret = secret,
    IsReadOnly = false, // opt in to writes
});

var alerts = await writeClient.Alerts.GetAllAsync(new ListQuery { Limit = 50 });
await writeClient.Alerts.ClearAsync(new AlertActionRequest
{
    AlertIds = alerts.Items.Select(a => a.Id!).ToList(),
});

Live troubleshooting (asynchronous commands)

Troubleshooting commands are asynchronous: they return a task id you poll for the result. They are mutating (POST) operations, so they require a client created with IsReadOnly = false (see Performing writes).

One interface covers access points, AOS-CX and AOS-S switches, and gateways. The TroubleshootingTarget says which kind of device you are talking to, and TroubleshootingCommands names the commands.

var accepted = await client.Troubleshooting.CommandAsync(
    TroubleshootingTarget.AccessPoint,
    "AP00000001",
    TroubleshootingCommands.Ping,
    new TroubleshootingCommandRequest { Host = "8.8.8.8", Count = 5 });

var result = await client.Troubleshooting.GetCommandResultAsync(
    TroubleshootingTarget.AccessPoint, "AP00000001", TroubleshootingCommands.Ping, accepted.TaskId!);

Console.WriteLine(result.Output);

Dependency injection

services.AddArubaCentralClient(builder =>
{
    builder.BaseAddress = ArubaCentralClusters.UsWest;
    builder.ClientId = configuration["Aruba:ClientId"];
    builder.ClientSecret = configuration["Aruba:ClientSecret"];
    builder.IsReadOnly = true;
});

Logging

Pass any Microsoft.Extensions.Logging.ILogger. At Debug level the client logs full request and response detail; the Authorization header and client_secret are always masked.

API coverage

The client covers the New Central MRT API set (Monitoring, Reporting, Troubleshooting) and related notification and MSP services. Every area is reached through a property on ArubaCentralClient:

Area Property Notes
Monitoring — Access Points AccessPoints List/detail, top-N, radios, ports, tunnels, WLANs, key trends
Monitoring — Devices Devices List, inventory, update, delete
Monitoring — Clients Clients List/detail, trend, top-N usage, mobility trail
Monitoring — Switches Switches List/detail, stack, interfaces, VLANs, PoE, VSX, trends
Monitoring — Gateways Gateways List/detail, ports, VLANs, tunnels, uplinks, clusters, trends
Monitoring — Site Health SiteHealth Per-site and tenant device/client health
Monitoring — Topology Topology Site topology, neighbours, isolated/unmanaged devices
Monitoring — Application Visibility ApplicationVisibility Application usage
Monitoring — Firewall Sessions FirewallSessions Site/client firewall sessions
Monitoring — Client Onboarding ClientOnboarding Onboarding score/stages
Notifications — Alerts Alerts List, clear/defer/activate/prioritise, classification
Notifications — Insights Insights List
Reporting Reports List, update, run history
Services — Webhooks Webhooks Full CRUD + HMAC key rotation
Services — Firmware Firmware Firmware details
Troubleshooting — Devices Troubleshooting Access points, AOS-CX and AOS-S switches and gateways: ping, traceroute, speed test, cable test, port/PoE bounce, iperf, show commands, reboot, locate, task results

| Troubleshooting — Events | Events | Events, extra attributes, filters | | MSP | MspTenants | List managed tenants |

Strongly-typed models are provided for the core resources (access points, devices, switches, gateways, clients, alerts, site health, reports, MSP tenants and more). Less common or highly-variable payloads are surfaced as Dictionary<string, object> so no data is lost while the typed surface grows; contributions adding typed models are welcome — see CONTRIBUTING.md.

Not yet wrapped in 1.0: the New Central Configuration API (a separate, very large surface) and the floor-plan/site-map editing endpoints. These are planned for future releases.

Quality

  • Targets net11.0, builds with TreatWarningsAsErrors and nullable reference types enabled.
  • Deterministic versioning via Nerdbank.GitVersioning.
  • Symbols (snupkg) published for source debugging.
  • Unit tests run on xUnit v3 with failSkips enforced.

Contributing & roadmap

  • DESIGN.md — repository layout, architecture, and conventions.
  • PLAN.md — roadmap to full API coverage and high code coverage.
  • CONTRIBUTING.md — how to add an endpoint and the quality gates.

License

Licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net11.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.13 0 11/19/2026
1.2.12 92 11/15/2026
1.2.5 88 11/10/2026
1.1.2 128 10/4/2026