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

Create L2VPN Session

Description

Create or fully replace L2VPN session. API supported only when L2VPN Service is in Server Mode. 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}/l2vpn-services/{service-id}/sessions/{session-id}
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

string
service-id Required

string
session-id Required

Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns L2VPNSession of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineL2VPNSession1
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
$L2TcpMaxSegmentSizeClamping = Initialize-L2TcpMaxSegmentSizeClamping -Direction "NONE" -MaxSegmentSize 0
$L2VPNTunnelEncapsulation = Initialize-L2VPNTunnelEncapsulation -LocalEndpointAddress "MyLocalEndpointAddress" -PeerEndpointAddress "MyPeerEndpointAddress" -Protocol "GRE"
$L2VPNSession = Initialize-L2VPNSession -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 -Enabled $false -TcpMssClamping $L2TcpMaxSegmentSizeClamping -TransportTunnels "MyTransportTunnels" -TunnelEncapsulation $L2VPNTunnelEncapsulation
Invoke-CreateOrUpdateL2VPNSession -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -sessionId "MysessionId" -l2VPNSession $l2VPNSession

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}/l2vpn-services/{service-id}/sessions/{session-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-l2vpn-session
x-vmw-nsx-module: PolicyLayer2VPN


Feedback

Was this page helpful?