Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API
Join our community

Actions82

Overview

This node interacts with the Aruba Central Next Gen API to retrieve client information from a specified site within the monitoring domain. It is designed to fetch detailed data about network clients, such as devices connected to a network, their status, connection type, and other attributes.

Common scenarios where this node is beneficial include:

  • Network administrators wanting to monitor all clients connected to a specific site.
  • Automated workflows that analyze client experience or status for troubleshooting or reporting.
  • Filtering clients based on various criteria like connection type, status, or VLAN for targeted actions.

Practical example:

  • Retrieve all wireless clients currently connected to a site to generate a report on client health and usage.
  • Fetch clients filtered by poor experience quality to trigger alerts or remediation workflows.

Properties

Name Meaning
Debug Mode Enable detailed debug logs for troubleshooting purposes.
Domain Select the API domain to interact with:
- Monitoring: Monitor devices, clients, and sites
- Configuration: Configure devices, groups, and profiles
Site ID The unique identifier of the site from which clients are to be retrieved. This is required when using the Monitoring domain and Clients resource with Get All Clients operation.
Return All Whether to return all results or limit the number of returned clients.
Limit Maximum number of client records to return (up to 1000). Only applicable if "Return All" is false.
Serial Number Optional device identifier to filter clients by a specific device serial number.
Time Range Specify a time range for client data retrieval:
- Start Time (Epoch MS): Start timestamp in milliseconds since epoch
- End Time (Epoch MS): End timestamp (defaults to current time if not set)
Filters Filter clients using OData v4.0 style criteria (only AND conjunction supported):
- Experience: Good, Fair, Poor
- Status: Connected, Failed, Connecting, Disconnected, Blocked, Unknown
- Type: Wired, Wireless
- Network: Network name string
- VLAN ID: VLAN identifier string
- Tunnel: Port-based, User-based, Overlay
- Role: Client role string
Fields to Return Comma-separated list of client fields to return. Leave empty to return all fields. Valid fields include: name, ip_address, username, os_type, connection, associated_device, group_name, swarm_id, network, radio_mac, manufacturer, vlan, encryption_method, radio_number, speed, usage, health, labels, site, signal_strength, signal_db, snr, interface_mac, stack_id
Sort Sort clients by a field followed by ASC or DESC. Supported fields: name, experience, status, statusReason, type, mac, ipv4, ipv6, connectedDeviceSerial, connectedTo, lastSeenAt, port, role, network, vlanId, tunnel, tunnelId, connectedSince
Pagination Pagination options:
- Next Page Cursor: Numeric cursor for fetching the next page of results (minimum value 1). Only used if "Return All" is false.

Output

The node outputs an array of JSON objects representing clients matching the query parameters. Each object contains client details according to the requested fields or all available fields if none are specified.

If binary data were involved (not indicated here), it would typically represent files or media related to clients, but this node focuses on JSON client data only.

Example output structure snippet:

[
  {
    "name": "Client1",
    "ip_address": "192.168.1.10",
    "username": "user1",
    "os_type": "iOS",
    "connection": "Wireless",
    "status": "Connected",
    "experience": "Good",
    ...
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with Aruba Central Next Gen API.
  • The node depends on the "monitoring" domain of the Aruba Central API for retrieving client data.
  • No additional external services beyond Aruba Central API are needed.
  • Proper configuration of credentials and permissions in n8n is necessary.

Troubleshooting

  • Common issues:

    • Missing or invalid Site ID will cause the API call to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Using unsupported filter values or malformed OData filters may cause request errors.
    • Exceeding the maximum limit (1000) will be rejected by the API.
    • Pagination cursors must be valid positive integers; otherwise, pagination will fail.

  • Error messages:

    • "Unknown error in node execution": Generic catch-all error; check debug logs if enabled.
    • Authorization errors: Verify API credentials and permissions.
    • Validation errors: Check input properties for required fields and correct formats.

  • Enabling "Debug Mode" helps provide detailed logs to diagnose issues.

Links and References

  • Aruba Central Next Gen API Documentation (general reference for API endpoints and parameters)
  • OData v4.0 Filter Syntax Guide (for constructing filter queries)
  • n8n Documentation on Custom Nodes and Credentials Configuration

Discussion