VPNsResource


Create an ip sec vpn


Creates an IPSec VPN.

POST https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns

Roles : [ROLE_MANAGE_VPN]

Content-Type : vpnipsec Accept : asynctask

Error Codes

  • ASYNC-TASK-1 - Unable to enqueue async task
  • CONSTR-IPSECVPNLOCALENDPOINTS - The property '' 'localEndpoint' and 'localEndpointIp' must not be set when 'localEndpointNattIp' is present.

Example

List ip sec vpns


Returns all IPSec VPNs created in the given virtual datacenter.

GET https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns

Roles : [ROLE_MANAGE_VPN]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String name Parameter for ordering. Valid values {@link IPSecVPN.OrderBy}.
has String If present filter to apply in the search.
limit int 25 The number of entities to retrieve
asc boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
source String LOCAL Use 'REMOTE' to force the synchronization in the provider.

Accept : vpnsipsec

Delete an ip sec vpn


Deletes an IPSec VPN.

DELETE https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns/{vpn}

Roles : [ROLE_MANAGE_VPN]

Parameter Type Default Value Description
force boolean false If true, logical delete is performed

Accept : asynctask

Error Codes

  • ASYNC-TASK-2 - Unable to operate with a Taskable related to a task in progress

Example

Get an ip sec vpn


Retrieves the details of an IPSec VPN.

GET https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns/{vpn}

Roles : [ROLE_MANAGE_VPN]

Accept : vpnipsec

Example

Update an ip sec vpn


Modifies an IPSec VPN

PUT https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns/{vpn}

Roles : [ROLE_MANAGE_VPN]

Content-Type : vpnipsec Accept : asynctask

Error Codes

  • ASYNC-TASK-2 - Unable to operate with a Taskable related to a task in progress

Example

Check tunnel status of an ip sec vpn


GET https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns/{vpn}/status

Roles : [ROLE_MANAGE_VPN]

List async tasks for a vpn


GET https://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/vpns/{vpn}/asynctasks

Roles : [ROLE_MANAGE_VPN]

Accept : asynctasks

Example