---
title: "List Gateway Cluster tunnels"
method: GET
path: "/network-monitoring/v1/clusters/{cluster-name}/tunnels"
tags: ["Gateways"]
---

# List Gateway Cluster tunnels

`GET /network-monitoring/v1/clusters/{cluster-name}/tunnels`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/clusters/{cluster-name}/tunnels`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

Retrieves a list of tunnels present in a gateway-cluster with details like tunnel name, gateway, encapsulation, health and more.

## Path parameters

- `cluster-name` string, const, required: The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

## Query parameters

- `filter` string
- `sort` string
- `limit` integer
- `next` string: Specifies the pagination cursor for the next page of resources.

## Response `200`

Object containing information about the tunnels present in a gateway cluster.

- GatewayClusterTunnelListResponse
  - `items` object[], required
    - `tunnelName` string, required: The name of the tunnel configured in the gateway.
    - `gateway` string: The name of the gateway to which the tunnel belongs.
    - `gatewayRole` 'Isoleader' | 'Leader' | 'Member': Role of the gateway in the gateway cluster.
    - `health` 'Good' | 'Fair' | 'Poor': The health status of the tunnel.
    - `healthReasons` string[]
    - `status` 'Up' | 'Down': The status of the tunnel.
    - `encapsulation` 'IPSec' | 'GRE' | 'vxlan': Specifies the type of encapsulation used for the tunnel configured on the gateway.
    - `destinationName` string: The name of the destination gateway to which the tunnel is connected.
    - `destinationSerial` string: The serial number of the destination gateway to which the tunnel is connected.
    - `destinationSite` string: The site to which the destination gateway is assigned.
    - `sourceIpAddress` string, ipv4: IP address from which the tunnel originates.
    - `destinationIpAddress` string, ipv4: IP address to which the tunnel terminates.
    - `mode` 'Orchestrated' | 'Orchestrated-IKE' | 'Orchestrated-Survivability' | 'IKE': The mode of the tunnel.
    - `ssid` string: The name of the SSID configured in the tunnel.
    - `vni` integer: Encoded value used to uniquely identify the Layer 2 segment in a VXLAN network. It is null for tunnels other than VXLAN.
    - `id` string, required: Primary identifier for the resource.
    - `type` string, required: The type of the resource.
  - `count` integer, required: The number of items in the response.
  - `total` integer: Specifies the total number of items available for a given filter query.
  - `next` string, int32, required: Indicates the next page number, or null if there are no further pages.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Not Found error.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)