Update SSL VPN V2 Connection

Updates an SSL VPN V2 Connection.

URI

/v2.0/vpn/ssl-vpn-v2-connections/{sslvpnv2connection-id}

Description of the URI:

{sslvpnv2connection-id} : Unique identifier for the SSL VPN V2 Connection.

HTTP method

PUT

Request parameter

Key Description Type Required/optional
name Name of the SSL VPN V2 Connection. string Optional
admin_state_up Administrative state of SSL VPN V2 Connection. If false (down), SSL VPN V2 Connection does not forward packets. bool Optional
security_groups Security groups set to SSL VPN V2 Server.

The number of security groups that can be registered is 6 or less.

uuid-str list Optional

Example request


       {
        "ssl_vpn_v2_connection": {
         "name": "conn1A",
         "admin_state_up": false,
         "security_groups": ["9833d261-35b2-4460-b615-9facb7474436"]
        }
       }
     

Response status

Status code Description
200 Normal response codes
Bad Request (400) Error response codes
Unauthorized (401) Error response codes
Not Found (404) Error response codes

Response body (normal status)


       {
        "ssl_vpn_v2_connection": {
         "id": "2322fdea-783d-923b-cc4e-abc023ed874f",
         "tenant_id": "1219ecaa01e0254dac4f08c9123aefcd",
         "name": "conn1A",
         "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": false,
         "vpnservice_id": "cc91b7af-8304-4aff-ad07-86bdbaae2e93",
         "availability_zone": "AZ1",
         "protocol": "udp",
         "security_groups": ["9833d261-35b2-4460-b615-9facb7474436"],
         "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"
          }
         ]
        }
       }
     

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'.