Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Endpoints → List

AI-generated

Overview

This node interacts with the Aruba ClearPass API to list Endpoint resources within the Identities domain. It is useful for scenarios where users need to retrieve a list of network endpoints managed by ClearPass, such as devices connected to a network, for monitoring or management purposes. For example, a network administrator can use this node to fetch all endpoints or filter them based on specific criteria like status or MAC address.

Use Case Examples

  1. List all endpoints in the Identities domain.
  2. Retrieve endpoints with a specific status or MAC address using JSON filter expressions.
  3. Limit the number of returned endpoints to a specified maximum.

Properties

Name Meaning
Domain Specifies the API domain to access, here it is 'Identities' for Endpoint resources.
Return All Determines whether to return all results or limit the number of results.
Limit Maximum number of endpoint results to return when 'Return All' is false.
Filters Collection of optional filters to refine the list of endpoints returned, including JSON filter expressions, sort order, and whether to calculate the total count.

Output

JSON

  • id - Unique identifier of the endpoint.
  • mac_address - MAC address of the endpoint device.
  • status - Current status of the endpoint (e.g., Known, Unknown).
  • name - Name or label of the endpoint device.
  • ip_address - IP address assigned to the endpoint.
  • additionalProperties - Other endpoint-specific properties returned by the ClearPass API.

Dependencies

  • Aruba ClearPass API
  • An API key credential for ClearPass API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access Endpoint resources.
  • If the node returns an error, check the JSON filter syntax for correctness.
  • If no results are returned, verify that the filter criteria match existing endpoints.
  • Network connectivity issues to the ClearPass server can cause execution failures.

Links

Discussion