Create SSL VPN Connection

URI

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

HTTP method

POST

Request parameter

Key	Description	Type	Required/optional
name	name of the SSL VPN connection (default: "")	string	Optional
admin_state_up	Administrative state of the SSL VPN connection. If false (down), port does not forward packets (default: true)	bool	Optional
client_address_pool_cidr	Client address pool subnet which will be used by sslvpn client	cidr	Required
credential_id	UUID for VPNCredential Container on keymanagement When you use client certificate offered by K5 to connect SSL-VPN, please omit this parameter.	uuid-str	Optional
vpnservice_id	UUID for VPNService	uuid-str	Required
availability_zone	The Availability Zone name. If you don't specify, the resource will be created in default Availability Zone. (default: default Availability Zone selected)	string	Optional
protocol	Communication protocol used by VPN connection: tcp (only tcp can be specified but this parameter cannot be committed)	string	Required

Example request


{
  "ssl_vpn_connection":{
    "name":"conn1",
    "client_address_pool_cidr":"10.8.0.0/24",
    "admin_state_up": true,
    "credential_id": "434a9843-ecc0-4653-8f3a-e604d9d7aadc",
    "vpnservice_id":"cc91b7af-8304-4aff-ad07-86bdbaae2e93",
    "availability_zone": "AZ1"
    "protocol": "tcp"
  }
}

Response codes

Status code	Description
201	Normal response codes
Bad Request (400)	Error response codes
Unauthorized (401)	Error response codes

Response body (normal status)


{
  "ssl_vpn_connection":{
    "id":"76ee7216-5eef-470c-a7d2-ce4a7461b046",
    "name":"conn1",
    "status":"DOWN",
    "client_address_pool_cidr":"10.8.0.0/24",
    "credential_id": "434a9843-ecc0-4653-8f3a-e604d9d7aadc",
    "admin_state_up": true,
    "tenant_id":"1219ecaa01e0254dac4f08c9123aefcd",
    "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