Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

Port Access Roles → List

AI-generated

Summary

Lists port access role definitions for the selected system domain, optionally filtered and paginated.

Inputs

  • hostOverride — Optional: Override the hostname from credentials (useful for loops with multiple switches)
  • domain (required) — Domain of the Aruba CX API (typically "System")
  • returnAll — Whether to return all results or only up to a given limit
  • limit — Maximum number of results to return (1-1000)
  • filters — Collection of filters such as depth and selector to shape the query

Output shape

a list of port access role objects

Pagination follows limit and returnAll; results may be filtered by filters; an empty list is returned if no roles match.

Examples

Example 1: List all port access roles in the default system domain

Domain: System, Resource: portAccessRoles, Operation: list, no filters, default limit (100)

Example 2: Retrieve up to 250 roles with configuration details

Domain: System, Resource: portAccessRoles, Operation: list, Limit: 250, Filters: {depth:1, selector:'configuration'}

Example 3: Override host for multiple switches and fetch all matching roles

Domain: System, Host Override: 192.168.1.1, Resource: portAccessRoles, Operation: list, Return All: true, Limit: 1000

Discussion