List SSL VPN V2 Connections

Lists SSL VPN V2 Connections

URI

/v2.0/vpn/ssl-vpn-v2-connections

HTTP method

GET

Response status

Status code Description
200 Normal response codes
Unauthorized (401) Error response codes
Forbidden (403) Error response codes

Response body (normal status)


       {
        "ssl_vpn_v2_connections": [
         {
          "id": "2322fdea-783d-923b-cc4e-abc023ed874f",
          "tenant_id": "1219ecaa01e0254dac4f08c9123aefcd",
          "name": "conn1",
          "status": "DOWN",
          "client_address_pool_cidrs": ["10.8.0.0/24", "10.8.1.0/24"],
          "credential_id": "434a9843-ecc0-4653-8f3a-e604d9d7aadc",
          "admin_state_up": true,
          "vpnservice_id": "cc91b7af-8304-4aff-ad07-86bdbaae2e93",
          "availability_zone": "AZ1",
          "protocol": "udp",
          "security_groups": ["8060f6ab-e327-4e01-9ccd-f1432cfab2c9"],
          "access_points": [
           {
            "external_address": "172.16.1.10",
            "internal_gateway": "10.9.1.24",
            "client_address_pool_cidr": "10.8.0.0/24",
            "floatingip": "11bb315e-a0cb-4de3-acfc-00522e40722e"
           },
           {
            "external_address": "172.16.1.11",
            "internal_gateway": "10.9.1.25",
            "client_address_pool_cidr": "10.8.1.0/24",
            "floatingip": "53a14d86-4396-4f91-8c0d-ed934294269e"
           }
          ]
         },
         {
          "id": "86445a53-c95c-4203-8382-6c88b768c4a0",
          "tenant_id": "1219ecaa01e0254dac4f08c9123aefcd",
          "name": "conn2",
          "status": "ACTIVE",
          "client_address_pool_cidrs": ["10.8.2.0/24", "10.8.3.0/24"],
          "credential_id": "434a9843-ecc0-4653-8f3a-e604d9d7aadc",
          "admin_state_up": true,
          "vpnservice_id": "2b0cff45-af8f-4605-8f0b-ad06517474d5",
          "availability_zone": "AZ2",
          "protocol": "udp",
          "security_groups": ["2874b9e4-7fa7-4777-bb22-26a30d7ff37b"],
          "access_points": [
           {
            "external_address": "172.16.2.10",
            "internal_gateway": "10.9.2.24",
            "client_address_pool_cidr": "10.8.2.0/24",
            "floatingip": "cbad162e-e9f9-48d6-9deb-34eacf155ca0"
           },
           {
            "external_address": "172.16.2.11",
            "internal_gateway": "10.9.2.25",
            "client_address_pool_cidr": "10.8.3.0/24",
            "floatingip": "f1ef93fb-6de1-4719-b1ca-f555e1d2da72"
           }
          ]
         }
        ]
       }
     

Description of response body (normal status)

Item Description
tenant_id Unique identifier for owner of the SSL VPN V2 connection.
name Name of the SSL VPN V2 connection.
admin_state_up Administrative state of the SSL VPN V2 connection. If false (down), port does not forward packets.
client_address_pool_cidrs The list of "client_address_pool_cidr".
credential_id UUID for VPNCredential Container on keymanagement.

When you did not specify this parameter when creating the resource, this value returns 'null'.

vpnservice_id UUID for VPNService
id UUID for SSL VPN V2 connection Object.
status Indicates whether the SSL VPN V2 connection is currently operational. Possible values include:

ACTIVE DOWN PENDING_CREATE PENDING_UPDATE PENDING_DELETE ERROR

availability_zone The Availability Zone name
protocol Communication protocol used by VPN connection: udp, tcp
security_groups Security groups set to SSL VPN V2 Server.
access_points Information for accessing SSL VPN V2 connection. This consists of "external_address", "internal_gateway",

"client_address_pool_cidr" and "floatingip".

external_address External IP address to connect to SSL VPN V2 Server from SSL-VPN clients.
internal_gateway Gateway IP address to connect to remote SSL-VPN clients.
client_address_pool_cidr Client address pool subnet which will be used by SSL-VPN client.
floatingip Floating IP associates to the port of SSL VPN V2 Server.

When you did not specify the parameter "floatingips" when creating the resource, this value returns 'null'.