Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → List

AI-generated

Overview

This node interacts with the Aruba ClearPass API to list devices within the Identities domain. It is useful for scenarios where users need to retrieve device information managed by ClearPass, such as network administrators monitoring connected devices or automating device inventory management. For example, it can fetch all devices or a limited number based on filters and sorting criteria.

Use Case Examples

  1. Retrieve all devices in the Identities domain to monitor network endpoints.
  2. Fetch a limited number of devices with specific MAC address patterns using JSON filters.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for device listing.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of device results to return when 'Return All' is false.
Filters Collection of filters to refine the device list, including JSON filter expressions, sort order, and whether to calculate total count.

Output

JSON

  • id - Unique identifier of the device.
  • mac - MAC address of the device.
  • name - Name of the device.
  • type - Type or category of the device.
  • status - Current status of the device.
  • additionalProperties - Other device-related properties returned by the API.

Dependencies

  • Aruba ClearPass API
  • API key credential for authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Incorrect filter JSON syntax can cause errors; validate JSON filter expressions before use.
  • Exceeding API rate limits may result in errors; consider using 'Return All' judiciously or applying limits.
  • If the node throws errors, enabling 'Continue on Fail' allows workflow continuation with error details output.

Links

Discussion