[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update BGP Neighbor Config
DescriptionIf BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
Path Parameters
Path Parameters
string
tier-0-id
Required
string
locale-service-id
Required
string
neighbor-id
Required
Request Body
Request Body
BgpNeighborConfig
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineBgpNeighborConfig1
Authentication
This operation uses the following authentication methods.
Errors
Errors
404
Not Found
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
$BgpBfdConfig = Initialize-BgpBfdConfig -Enabled $false -Interval 0 -Multiple 0
$BgpRouteFiltering = Initialize-BgpRouteFiltering -AddressFamily "IPV4" -Enabled $false -InRouteFilters "MyInRouteFilters" -MaximumRoutes 0 -OutRouteFilters "MyOutRouteFilters"
$BgpNeighborConfig = Initialize-BgpNeighborConfig -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 -AllowAsIn $false -Bfd $BgpBfdConfig -GracefulRestartMode "DISABLE" -HoldDownTime 0 -InRouteFilters "MyInRouteFilters" -KeepAliveTime 0 -MaximumHopLimit 0 -NeighborAddress "MyNeighborAddress" -OutRouteFilters "MyOutRouteFilters" -Password "MyPassword" -RemoteAsNum "MyRemoteAsNum" -RouteFiltering $BgpRouteFiltering -SourceAddresses "MySourceAddresses"
Invoke-PatchBgpNeighborConfig -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -neighborId "MyneighborId" -bgpNeighborConfig $bgpNeighborConfig -_override $true
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}/bgp/neighbors/{neighbor-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-bgp-neighbor-config
x-vmw-nsx-module: PolicyConnectivity
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
get
patch