[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create IPsec VPN Interface

Description

Create or fully replace IPSec VPN service for given locale service under Tier-0. Revision is optional for creation and required for update.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

string
service-id Required

Request Body

Request Body

IPSecVpnService of type(s) application/json Required
This request body class requires all of the following: PolicyConfigResource, InlineIPSecVpnService1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns IPSecVpnService of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineIPSecVpnService1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$IPSecVpnSubnet = Initialize-IPSecVpnSubnet -Subnet "MySubnet"
$IPSecVpnRule = Initialize-IPSecVpnRule -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -Action "PROTECT" -Destinations $IPSecVpnSubnet -Enabled $false -Logged $false -SequenceNumber 0 -Sources $IPSecVpnSubnet
$IPSecVpnService = Initialize-IPSecVpnService -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -BypassRules $IPSecVpnRule -Enabled $false -HaSync $false -IkeLogLevel "DEBUG"
Invoke-CreateOrUpdateTier0IPSecVpnService -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -iPSecVpnService $iPSecVpnService

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-ipsec-vpn-interface
x-vmw-nsx-module: PolicyIPSecVpn


Feedback

Was this page helpful?