Create VpnTunnel

POST 
/projects/:projectId/providers/Aruba.Network/vpnTunnels

Create VpnTunnel

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

Query Parameters

api-version string
The requested API version
Default value: 1.0

application/json

Body

the vpnTunnel to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a vpnTunnel

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

vpnTypestringnullable

Type of vpnTunnel. Admissable values:

• Site-To-Site

vpnClientProtocolstringnullable

Protocof af the vpnTunnel. Admissable values:

• ikev2

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

namestringnullable

Name of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetfime

encryptionstringnullable

Encryption

hashstringnullable

Hash

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

secretstringnullable

Secret

peerClientPublicIpstringnullable

Peer client public ip address

billingPlan

object

Billing plan

billingPeriodstringnullable

text/json

Body

the vpnTunnel to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a vpnTunnel

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

vpnTypestringnullable

Type of vpnTunnel. Admissable values:

• Site-To-Site

vpnClientProtocolstringnullable

Protocof af the vpnTunnel. Admissable values:

• ikev2

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

namestringnullable

Name of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetfime

encryptionstringnullable

Encryption

hashstringnullable

Hash

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

secretstringnullable

Secret

peerClientPublicIpstringnullable

Peer client public ip address

billingPlan

object

Billing plan

billingPeriodstringnullable

application/*+json

Body

the vpnTunnel to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a vpnTunnel

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

vpnTypestringnullable

Type of vpnTunnel. Admissable values:

• Site-To-Site

vpnClientProtocolstringnullable

Protocof af the vpnTunnel. Admissable values:

• ikev2

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

namestringnullable

Name of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetfime

encryptionstringnullable

Encryption

hashstringnullable

Hash

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

secretstringnullable

Secret

peerClientPublicIpstringnullable

Peer client public ip address

billingPlan

object

Billing plan

billingPeriodstringnullable

Responses

201

Created

text/plain

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

vpnTypestringnullable

Type of the vpnTunnel

vpnClientProtocolstringnullable

Protocol of the vpnTunnel

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

uristringnullable

Uri of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetime

hashstringnullable

Hash

encryptionstringnullable

Encryption

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

peerClientPublicIpstringnullable

Peer client public ip address

routesNumberint32

Numbers of valid vpnRoutes of the vpnTunnel

billingPlan

object

nullable

Billing plan

billingPeriodstringnullable

Example (from schema)

{}

application/json

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

vpnTypestringnullable

Type of the vpnTunnel

vpnClientProtocolstringnullable

Protocol of the vpnTunnel

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

uristringnullable

Uri of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetime

hashstringnullable

Hash

encryptionstringnullable

Encryption

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

peerClientPublicIpstringnullable

Peer client public ip address

routesNumberint32

Numbers of valid vpnRoutes of the vpnTunnel

billingPlan

object

nullable

Billing plan

billingPeriodstringnullable

Example (from schema)

{}

text/json

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

vpnTypestringnullable

Type of the vpnTunnel

vpnClientProtocolstringnullable

Protocol of the vpnTunnel

ipConfigurations

object

nullable

Network configuration of the vpnTunnel

vpc

object

nullable

Vpc of the vpnTunnel

uristringnullable

subnet

object

nullable

Subnet of the vpnTunnel

cidrstringnullable

Cidr of the subnet

uristringnullable

Uri of the subnet

publicIp

object

nullable

ElasticIp used by the vpnTunnel

uristringnullable

vpnClientSettings

object

nullable

Client settings of the vpnTunnel

ike

object

nullable

Ike settings

lifetimeint32

Lifetime

encryptionstringnullable

Encryption

hashstringnullable

Hash

dhGroupstringnullable

DhGroup

dpdActionstringnullable

DpdAction

dpdIntervalint32

DpdInterval

dpdTimeoutint32

DpdTimeout

esp

object

nullable

Esp settings

lifetimeint32

Lifetime

hashstringnullable

Hash

encryptionstringnullable

Encryption

pfsstringnullable

Pfs

psk

object

nullable

Psk settings

cloudSitestringnullable

Cloud site

onPremSitestringnullable

OnPrem site

peerClientPublicIpstringnullable

Peer client public ip address

routesNumberint32

Numbers of valid vpnRoutes of the vpnTunnel

billingPlan

object

nullable

Billing plan

billingPeriodstringnullable

Example (from schema)

{}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Server Error