Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VRF → Get All VRF

AI-generated

Overview

This node interacts with the Aruba Central Next Gen API to retrieve all VRF (Virtual Routing and Forwarding) instances. It is useful for network administrators who need to monitor or manage VRF configurations within their network infrastructure. For example, it can be used to fetch a list of all VRFs to audit network segmentation or to integrate VRF data into network management workflows.

Use Case Examples

  1. Retrieve all VRFs to display in a network monitoring dashboard.
  2. Fetch VRF details to automate network configuration audits.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, routing, etc.
Additional Fields Optional parameters to customize the VRF retrieval, including view type, object type, scope ID, persona, effective flag, detailed flag, limit, and offset.

Output

JSON

  • vrfId - Unique identifier of the VRF.
  • name - Name of the VRF.
  • description - Description of the VRF.
  • scopeId - Scope identifier associated with the VRF.
  • persona - Persona associated with the VRF.
  • effective - Indicates if the VRF is effective.
  • detailed - Indicates if detailed information is included.
  • additionalProperties - Other VRF-related properties returned by the API.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and valid to avoid authentication errors.
  • If the node returns no VRFs, verify that the domain is set to 'routing' and that the API user has permissions to access VRF data.
  • Enable Debug Mode to get detailed logs which can help identify issues with API requests or responses.
  • Common error messages include authentication failures, permission denied, or API rate limits. Check API credentials and permissions accordingly.

Links

Discussion