[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update L2VPN Session
DescriptionCreate or patch an L2VPN session. API supported only when L2VPN Service is in Server Mode.
Request
URLURL
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}
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
This operation uses the following authentication methods.
Errors
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -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-nullL2TcpMaxSegmentSizeClamping -Direction "NONE" -MaxSegmentSize 0
$L2VPNTunnelEncapsulation = Initialize-nullL2VPNTunnelEncapsulation -LocalEndpointAddress "MyLocalEndpointAddress" -PeerEndpointAddress "MyPeerEndpointAddress" -Protocol "GRE"
$L2VPNSession = Initialize-nullL2VPNSession -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-CreateOrPatchL2VPNSession -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -sessionId "MysessionId" -l2VPNSession $l2VPNSession
cURL Command
curl -X PATCH -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
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-l2vpn-session
x-vmw-nsx-module: PolicyLayer2VPN
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
put
delete
delete
delete
get
get
get
patch
patch
patch
