Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

VRFs → Get

AI-generated

Summary

Retrieves a specific VRF from an Aruba CX switch, optionally controlling the depth of returned data and which sections (configuration, status, statistics) to include.

Inputs

  • Host Override — Override the hostname from credentials (useful for looping over multiple switches).
  • Domain (required) — Domain of the Aruba CX API (only 'System' is available).
  • VRF Name (required) — Name of the VRF to retrieve.
  • Filters.Depth — Depth of resource details to include (default: 1).
  • Filters.Selector — Select configuration, status and/or statistics to return (e.g., 'configuration').

Output shape

array of objects

Each object represents the VRF as returned by the Aruba CX API; its exact structure varies with the requested depth and selector.

Examples

Example 1: Get basic VRF information

VRF Name: 'customer_a', Filters: Depth = 1, Selector = ''

Example 2: Get full configuration and status

VRF Name: 'customer_a', Filters: Depth = 2, Selector = 'configuration,status'

Discussion