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

Create BGP Routing

Description

If BGP routing config is not already present, create BGP routing config. If it already exists, replace the BGP routing 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
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns BgpRoutingConfig of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineBgpRoutingConfig1
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
$BgpGracefulRestartTimer = Initialize-nullBgpGracefulRestartTimer -RestartTimer 0 -StaleRouteTimer 0
$BgpGracefulRestartConfig = Initialize-nullBgpGracefulRestartConfig -Mode "DISABLE" -Timer $BgpGracefulRestartTimer
$RouteAggregationEntry = Initialize-nullRouteAggregationEntry -Prefix "MyPrefix" -SummaryOnly $false
$BgpRoutingConfig = Initialize-nullBgpRoutingConfig -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 -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -EbgpAdminDistance 0 -Ecmp $false -Enabled $false -GracefulRestart $false -GracefulRestartConfig $BgpGracefulRestartConfig -IbgpAdminDistance 0 -InterSrIbgp $false -LocalAsNum "MyLocalAsNum" -MultipathRelax $false -RouteAggregations $RouteAggregationEntry
Invoke-CreateOrReplaceBgpRoutingConfig -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -bgpRoutingConfig $bgpRoutingConfig -_override $true

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","display_name":"string","ecmp":false,"enabled":false,"graceful_restart":false,"graceful_restart_config":{"mode":"DISABLE","timer":{"restart_timer":0,"stale_route_timer":0}},"id":"string","inter_sr_ibgp":false,"local_as_num":"string","marked_for_delete":false,"multipath_relax":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","route_aggregations":[{"prefix":"string","summary_only":false}],"tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?