Vpn Generate Vpn Gateway Configuration
Provision a non-SD-WAN site (e.g. a data center or cloud service PoP) and generate VPN configuration.
Privileges required:
CREATE NETWORK_SERVICE
Request
URI
POST
https://{api_host}/portal/rest/vpn/generateVpnGatewayConfiguration
COPY
Request Body
Show optional properties
{
"name": "string",
"data": {}
}{
"enterpriseId": 0,
"name": "string",
"data": {
"authentication": {
"key": "string",
"type": "string"
},
"isCDE": false,
"isServiceEnabled": false,
"primary": {
"IKESA": {
"DHGroup": 0,
"authenticationAlgorithm": "string",
"authenticationMethod": "string",
"ikeVersion": 0,
"lifeTimeSeconds": 0,
"phaseOneNegotiationMode": "string",
"sharedKey": "string",
"sharedKeyType": "string"
},
"IPSECDPD": {
"intervalSeconds": 0,
"retries": 0,
"type": "string"
},
"IPSECSA": {
"authenticationAlgorithm": "string",
"encryptionAlgorithm": "string",
"lifeTimeSeconds": 0,
"mode": "string",
"perfectForwardSecurity": "string",
"protocol": "string"
},
"bgpNeighbor": {
"neighborAS": "string",
"neighborIp": "string",
"defaultRoute": false,
"enableBfd": false,
"inboundFilter": {
"ids": [
"string"
]
},
"outboundFilter": {
"ids": [
"string"
]
},
"allowAS": false,
"localIP": "string",
"connect": "string",
"maxHop": "string",
"holdtime": "string",
"keepalive": "string",
"enableMd5": false,
"md5Password": "string"
},
"dataCenterLinkIp": "string",
"dataCenterPublicIp": "string",
"disabled": false,
"fragmentationAvoidance": {
"tcpMssAdjustmentBytes": 0,
"clearDontFragmentBit": "string",
"fragmentationStyle": "string"
},
"gatewayLinkIp": "string",
"gatewayPublicIp": "string",
"geoData": {
"latitude": "number",
"longitude": "number"
},
"redundant": "data_center_vpn_tunnel Object",
"serviceFQDN": "string",
"tunnelInterface": {
"MTU": 0
},
"type": "string",
"typeAlias": "string"
},
"secondary": {
"IKESA": {
"DHGroup": 0,
"authenticationAlgorithm": "string",
"authenticationMethod": "string",
"ikeVersion": 0,
"lifeTimeSeconds": 0,
"phaseOneNegotiationMode": "string",
"sharedKey": "string",
"sharedKeyType": "string"
},
"IPSECDPD": {
"intervalSeconds": 0,
"retries": 0,
"type": "string"
},
"IPSECSA": {
"authenticationAlgorithm": "string",
"encryptionAlgorithm": "string",
"lifeTimeSeconds": 0,
"mode": "string",
"perfectForwardSecurity": "string",
"protocol": "string"
},
"bgpNeighbor": {
"neighborAS": "string",
"neighborIp": "string",
"defaultRoute": false,
"enableBfd": false,
"inboundFilter": {
"ids": [
"string"
]
},
"outboundFilter": {
"ids": [
"string"
]
},
"allowAS": false,
"localIP": "string",
"connect": "string",
"maxHop": "string",
"holdtime": "string",
"keepalive": "string",
"enableMd5": false,
"md5Password": "string"
},
"dataCenterLinkIp": "string",
"dataCenterPublicIp": "string",
"disabled": false,
"fragmentationAvoidance": {
"tcpMssAdjustmentBytes": 0,
"clearDontFragmentBit": "string",
"fragmentationStyle": "string"
},
"gatewayLinkIp": "string",
"gatewayPublicIp": "string",
"geoData": {
"latitude": "number",
"longitude": "number"
},
"redundant": "data_center_vpn_tunnel Object",
"serviceFQDN": "string",
"tunnelInterface": {
"MTU": 0
},
"type": "string",
"typeAlias": "string"
},
"subnets": [
{
"advertise": false,
"cidrIp": "string",
"cidrIpStart": "string",
"cidrIpEnd": "string",
"cidrPrefix": "string",
"name": "string",
"netMask": "string"
}
],
"iaasProvider": {
"subscriptionObjectId": 0,
"vendor": "string",
"vendorSpecificData": {},
"tunnelsEnabledOnSync": false,
"syncStatus": {
"state": "string",
"stateTimestamp": 0,
"lastSyncTimestamp": 0,
"errorDetail": {
"message": "string",
"response": {
"statusCode": 0,
"contentType": "string",
"responseData": "string"
}
}
}
},
"loadSharingMethod": {
"algo": "string",
"hashParams": {
"srcIp": false,
"destIp": false,
"srcPort": false,
"destPort": false,
"protocol": false
}
},
"tunnelMode": "string",
"type": "string",
"vpnGateways": [
"string"
],
"redundant": {
"disabled": false
}
}
}
integer
enterpriseId
Optional
enterpriseId
string
name
Required
name
Responses
200
Request was successfully processed
Returns
vpn_generate_vpn_gateway_configuration_result
of type(s)
application/json
"vpn_generate_vpn_gateway_configuration_result Object"
integer
id
Optional
id
string
object
Optional
object
Possible values are :
NETWORK_ALLOCATION,
NETWORK_SERVICE,
CUSTOM_APPLICATION,
ROUTING_CONFIGURATION,
NETWORK_SEGMENT,
HA_SERVICE,
PRIVATE_NETWORK,
CDE_GATEWAY,
EDGE_LICENSE,
PROPERTY,
ANALYTICS_CONFIGURATION,
ZSCALER_LOCATION,
ZSCALER_SUBLOCATION,
NSD_CONFIGURATION,
NTICS_LICENSE,
CLIENT_CONNECTOR,
string
type
Optional
type
Possible values are :
dns,
authentication,
dataCenter,
dataCenterEdge,
edgeHub,
partnerGateway,
edgeHubCluster,
edgeBranchCluster,
localUiCredentials,
edgeBranchClusterMember,
edgeHubClusterMember,
securityVnf,
edgeVrrpPairSet,
cloudSecurityService,
cloudSecurityServiceSite,
securityVnfLicense,
securityVnfService,
primary,
secondary,
controllerGateway,
tacacs,
netflowCollector,
iaasSubscription,
netflowFilter,
vnfImage,
edgeDirectNVSSite,
nvsViaEdgeService,
zscaler,
cloudWebSecurity,
cloudWebSecurityPolicy,
secureAccess,
cloudToCloudInterConnect,
zscalerMtGreSite,
prefixTag,
logExportEndpoint,
cwsLogExportEndpointAssociation,
nticsLicense,
wssIntegration,
wssLocation,
clientConnector,
custom,
object
data
Optional
data
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","data:"object"}' https://{api_host}/portal/rest/vpn/generateVpnGatewayConfiguration
All Operations
POST
Vpn Generate Vpn Gateway Configuration