Actions408
- Device Actions
- Access Points Actions
- Get All Access Points
- Get Access Point Details
- Get Top APs by Wireless Usage
- Get AP Throughput Trends
- Get AP CPU Utilization
- Get AP Memory Utilization
- Get AP Power Consumption
- Get AP Radio Details
- Get Radio Performance
- Get APs with Performance Issues
- Get AP Port Frame Trends
- Get All Radios
- Get Radio Channel Utilization
- Get Radio Channel Quality
- Get Radio Noise Floor
- Get Radio Transmission Info
- Get AP Port CRC Errors
- Get AP Port Collision Errors
- Get AP Radio Throughput Trend
- Get AP Port Throughput Trend
- Get AP Radios List
- Get AP Ports List
- Get All WLANs
- Get WLAN by Name
- Get AP WLANs List
- Get AP WLAN Throughput Trend
- Get AP Tunnels List
- Get AP Tunnel Details
- Get AP Tunnel Throughput Trend
- Get AP Tunnel Packet Loss Trend
- Get AP Tunnel Jitter Trend
- Get AP Tunnel Latency Trend
- Get AP Tunnel MOS Score Trend
- Get WLAN Throughput Trend
- Client Actions
- Site Actions
- Site Health Actions
- Gateway Actions
- List Gateways
- Gateway Details
- Gateway Cluster Leader Details
- Gateway Cluster VLAN Mismatch Summary
- Gateway Cluster Connectivity Graph
- Gateway VLAN Detail
- List Gateway Cluster Members
- Gateway Tunnel Detail
- List Gateway Wired Interfaces
- List Gateway Cluster Tunnels
- List Gateway VLANs
- List Gateway LAN Tunnels
- List Gateway WAN Interfaces
- Get Gateway CPU Utilization Trend
- Get Gateway Memory Utilization Trend
- Get Gateway LAN Tunnel Throughput Trend
- Get Gateway LAN Tunnel Status Trend
- Get Cluster Capacity Trend
- Get Cluster Member Capacity Trend
- Get Gateway Interface Throughput Trend
- Get Summary of Cluster Tunnel Health
- Get Summary of Cluster Tunnel Status
- Get Summary of Gateway Tunnel Health
- Get Gateway WAN Availability Trend
- Get Gateway VPN Availability Trend
- Get Gateway Port Frames Trend
- Get Gateway Port Frames Errors Trend
- Get Gateway Port Frames Packets Trend
- Get Gateway Tunnel Dropped Packets Trend
- List Gateway WAN Tunnels
- Gateway WAN Tunnel Detail
- Get Summary of Gateway WAN Tunnel Health
- Get Details of Gateway Uplink
- Get Gateway Uplink Throughput Trend
- Get Gateway WAN Compression Trends for Uplink
- List Gateway Uplink Probes
- List Gateway Uplink Performance Trends
- Get Gateway Uplink Modem Stats
- Get WAN Availability Trends of Gateway Uplink
- Get VPN Availability Trends of Gateway Uplink
- Scope Management Actions
- Get All Sites
- Get Site
- Create Site
- Update Site
- Delete Site
- Bulk Delete Sites
- Add Devices to Site
- Get All Site Collections
- Get Site Collection
- Create Site Collection
- Update Site Collection
- Delete Site Collection
- Bulk Delete Site Collections
- Add Sites to Collection
- Remove Sites from Collection
- Get All Device Groups
- Get Device Group
- Create Device Group
- Create Device Group with Devices
- Update Device Group
- Bulk Delete Device Groups
- Add Devices to Group
- Remove Devices from Group
- Get All Device Collections
- Get Device Collection
- Create Device Collection
- Create Device Collection with Devices
- Update Device Collection
- Delete Device Collection
- Bulk Delete Device Collections
- Add Devices to Device Collection
- Remove Devices from Device Collection
- Get Scope Hierarchy
- AP Profiles Actions
- VLANs & Networks Actions
- Get All VRRP Global Profiles
- Get VRRP Global Profile
- Create VRRP Global Profile
- Update VRRP Global Profile
- Delete VRRP Global Profile
- Get All VRRP Interfaces
- Get VRRP Interface
- Create VRRP Interface
- Update VRRP Interface
- Delete VRRP Interface
- Get All MVRP Profiles
- Get MVRP Profile
- Create MVRP Profile
- Update MVRP Profile
- Delete MVRP Profile
- Get All Smartlink Profiles
- Get Smartlink Profile
- Create Smartlink Profile
- Update Smartlink Profile
- Delete Smartlink Profile
- Get All STP Profiles
- Get STP Profile
- Create STP Profile
- Update STP Profile
- Delete STP Profile
- Get All Layer2 VLANs
- Get Layer2 VLAN
- Create Layer2 VLAN
- Update Layer2 VLAN
- Delete Layer2 VLAN
- Get All VLAN Ranges
- Create VLAN Range
- Update VLAN Range
- Delete VLAN Range
- Get All Loop Protect Profiles
- Get Loop Protect Profile
- Create Loop Protect Profile
- Update Loop Protect Profile
- Delete Loop Protect Profile
- Get All Named VLANs
- Get Named VLAN
- Create Named VLAN
- Update Named VLAN
- Delete Named VLAN
- Roles & Policy Actions
- Get All Policy Groups
- Create Policy Group
- Update Policy Group
- Delete Policy Group
- Get All Roles
- Get Role
- Create Role
- Update Role
- Delete Role
- Get All Policies
- Get Policy
- Create Policy
- Update Policy
- Delete Policy
- Get All Role GPIDs
- Get Role GPID
- Create Role GPID
- Update Role GPID
- Delete Role GPID
- Get All Role ACLs
- Get Role ACL
- Create Role ACL
- Update Role ACL
- Delete Role ACL
- Wireless Actions
- Get All ALG
- Get ALG
- Create ALG
- Update ALG
- Delete ALG
- Get All ANQP 3GPP
- Get ANQP 3GPP
- Create ANQP 3GPP
- Update ANQP 3GPP
- Delete ANQP 3GPP
- Get All ANQP Domain Name
- Get ANQP Domain Name
- Create ANQP Domain Name
- Update ANQP Domain Name
- Delete ANQP Domain Name
- Get All ANQP IP Addr Avail
- Get ANQP IP Addr Avail
- Create ANQP IP Addr Avail
- Update ANQP IP Addr Avail
- Delete ANQP IP Addr Avail
- Get All ANQP NAI Realm
- Get ANQP NAI Realm
- Create ANQP NAI Realm
- Update ANQP NAI Realm
- Delete ANQP NAI Realm
- Get All ANQP Network Auth
- Get ANQP Network Auth
- Create ANQP Network Auth
- Update ANQP Network Auth
- Delete ANQP Network Auth
- Get All ANQP Roaming Consortium
- Get ANQP Roaming Consortium
- Create ANQP Roaming Consortium
- Update ANQP Roaming Consortium
- Delete ANQP Roaming Consortium
- Get All ANQP Venue Name
- Get ANQP Venue Name
- Create ANQP Venue Name
- Update ANQP Venue Name
- Delete ANQP Venue Name
- Get All H2QP Connection Capability
- Get H2QP Connection Capability
- Create H2QP Connection Capability
- Update H2QP Connection Capability
- Delete H2QP Connection Capability
- Get All H2QP Operating Class
- Get H2QP Operating Class
- Create H2QP Operating Class
- Update H2QP Operating Class
- Delete H2QP Operating Class
- Get All H2QP Operator Name
- Get H2QP Operator Name
- Create H2QP Operator Name
- Update H2QP Operator Name
- Delete H2QP Operator Name
- Get All H2QP OSU Provider
- Get H2QP OSU Provider
- Create H2QP OSU Provider
- Update H2QP OSU Provider
- Delete H2QP OSU Provider
- Get All H2QP WAN Metrics
- Get H2QP WAN Metrics
- Create H2QP WAN Metrics
- Update H2QP WAN Metrics
- Delete H2QP WAN Metrics
- Get All Hotspot2
- Get Hotspot2
- Create Hotspot2
- Update Hotspot2
- Delete Hotspot2
- Get All IDS
- Get IDS
- Create IDS
- Update IDS
- Delete IDS
- Get All Mesh
- Get Mesh
- Create Mesh
- Update Mesh
- Delete Mesh
- Get All Passpoint
- Get Passpoint
- Create Passpoint
- Update Passpoint
- Delete Passpoint
- Get All Radio
- Get Radio
- Create Radio
- Update Radio
- Delete Radio
- Get All WLAN
- Get WLAN
- Create WLAN
- Update WLAN
- Delete WLAN
- Named Object Actions
- Configuration Health Actions
- Ethernet Interface Actions
- Port Channel Actions
- LACP Actions
- Loopback Interface Actions
- LLDP Actions
- Static Route Actions
- OSPFv2 Actions
- BGP Actions
- VRF Actions
- DHCP Actions
- QoS Actions
- Firewall Actions
- Port Security Actions
- MAC Authentication Actions
- Config Checkpoint Actions
- Persona Assignment Actions
- Firmware Policy Actions
- HA Actions
- Config Assignment Actions
- NTP Actions
- SNMP Actions
- Syslog Actions
- Dump Server Actions
Roles & Policy → Get Role GPID
AI-generatedOverview
This node operation interacts with the Aruba Central Next Gen API to retrieve the GPID (Global Policy ID) of a specific role within the Roles & Policy resource. It is useful for network administrators who need to programmatically access role identifiers for configuration or auditing purposes. For example, it can be used to fetch role details by name within a specified domain such as Configuration, aiding in automated network policy management.
Use Case Examples
- Retrieve the GPID of a role named 'my-role-gpid' in the Configuration domain to automate role-based access control updates.
- Fetch role GPID with additional filters like view type, object type, and scope ID for detailed role management in a network environment.
Properties
| Name | Meaning |
|---|---|
| Debug Mode | Enables detailed debug logs for troubleshooting the node execution. |
| Domain | Specifies the API domain to interact with, such as Monitoring, Configuration, Interfaces, Routing, Network Services, Security, Management, or System. |
| Name | The name of the role for which to retrieve the GPID. |
| Additional Fields | Optional additional parameters to refine the role GPID retrieval, including view type, object type, scope ID, persona, detailed flag, and effective flag. |
Output
JSON
roleGpid- The retrieved Global Policy ID (GPID) of the specified role.
Dependencies
- Aruba Central Next Gen API
- An API key credential for authentication
Troubleshooting
- Ensure the 'Name' property is correctly set to an existing role name; otherwise, the API may return an error or no data.
- Verify that the selected 'Domain' matches the context where the role exists to avoid invalid API calls.
- If debug mode is enabled, check the detailed logs for specific error messages to diagnose issues.
- Common errors include authentication failures, invalid parameters, or network connectivity issues; verify credentials and network access.