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

Create BGP Neighbor Config

Description

If 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

Request

URL

URL


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

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

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

Errors

ApiError
400

Bad Request


ApiError
403

Forbidden


404

Not Found


ApiError
412

Precondition Failed


ApiError
500

Internal Server Error


ApiError
503

Service Unavailable

Code Samples

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
$BgpBfdConfig = Initialize-nullBgpBfdConfig -Enabled $false -Interval 0 -Multiple 0
$BgpRouteFiltering = Initialize-nullBgpRouteFiltering -AddressFamily "IPV4" -Enabled $false -InRouteFilters "MyInRouteFilters" -MaximumRoutes 0 -OutRouteFilters "MyOutRouteFilters"
$BgpNeighborConfig = Initialize-nullBgpNeighborConfig -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-CreateOrReplaceBgpNeighborConfig -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -neighborId "MyneighborId" -bgpNeighborConfig $bgpNeighborConfig -_override $true

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}/bgp/neighbors/{neighbor-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-bgp-neighbor-config
x-vmw-nsx-module: PolicyConnectivity


Feedback

Was this page helpful?