Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to interact with various ClearPass resources and operations. Specifically, for the "Guest Users" resource and the "Get By Username" operation, it retrieves detailed information about a guest user account by specifying the username. This is useful in scenarios where you need to fetch guest user details for auditing, reporting, or further processing within an automation workflow.

Practical examples include:

  • Automatically retrieving guest user details when a username is provided in a ticketing system.
  • Validating guest user accounts before granting network access.
  • Synchronizing guest user data with other systems based on username queries.

Properties

Name Meaning
Domain API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
Username The username of the guest account to retrieve. Required when Domain is "Identities" and Resource is "Guest Users".

Output

The node outputs an array of JSON objects representing the retrieved guest user(s) matching the specified username. Each item contains detailed properties of the guest user as returned by the Aruba ClearPass API.

If the node encounters an error and "Continue On Fail" is enabled, it outputs a JSON object with an error field containing the error message.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on the external Aruba ClearPass service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a username that does not exist will likely return an empty result or an error from the API.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue On Fail" is enabled, returned as part of the output JSON under the error key.
    • To resolve errors, verify API credentials, ensure the username exists, and check network connectivity.

Links and References

Discussion