published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware
Create PolicyRouteControllerBgpNeighbor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyRouteControllerBgpNeighbor(name: string, args: PolicyRouteControllerBgpNeighborArgs, opts?: CustomResourceOptions);@overload
def PolicyRouteControllerBgpNeighbor(resource_name: str,
args: PolicyRouteControllerBgpNeighborArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyRouteControllerBgpNeighbor(resource_name: str,
opts: Optional[ResourceOptions] = None,
neighbor_address: Optional[str] = None,
source_addresses: Optional[Sequence[str]] = None,
remote_as_num: Optional[str] = None,
display_name: Optional[str] = None,
parent_path: Optional[str] = None,
enabled: Optional[bool] = None,
allow_as_in: Optional[bool] = None,
hold_down_time: Optional[float] = None,
keep_alive_time: Optional[float] = None,
maximum_hop_limit: Optional[float] = None,
gateway_ips: Optional[Sequence[str]] = None,
nsx_id: Optional[str] = None,
graceful_restart_mode: Optional[str] = None,
password: Optional[str] = None,
policy_route_controller_bgp_neighbor_id: Optional[str] = None,
description: Optional[str] = None,
route_filterings: Optional[Sequence[PolicyRouteControllerBgpNeighborRouteFilteringArgs]] = None,
bfd_config: Optional[PolicyRouteControllerBgpNeighborBfdConfigArgs] = None,
tags: Optional[Sequence[PolicyRouteControllerBgpNeighborTagArgs]] = None)func NewPolicyRouteControllerBgpNeighbor(ctx *Context, name string, args PolicyRouteControllerBgpNeighborArgs, opts ...ResourceOption) (*PolicyRouteControllerBgpNeighbor, error)public PolicyRouteControllerBgpNeighbor(string name, PolicyRouteControllerBgpNeighborArgs args, CustomResourceOptions? opts = null)
public PolicyRouteControllerBgpNeighbor(String name, PolicyRouteControllerBgpNeighborArgs args)
public PolicyRouteControllerBgpNeighbor(String name, PolicyRouteControllerBgpNeighborArgs args, CustomResourceOptions options)
type: nsxt:PolicyRouteControllerBgpNeighbor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "nsxt_policy_route_controller_bgp_neighbor" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PolicyRouteControllerBgpNeighborArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PolicyRouteControllerBgpNeighborArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PolicyRouteControllerBgpNeighborArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyRouteControllerBgpNeighborArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyRouteControllerBgpNeighborArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var policyRouteControllerBgpNeighborResource = new Nsxt.PolicyRouteControllerBgpNeighbor("policyRouteControllerBgpNeighborResource", new()
{
NeighborAddress = "string",
SourceAddresses = new[]
{
"string",
},
RemoteAsNum = "string",
DisplayName = "string",
ParentPath = "string",
Enabled = false,
AllowAsIn = false,
HoldDownTime = 0.0,
KeepAliveTime = 0.0,
MaximumHopLimit = 0.0,
GatewayIps = new[]
{
"string",
},
NsxId = "string",
GracefulRestartMode = "string",
Password = "string",
PolicyRouteControllerBgpNeighborId = "string",
Description = "string",
RouteFilterings = new[]
{
new Nsxt.Inputs.PolicyRouteControllerBgpNeighborRouteFilteringArgs
{
AddressFamily = "string",
Enabled = false,
InRouteFilter = "string",
MaximumRoutes = 0.0,
OutRouteFilter = "string",
},
},
BfdConfig = new Nsxt.Inputs.PolicyRouteControllerBgpNeighborBfdConfigArgs
{
Enabled = false,
Interval = 0.0,
Multiple = 0.0,
},
Tags = new[]
{
new Nsxt.Inputs.PolicyRouteControllerBgpNeighborTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyRouteControllerBgpNeighbor(ctx, "policyRouteControllerBgpNeighborResource", &nsxt.PolicyRouteControllerBgpNeighborArgs{
NeighborAddress: pulumi.String("string"),
SourceAddresses: pulumi.StringArray{
pulumi.String("string"),
},
RemoteAsNum: pulumi.String("string"),
DisplayName: pulumi.String("string"),
ParentPath: pulumi.String("string"),
Enabled: pulumi.Bool(false),
AllowAsIn: pulumi.Bool(false),
HoldDownTime: pulumi.Float64(0),
KeepAliveTime: pulumi.Float64(0),
MaximumHopLimit: pulumi.Float64(0),
GatewayIps: pulumi.StringArray{
pulumi.String("string"),
},
NsxId: pulumi.String("string"),
GracefulRestartMode: pulumi.String("string"),
Password: pulumi.String("string"),
PolicyRouteControllerBgpNeighborId: pulumi.String("string"),
Description: pulumi.String("string"),
RouteFilterings: nsxt.PolicyRouteControllerBgpNeighborRouteFilteringArray{
&nsxt.PolicyRouteControllerBgpNeighborRouteFilteringArgs{
AddressFamily: pulumi.String("string"),
Enabled: pulumi.Bool(false),
InRouteFilter: pulumi.String("string"),
MaximumRoutes: pulumi.Float64(0),
OutRouteFilter: pulumi.String("string"),
},
},
BfdConfig: &nsxt.PolicyRouteControllerBgpNeighborBfdConfigArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.Float64(0),
Multiple: pulumi.Float64(0),
},
Tags: nsxt.PolicyRouteControllerBgpNeighborTagArray{
&nsxt.PolicyRouteControllerBgpNeighborTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
resource "nsxt_policy_route_controller_bgp_neighbor" "policyRouteControllerBgpNeighborResource" {
lifecycle {
create_before_destroy = true
}
neighbor_address = "string"
source_addresses = ["string"]
remote_as_num = "string"
display_name = "string"
parent_path = "string"
enabled = false
allow_as_in = false
hold_down_time = 0
keep_alive_time = 0
maximum_hop_limit = 0
gateway_ips = ["string"]
nsx_id = "string"
graceful_restart_mode = "string"
password = "string"
policy_route_controller_bgp_neighbor_id = "string"
description = "string"
route_filterings {
address_family = "string"
enabled = false
in_route_filter = "string"
maximum_routes = 0
out_route_filter = "string"
}
bfd_config = {
enabled = false
interval = 0
multiple = 0
}
tags {
scope = "string"
tag = "string"
}
}
var policyRouteControllerBgpNeighborResource = new PolicyRouteControllerBgpNeighbor("policyRouteControllerBgpNeighborResource", PolicyRouteControllerBgpNeighborArgs.builder()
.neighborAddress("string")
.sourceAddresses("string")
.remoteAsNum("string")
.displayName("string")
.parentPath("string")
.enabled(false)
.allowAsIn(false)
.holdDownTime(0.0)
.keepAliveTime(0.0)
.maximumHopLimit(0.0)
.gatewayIps("string")
.nsxId("string")
.gracefulRestartMode("string")
.password("string")
.policyRouteControllerBgpNeighborId("string")
.description("string")
.routeFilterings(PolicyRouteControllerBgpNeighborRouteFilteringArgs.builder()
.addressFamily("string")
.enabled(false)
.inRouteFilter("string")
.maximumRoutes(0.0)
.outRouteFilter("string")
.build())
.bfdConfig(PolicyRouteControllerBgpNeighborBfdConfigArgs.builder()
.enabled(false)
.interval(0.0)
.multiple(0.0)
.build())
.tags(PolicyRouteControllerBgpNeighborTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_route_controller_bgp_neighbor_resource = nsxt.PolicyRouteControllerBgpNeighbor("policyRouteControllerBgpNeighborResource",
neighbor_address="string",
source_addresses=["string"],
remote_as_num="string",
display_name="string",
parent_path="string",
enabled=False,
allow_as_in=False,
hold_down_time=float(0),
keep_alive_time=float(0),
maximum_hop_limit=float(0),
gateway_ips=["string"],
nsx_id="string",
graceful_restart_mode="string",
password="string",
policy_route_controller_bgp_neighbor_id="string",
description="string",
route_filterings=[{
"address_family": "string",
"enabled": False,
"in_route_filter": "string",
"maximum_routes": float(0),
"out_route_filter": "string",
}],
bfd_config={
"enabled": False,
"interval": float(0),
"multiple": float(0),
},
tags=[{
"scope": "string",
"tag": "string",
}])
const policyRouteControllerBgpNeighborResource = new nsxt.PolicyRouteControllerBgpNeighbor("policyRouteControllerBgpNeighborResource", {
neighborAddress: "string",
sourceAddresses: ["string"],
remoteAsNum: "string",
displayName: "string",
parentPath: "string",
enabled: false,
allowAsIn: false,
holdDownTime: 0,
keepAliveTime: 0,
maximumHopLimit: 0,
gatewayIps: ["string"],
nsxId: "string",
gracefulRestartMode: "string",
password: "string",
policyRouteControllerBgpNeighborId: "string",
description: "string",
routeFilterings: [{
addressFamily: "string",
enabled: false,
inRouteFilter: "string",
maximumRoutes: 0,
outRouteFilter: "string",
}],
bfdConfig: {
enabled: false,
interval: 0,
multiple: 0,
},
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyRouteControllerBgpNeighbor
properties:
allowAsIn: false
bfdConfig:
enabled: false
interval: 0
multiple: 0
description: string
displayName: string
enabled: false
gatewayIps:
- string
gracefulRestartMode: string
holdDownTime: 0
keepAliveTime: 0
maximumHopLimit: 0
neighborAddress: string
nsxId: string
parentPath: string
password: string
policyRouteControllerBgpNeighborId: string
remoteAsNum: string
routeFilterings:
- addressFamily: string
enabled: false
inRouteFilter: string
maximumRoutes: 0
outRouteFilter: string
sourceAddresses:
- string
tags:
- scope: string
tag: string
PolicyRouteControllerBgpNeighbor Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PolicyRouteControllerBgpNeighbor resource accepts the following input properties:
- Display
Name string - Display name of the resource.
- Neighbor
Address string - Neighbor IP Address.
- Parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - Remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- Source
Addresses List<string> - List of source IP addresses for BGP peering. Maximum 8 entries.
- Allow
As boolIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - Bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- Description string
- Description of the resource.
- Enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - Gateway
Ips List<string> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- Graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Hold
Down doubleTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - Keep
Alive doubleTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - Maximum
Hop doubleLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- Policy
Route stringController Bgp Neighbor Id - ID of the resource.
- Route
Filterings List<PolicyRoute Controller Bgp Neighbor Route Filtering> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
-
List<Policy
Route Controller Bgp Neighbor Tag> - A list of scope + tag pairs to associate with this resource.
- Display
Name string - Display name of the resource.
- Neighbor
Address string - Neighbor IP Address.
- Parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - Remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- Source
Addresses []string - List of source IP addresses for BGP peering. Maximum 8 entries.
- Allow
As boolIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - Bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config Args - BFD configuration for failure detection. The following arguments are supported:
- Description string
- Description of the resource.
- Enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - Gateway
Ips []string - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- Graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Hold
Down float64Time - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - Keep
Alive float64Time - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - Maximum
Hop float64Limit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- Policy
Route stringController Bgp Neighbor Id - ID of the resource.
- Route
Filterings []PolicyRoute Controller Bgp Neighbor Route Filtering Args - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
-
[]Policy
Route Controller Bgp Neighbor Tag Args - A list of scope + tag pairs to associate with this resource.
- display_
name string - Display name of the resource.
- neighbor_
address string - Neighbor IP Address.
- parent_
path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - remote_
as_ stringnum - ASN of the neighbor in ASPLAIN or ASDOT format.
- source_
addresses list(string) - List of source IP addresses for BGP peering. Maximum 8 entries.
- allow_
as_ boolin - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd_
config object - BFD configuration for failure detection. The following arguments are supported:
- description string
- Description of the resource.
- enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway_
ips list(string) - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful_
restart_ stringmode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold_
down_ numbertime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep_
alive_ numbertime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum_
hop_ numberlimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- policy_
route_ stringcontroller_ bgp_ neighbor_ id - ID of the resource.
- route_
filterings list(object) - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- list(object)
- A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- neighbor
Address String - Neighbor IP Address.
- parent
Path String - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - remote
As StringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- source
Addresses List<String> - List of source IP addresses for BGP peering. Maximum 8 entries.
- allow
As BooleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- description String
- Description of the resource.
- enabled Boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips List<String> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart StringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down DoubleTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive DoubleTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop DoubleLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- password String
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- policy
Route StringController Bgp Neighbor Id - ID of the resource.
- route
Filterings List<PolicyRoute Controller Bgp Neighbor Route Filtering> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
-
List<Policy
Route Controller Bgp Neighbor Tag> - A list of scope + tag pairs to associate with this resource.
- display
Name string - Display name of the resource.
- neighbor
Address string - Neighbor IP Address.
- parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- source
Addresses string[] - List of source IP addresses for BGP peering. Maximum 8 entries.
- allow
As booleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- description string
- Description of the resource.
- enabled boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips string[] - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down numberTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive numberTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop numberLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- policy
Route stringController Bgp Neighbor Id - ID of the resource.
- route
Filterings PolicyRoute Controller Bgp Neighbor Route Filtering[] - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
-
Policy
Route Controller Bgp Neighbor Tag[] - A list of scope + tag pairs to associate with this resource.
- display_
name str - Display name of the resource.
- neighbor_
address str - Neighbor IP Address.
- parent_
path str - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - remote_
as_ strnum - ASN of the neighbor in ASPLAIN or ASDOT format.
- source_
addresses Sequence[str] - List of source IP addresses for BGP peering. Maximum 8 entries.
- allow_
as_ boolin - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd_
config PolicyRoute Controller Bgp Neighbor Bfd Config Args - BFD configuration for failure detection. The following arguments are supported:
- description str
- Description of the resource.
- enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway_
ips Sequence[str] - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful_
restart_ strmode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold_
down_ floattime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep_
alive_ floattime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum_
hop_ floatlimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- password str
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- policy_
route_ strcontroller_ bgp_ neighbor_ id - ID of the resource.
- route_
filterings Sequence[PolicyRoute Controller Bgp Neighbor Route Filtering Args] - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
-
Sequence[Policy
Route Controller Bgp Neighbor Tag Args] - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- neighbor
Address String - Neighbor IP Address.
- parent
Path String - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - remote
As StringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- source
Addresses List<String> - List of source IP addresses for BGP peering. Maximum 8 entries.
- allow
As BooleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config Property Map - BFD configuration for failure detection. The following arguments are supported:
- description String
- Description of the resource.
- enabled Boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips List<String> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart StringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down NumberTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive NumberTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop NumberLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- password String
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- policy
Route StringController Bgp Neighbor Id - ID of the resource.
- route
Filterings List<Property Map> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicyRouteControllerBgpNeighbor resource produces the following output properties:
Look up Existing PolicyRouteControllerBgpNeighbor Resource
Get an existing PolicyRouteControllerBgpNeighbor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PolicyRouteControllerBgpNeighborState, opts?: CustomResourceOptions): PolicyRouteControllerBgpNeighbor@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_as_in: Optional[bool] = None,
bfd_config: Optional[PolicyRouteControllerBgpNeighborBfdConfigArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
enabled: Optional[bool] = None,
gateway_ips: Optional[Sequence[str]] = None,
graceful_restart_mode: Optional[str] = None,
hold_down_time: Optional[float] = None,
keep_alive_time: Optional[float] = None,
maximum_hop_limit: Optional[float] = None,
neighbor_address: Optional[str] = None,
nsx_id: Optional[str] = None,
parent_path: Optional[str] = None,
password: Optional[str] = None,
path: Optional[str] = None,
policy_route_controller_bgp_neighbor_id: Optional[str] = None,
remote_as_num: Optional[str] = None,
revision: Optional[float] = None,
route_filterings: Optional[Sequence[PolicyRouteControllerBgpNeighborRouteFilteringArgs]] = None,
source_addresses: Optional[Sequence[str]] = None,
tags: Optional[Sequence[PolicyRouteControllerBgpNeighborTagArgs]] = None) -> PolicyRouteControllerBgpNeighborfunc GetPolicyRouteControllerBgpNeighbor(ctx *Context, name string, id IDInput, state *PolicyRouteControllerBgpNeighborState, opts ...ResourceOption) (*PolicyRouteControllerBgpNeighbor, error)public static PolicyRouteControllerBgpNeighbor Get(string name, Input<string> id, PolicyRouteControllerBgpNeighborState? state, CustomResourceOptions? opts = null)public static PolicyRouteControllerBgpNeighbor get(String name, Output<String> id, PolicyRouteControllerBgpNeighborState state, CustomResourceOptions options)resources: _: type: nsxt:PolicyRouteControllerBgpNeighbor get: id: ${id}import {
to = nsxt_policy_route_controller_bgp_neighbor.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allow
As boolIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - Bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - Gateway
Ips List<string> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- Graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Hold
Down doubleTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - Keep
Alive doubleTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - Maximum
Hop doubleLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - Neighbor
Address string - Neighbor IP Address.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - Password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- Path string
- The NSX path of the policy resource.
- Policy
Route stringController Bgp Neighbor Id - ID of the resource.
- Remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- Revision double
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Route
Filterings List<PolicyRoute Controller Bgp Neighbor Route Filtering> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- Source
Addresses List<string> - List of source IP addresses for BGP peering. Maximum 8 entries.
-
List<Policy
Route Controller Bgp Neighbor Tag> - A list of scope + tag pairs to associate with this resource.
- Allow
As boolIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - Bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config Args - BFD configuration for failure detection. The following arguments are supported:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - Gateway
Ips []string - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- Graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Hold
Down float64Time - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - Keep
Alive float64Time - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - Maximum
Hop float64Limit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - Neighbor
Address string - Neighbor IP Address.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - Password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- Path string
- The NSX path of the policy resource.
- Policy
Route stringController Bgp Neighbor Id - ID of the resource.
- Remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- Revision float64
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Route
Filterings []PolicyRoute Controller Bgp Neighbor Route Filtering Args - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- Source
Addresses []string - List of source IP addresses for BGP peering. Maximum 8 entries.
-
[]Policy
Route Controller Bgp Neighbor Tag Args - A list of scope + tag pairs to associate with this resource.
- allow_
as_ boolin - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd_
config object - BFD configuration for failure detection. The following arguments are supported:
- description string
- Description of the resource.
- display_
name string - Display name of the resource.
- enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway_
ips list(string) - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful_
restart_ stringmode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold_
down_ numbertime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep_
alive_ numbertime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum_
hop_ numberlimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - neighbor_
address string - Neighbor IP Address.
- nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- parent_
path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- path string
- The NSX path of the policy resource.
- policy_
route_ stringcontroller_ bgp_ neighbor_ id - ID of the resource.
- remote_
as_ stringnum - ASN of the neighbor in ASPLAIN or ASDOT format.
- revision number
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- route_
filterings list(object) - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- source_
addresses list(string) - List of source IP addresses for BGP peering. Maximum 8 entries.
- list(object)
- A list of scope + tag pairs to associate with this resource.
- allow
As BooleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- enabled Boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips List<String> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart StringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down DoubleTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive DoubleTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop DoubleLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - neighbor
Address String - Neighbor IP Address.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- parent
Path String - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - password String
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- path String
- The NSX path of the policy resource.
- policy
Route StringController Bgp Neighbor Id - ID of the resource.
- remote
As StringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- revision Double
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- route
Filterings List<PolicyRoute Controller Bgp Neighbor Route Filtering> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- source
Addresses List<String> - List of source IP addresses for BGP peering. Maximum 8 entries.
-
List<Policy
Route Controller Bgp Neighbor Tag> - A list of scope + tag pairs to associate with this resource.
- allow
As booleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config PolicyRoute Controller Bgp Neighbor Bfd Config - BFD configuration for failure detection. The following arguments are supported:
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- enabled boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips string[] - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart stringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down numberTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive numberTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop numberLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - neighbor
Address string - Neighbor IP Address.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- parent
Path string - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - password string
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- path string
- The NSX path of the policy resource.
- policy
Route stringController Bgp Neighbor Id - ID of the resource.
- remote
As stringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- revision number
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- route
Filterings PolicyRoute Controller Bgp Neighbor Route Filtering[] - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- source
Addresses string[] - List of source IP addresses for BGP peering. Maximum 8 entries.
-
Policy
Route Controller Bgp Neighbor Tag[] - A list of scope + tag pairs to associate with this resource.
- allow_
as_ boolin - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd_
config PolicyRoute Controller Bgp Neighbor Bfd Config Args - BFD configuration for failure detection. The following arguments are supported:
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- enabled bool
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway_
ips Sequence[str] - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful_
restart_ strmode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold_
down_ floattime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep_
alive_ floattime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum_
hop_ floatlimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - neighbor_
address str - Neighbor IP Address.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- parent_
path str - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - password str
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- path str
- The NSX path of the policy resource.
- policy_
route_ strcontroller_ bgp_ neighbor_ id - ID of the resource.
- remote_
as_ strnum - ASN of the neighbor in ASPLAIN or ASDOT format.
- revision float
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- route_
filterings Sequence[PolicyRoute Controller Bgp Neighbor Route Filtering Args] - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- source_
addresses Sequence[str] - List of source IP addresses for BGP peering. Maximum 8 entries.
-
Sequence[Policy
Route Controller Bgp Neighbor Tag Args] - A list of scope + tag pairs to associate with this resource.
- allow
As BooleanIn - Flag to enable allow_as_in option for BGP neighbor. Defaults to
false. - bfd
Config Property Map - BFD configuration for failure detection. The following arguments are supported:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- enabled Boolean
- Flag to enable or disable BGP peering with this neighbor. Defaults to
true. - gateway
Ips List<String> - List of next-hop gateway IP addresses used to reach non-directly connected BGP peers.
- graceful
Restart StringMode - BGP Graceful Restart Configuration Mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - hold
Down NumberTime - Wait time in seconds before declaring peer dead. Must be between 1 and 65535. Defaults to
180. - keep
Alive NumberTime - Interval between keep alive messages sent to peer. Must be between 1 and 65535. Defaults to
60. - maximum
Hop NumberLimit - Maximum number of hops allowed to reach BGP neighbor. Must be between 1 and 255. Defaults to
1. - neighbor
Address String - Neighbor IP Address.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- parent
Path String - Policy path of the parent Route Controller BGP config (e.g.
<route_controller_path>/bgp). - password String
- Password for BGP neighbor authentication. Sensitive value. Maximum 32 characters.
- path String
- The NSX path of the policy resource.
- policy
Route StringController Bgp Neighbor Id - ID of the resource.
- remote
As StringNum - ASN of the neighbor in ASPLAIN or ASDOT format.
- revision Number
- Indicates current revision of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- route
Filterings List<Property Map> - List of address families and route filtering configuration. Maximum 2 entries. The following arguments are supported:
- source
Addresses List<String> - List of source IP addresses for BGP peering. Maximum 8 entries.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
Supporting Types
PolicyRouteControllerBgpNeighborBfdConfig, PolicyRouteControllerBgpNeighborBfdConfigArgs
- Enabled bool
- Flag to enable/disable BFD configuration. Defaults to
false. - Interval double
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - Multiple double
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- Enabled bool
- Flag to enable/disable BFD configuration. Defaults to
false. - Interval float64
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - Multiple float64
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- enabled bool
- Flag to enable/disable BFD configuration. Defaults to
false. - interval number
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - multiple number
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- enabled Boolean
- Flag to enable/disable BFD configuration. Defaults to
false. - interval Double
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - multiple Double
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- enabled boolean
- Flag to enable/disable BFD configuration. Defaults to
false. - interval number
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - multiple number
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- enabled bool
- Flag to enable/disable BFD configuration. Defaults to
false. - interval float
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - multiple float
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
- enabled Boolean
- Flag to enable/disable BFD configuration. Defaults to
false. - interval Number
- Time interval between heartbeat packets in milliseconds. Must be between 50 and 60000. Defaults to
500. - multiple Number
- Number of times heartbeat packet is missed before BFD declares the neighbor is down. Must be between 2 and 16. Defaults to
3.
PolicyRouteControllerBgpNeighborRouteFiltering, PolicyRouteControllerBgpNeighborRouteFilteringArgs
- Address
Family string - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - Enabled bool
- Flag to enable/disable address family. Defaults to
true. - In
Route stringFilter - Policy path of prefix-list or route map for IN direction.
- Maximum
Routes double - Maximum number of routes for the address family. Must be between 1 and 1000000.
- Out
Route stringFilter - Policy path of prefix-list or route map for OUT direction.
- Address
Family string - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - Enabled bool
- Flag to enable/disable address family. Defaults to
true. - In
Route stringFilter - Policy path of prefix-list or route map for IN direction.
- Maximum
Routes float64 - Maximum number of routes for the address family. Must be between 1 and 1000000.
- Out
Route stringFilter - Policy path of prefix-list or route map for OUT direction.
- address_
family string - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - enabled bool
- Flag to enable/disable address family. Defaults to
true. - in_
route_ stringfilter - Policy path of prefix-list or route map for IN direction.
- maximum_
routes number - Maximum number of routes for the address family. Must be between 1 and 1000000.
- out_
route_ stringfilter - Policy path of prefix-list or route map for OUT direction.
- address
Family String - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - enabled Boolean
- Flag to enable/disable address family. Defaults to
true. - in
Route StringFilter - Policy path of prefix-list or route map for IN direction.
- maximum
Routes Double - Maximum number of routes for the address family. Must be between 1 and 1000000.
- out
Route StringFilter - Policy path of prefix-list or route map for OUT direction.
- address
Family string - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - enabled boolean
- Flag to enable/disable address family. Defaults to
true. - in
Route stringFilter - Policy path of prefix-list or route map for IN direction.
- maximum
Routes number - Maximum number of routes for the address family. Must be between 1 and 1000000.
- out
Route stringFilter - Policy path of prefix-list or route map for OUT direction.
- address_
family str - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - enabled bool
- Flag to enable/disable address family. Defaults to
true. - in_
route_ strfilter - Policy path of prefix-list or route map for IN direction.
- maximum_
routes float - Maximum number of routes for the address family. Must be between 1 and 1000000.
- out_
route_ strfilter - Policy path of prefix-list or route map for OUT direction.
- address
Family String - Address family type. One of
IPV4,IPV6,L2VPN_EVPN. - enabled Boolean
- Flag to enable/disable address family. Defaults to
true. - in
Route StringFilter - Policy path of prefix-list or route map for IN direction.
- maximum
Routes Number - Maximum number of routes for the address family. Must be between 1 and 1000000.
- out
Route StringFilter - Policy path of prefix-list or route map for OUT direction.
PolicyRouteControllerBgpNeighborTag, PolicyRouteControllerBgpNeighborTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
published on Friday, Sep 11, 2026 by vmware