Update SSL VPN Connection

Updates an SSL VPN Connection.

URI

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

Description of the URI:

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

HTTP method

PUT

Request parameter

Key Description Type Required/optional
name name of the vpn service string Optional
admin_state_up Administrative state of vpnservice. If false (down), port does not forward packets. bool Optional

Example request


{
  "ssl_vpn_connection":{
    "name":"conn1A",
    "admin_state_up":false
  }
}
     

Response codes

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_connection":{
    "id":"2322fdea-783d-923b-cc4e-abc023ed874f",
    "tenant_id":"1219ecaa01e0254dac4f08c9123aefcd",
    "name":"conn1A",
    "status":"DOWN",
    "client_address_pool_cidr":"10.8.0.0/24",
    "credential_id":"434a9843-ecc0-4653-8f3a-e604d9d7aadc",
    "admin_state_up":false,
    "vpnservice_id":"cc91b7af-8304-4aff-ad07-86bdbaae2e93",
    "availability_zone":"AZ1"
  }
}
     

Description of response body (normal status)

Item Number of occurrences of element Description
tenant_id   Unique identifier for owner of the SSL VPN connection.
name   name of the SSL VPN connection.
admin_state_up   Administrative state of the SSL VPN connection. If false (down), port does not forward packets.
client_address_pool_cidr   Client address pool subnet which will be used by sslvpn client
credential_id   UUID for VPNCredential Container on keymanagement.

When you didn't specify this parameter at creating the resource, this value returns 'null'.

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

ACTIVE DOWN PENDING_CREATE ERROR

availability_zone   The Availability Zone name