published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware
Create PolicyRouteController Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyRouteController(name: string, args: PolicyRouteControllerArgs, opts?: CustomResourceOptions);@overload
def PolicyRouteController(resource_name: str,
args: PolicyRouteControllerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyRouteController(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
virtual_network_appliance_cluster_path: Optional[str] = None,
bgp_config: Optional[PolicyRouteControllerBgpConfigArgs] = None,
description: Optional[str] = None,
ha_mode: Optional[str] = None,
nsx_id: Optional[str] = None,
policy_route_controller_id: Optional[str] = None,
tags: Optional[Sequence[PolicyRouteControllerTagArgs]] = None)func NewPolicyRouteController(ctx *Context, name string, args PolicyRouteControllerArgs, opts ...ResourceOption) (*PolicyRouteController, error)public PolicyRouteController(string name, PolicyRouteControllerArgs args, CustomResourceOptions? opts = null)
public PolicyRouteController(String name, PolicyRouteControllerArgs args)
public PolicyRouteController(String name, PolicyRouteControllerArgs args, CustomResourceOptions options)
type: nsxt:PolicyRouteController
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "nsxt_policy_route_controller" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PolicyRouteControllerArgs
- 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 PolicyRouteControllerArgs
- 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 PolicyRouteControllerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyRouteControllerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyRouteControllerArgs
- 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 policyRouteControllerResource = new Nsxt.PolicyRouteController("policyRouteControllerResource", new()
{
DisplayName = "string",
VirtualNetworkApplianceClusterPath = "string",
BgpConfig = new Nsxt.Inputs.PolicyRouteControllerBgpConfigArgs
{
LocalAsNum = "string",
Ecmp = false,
GracefulRestartMode = "string",
GracefulRestartTimer = 0.0,
MultipathRelax = false,
Path = "string",
PeerRouteConvergenceTimer = 0.0,
Revision = 0.0,
},
Description = "string",
HaMode = "string",
NsxId = "string",
PolicyRouteControllerId = "string",
Tags = new[]
{
new Nsxt.Inputs.PolicyRouteControllerTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyRouteController(ctx, "policyRouteControllerResource", &nsxt.PolicyRouteControllerArgs{
DisplayName: pulumi.String("string"),
VirtualNetworkApplianceClusterPath: pulumi.String("string"),
BgpConfig: &nsxt.PolicyRouteControllerBgpConfigArgs{
LocalAsNum: pulumi.String("string"),
Ecmp: pulumi.Bool(false),
GracefulRestartMode: pulumi.String("string"),
GracefulRestartTimer: pulumi.Float64(0),
MultipathRelax: pulumi.Bool(false),
Path: pulumi.String("string"),
PeerRouteConvergenceTimer: pulumi.Float64(0),
Revision: pulumi.Float64(0),
},
Description: pulumi.String("string"),
HaMode: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyRouteControllerId: pulumi.String("string"),
Tags: nsxt.PolicyRouteControllerTagArray{
&nsxt.PolicyRouteControllerTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
resource "nsxt_policy_route_controller" "policyRouteControllerResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
virtual_network_appliance_cluster_path = "string"
bgp_config = {
local_as_num = "string"
ecmp = false
graceful_restart_mode = "string"
graceful_restart_timer = 0
multipath_relax = false
path = "string"
peer_route_convergence_timer = 0
revision = 0
}
description = "string"
ha_mode = "string"
nsx_id = "string"
policy_route_controller_id = "string"
tags {
scope = "string"
tag = "string"
}
}
var policyRouteControllerResource = new PolicyRouteController("policyRouteControllerResource", PolicyRouteControllerArgs.builder()
.displayName("string")
.virtualNetworkApplianceClusterPath("string")
.bgpConfig(PolicyRouteControllerBgpConfigArgs.builder()
.localAsNum("string")
.ecmp(false)
.gracefulRestartMode("string")
.gracefulRestartTimer(0.0)
.multipathRelax(false)
.path("string")
.peerRouteConvergenceTimer(0.0)
.revision(0.0)
.build())
.description("string")
.haMode("string")
.nsxId("string")
.policyRouteControllerId("string")
.tags(PolicyRouteControllerTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_route_controller_resource = nsxt.PolicyRouteController("policyRouteControllerResource",
display_name="string",
virtual_network_appliance_cluster_path="string",
bgp_config={
"local_as_num": "string",
"ecmp": False,
"graceful_restart_mode": "string",
"graceful_restart_timer": float(0),
"multipath_relax": False,
"path": "string",
"peer_route_convergence_timer": float(0),
"revision": float(0),
},
description="string",
ha_mode="string",
nsx_id="string",
policy_route_controller_id="string",
tags=[{
"scope": "string",
"tag": "string",
}])
const policyRouteControllerResource = new nsxt.PolicyRouteController("policyRouteControllerResource", {
displayName: "string",
virtualNetworkApplianceClusterPath: "string",
bgpConfig: {
localAsNum: "string",
ecmp: false,
gracefulRestartMode: "string",
gracefulRestartTimer: 0,
multipathRelax: false,
path: "string",
peerRouteConvergenceTimer: 0,
revision: 0,
},
description: "string",
haMode: "string",
nsxId: "string",
policyRouteControllerId: "string",
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyRouteController
properties:
bgpConfig:
ecmp: false
gracefulRestartMode: string
gracefulRestartTimer: 0
localAsNum: string
multipathRelax: false
path: string
peerRouteConvergenceTimer: 0
revision: 0
description: string
displayName: string
haMode: string
nsxId: string
policyRouteControllerId: string
tags:
- scope: string
tag: string
virtualNetworkApplianceClusterPath: string
PolicyRouteController 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 PolicyRouteController resource accepts the following input properties:
- Display
Name string - Display name of the resource.
- Virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- Bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- Description string
- Description of the resource.
- Ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Route stringController Id - ID of the resource.
-
List<Policy
Route Controller Tag> - A list of scope + tag pairs to associate with this resource.
- Display
Name string - Display name of the resource.
- Virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- Bgp
Config PolicyRoute Controller Bgp Config Args - BGP routing configuration block. The following arguments are supported:
- Description string
- Description of the resource.
- Ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Route stringController Id - ID of the resource.
-
[]Policy
Route Controller Tag Args - A list of scope + tag pairs to associate with this resource.
- display_
name string - Display name of the resource.
- virtual_
network_ stringappliance_ cluster_ path - Policy path for the virtual network appliance cluster.
- bgp_
config object - BGP routing configuration block. The following arguments are supported:
- description string
- Description of the resource.
- ha_
mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
route_ stringcontroller_ id - ID of the resource.
- list(object)
- A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- virtual
Network StringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- description String
- Description of the resource.
- ha
Mode String - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Route StringController Id - ID of the resource.
-
List<Policy
Route Controller Tag> - A list of scope + tag pairs to associate with this resource.
- display
Name string - Display name of the resource.
- virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- description string
- Description of the resource.
- ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Route stringController Id - ID of the resource.
-
Policy
Route Controller Tag[] - A list of scope + tag pairs to associate with this resource.
- display_
name str - Display name of the resource.
- virtual_
network_ strappliance_ cluster_ path - Policy path for the virtual network appliance cluster.
- bgp_
config PolicyRoute Controller Bgp Config Args - BGP routing configuration block. The following arguments are supported:
- description str
- Description of the resource.
- ha_
mode str - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
route_ strcontroller_ id - ID of the resource.
-
Sequence[Policy
Route Controller Tag Args] - A list of scope + tag pairs to associate with this resource.
- display
Name String - Display name of the resource.
- virtual
Network StringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp
Config Property Map - BGP routing configuration block. The following arguments are supported:
- description String
- Description of the resource.
- ha
Mode String - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Route StringController Id - ID of the resource.
- 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 PolicyRouteController resource produces the following output properties:
Look up Existing PolicyRouteController Resource
Get an existing PolicyRouteController 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?: PolicyRouteControllerState, opts?: CustomResourceOptions): PolicyRouteController@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bgp_config: Optional[PolicyRouteControllerBgpConfigArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
ha_mode: Optional[str] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
policy_route_controller_id: Optional[str] = None,
revision: Optional[float] = None,
tags: Optional[Sequence[PolicyRouteControllerTagArgs]] = None,
virtual_network_appliance_cluster_path: Optional[str] = None) -> PolicyRouteControllerfunc GetPolicyRouteController(ctx *Context, name string, id IDInput, state *PolicyRouteControllerState, opts ...ResourceOption) (*PolicyRouteController, error)public static PolicyRouteController Get(string name, Input<string> id, PolicyRouteControllerState? state, CustomResourceOptions? opts = null)public static PolicyRouteController get(String name, Output<String> id, PolicyRouteControllerState state, CustomResourceOptions options)resources: _: type: nsxt:PolicyRouteController get: id: ${id}import {
to = nsxt_policy_route_controller.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.
- Bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the BGP configuration.
- Policy
Route stringController Id - ID of the resource.
- Revision double
- Indicates current revision number of the BGP configuration object.
-
List<Policy
Route Controller Tag> - A list of scope + tag pairs to associate with this resource.
- Virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- Bgp
Config PolicyRoute Controller Bgp Config Args - BGP routing configuration block. The following arguments are supported:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the BGP configuration.
- Policy
Route stringController Id - ID of the resource.
- Revision float64
- Indicates current revision number of the BGP configuration object.
-
[]Policy
Route Controller Tag Args - A list of scope + tag pairs to associate with this resource.
- Virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp_
config object - BGP routing configuration block. The following arguments are supported:
- description string
- Description of the resource.
- display_
name string - Display name of the resource.
- ha_
mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx_
id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the BGP configuration.
- policy_
route_ stringcontroller_ id - ID of the resource.
- revision number
- Indicates current revision number of the BGP configuration object.
- list(object)
- A list of scope + tag pairs to associate with this resource.
- virtual_
network_ stringappliance_ cluster_ path - Policy path for the virtual network appliance cluster.
- bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- ha
Mode String - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the BGP configuration.
- policy
Route StringController Id - ID of the resource.
- revision Double
- Indicates current revision number of the BGP configuration object.
-
List<Policy
Route Controller Tag> - A list of scope + tag pairs to associate with this resource.
- virtual
Network StringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp
Config PolicyRoute Controller Bgp Config - BGP routing configuration block. The following arguments are supported:
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- ha
Mode string - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the BGP configuration.
- policy
Route stringController Id - ID of the resource.
- revision number
- Indicates current revision number of the BGP configuration object.
-
Policy
Route Controller Tag[] - A list of scope + tag pairs to associate with this resource.
- virtual
Network stringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
- bgp_
config PolicyRoute Controller Bgp Config Args - BGP routing configuration block. The following arguments are supported:
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- ha_
mode str - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the BGP configuration.
- policy_
route_ strcontroller_ id - ID of the resource.
- revision float
- Indicates current revision number of the BGP configuration object.
-
Sequence[Policy
Route Controller Tag Args] - A list of scope + tag pairs to associate with this resource.
- virtual_
network_ strappliance_ cluster_ path - Policy path for the virtual network appliance cluster.
- bgp
Config Property Map - BGP routing configuration block. The following arguments are supported:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- ha
Mode String - High-availability mode for route controller. Currently only
ACTIVE_STANDBYis supported. This value is computed if not specified. - nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the BGP configuration.
- policy
Route StringController Id - ID of the resource.
- revision Number
- Indicates current revision number of the BGP configuration object.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- virtual
Network StringAppliance Cluster Path - Policy path for the virtual network appliance cluster.
Supporting Types
PolicyRouteControllerBgpConfig, PolicyRouteControllerBgpConfigArgs
- Local
As stringNum - BGP AS number in ASPLAIN/ASDOT format.
- Ecmp bool
- Flag to enable ECMP. Defaults to
true. - Graceful
Restart stringMode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Graceful
Restart doubleTimer - BGP graceful restart timer in seconds. Defaults to
180. - Multipath
Relax bool - Flag to enable BGP multipath relax option.
- Path string
- The NSX path of the BGP configuration.
- Peer
Route doubleConvergence Timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- Revision double
- Indicates current revision number of the BGP configuration object.
- Local
As stringNum - BGP AS number in ASPLAIN/ASDOT format.
- Ecmp bool
- Flag to enable ECMP. Defaults to
true. - Graceful
Restart stringMode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - Graceful
Restart float64Timer - BGP graceful restart timer in seconds. Defaults to
180. - Multipath
Relax bool - Flag to enable BGP multipath relax option.
- Path string
- The NSX path of the BGP configuration.
- Peer
Route float64Convergence Timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- Revision float64
- Indicates current revision number of the BGP configuration object.
- local_
as_ stringnum - BGP AS number in ASPLAIN/ASDOT format.
- ecmp bool
- Flag to enable ECMP. Defaults to
true. - graceful_
restart_ stringmode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - graceful_
restart_ numbertimer - BGP graceful restart timer in seconds. Defaults to
180. - multipath_
relax bool - Flag to enable BGP multipath relax option.
- path string
- The NSX path of the BGP configuration.
- peer_
route_ numberconvergence_ timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- revision number
- Indicates current revision number of the BGP configuration object.
- local
As StringNum - BGP AS number in ASPLAIN/ASDOT format.
- ecmp Boolean
- Flag to enable ECMP. Defaults to
true. - graceful
Restart StringMode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - graceful
Restart DoubleTimer - BGP graceful restart timer in seconds. Defaults to
180. - multipath
Relax Boolean - Flag to enable BGP multipath relax option.
- path String
- The NSX path of the BGP configuration.
- peer
Route DoubleConvergence Timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- revision Double
- Indicates current revision number of the BGP configuration object.
- local
As stringNum - BGP AS number in ASPLAIN/ASDOT format.
- ecmp boolean
- Flag to enable ECMP. Defaults to
true. - graceful
Restart stringMode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - graceful
Restart numberTimer - BGP graceful restart timer in seconds. Defaults to
180. - multipath
Relax boolean - Flag to enable BGP multipath relax option.
- path string
- The NSX path of the BGP configuration.
- peer
Route numberConvergence Timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- revision number
- Indicates current revision number of the BGP configuration object.
- local_
as_ strnum - BGP AS number in ASPLAIN/ASDOT format.
- ecmp bool
- Flag to enable ECMP. Defaults to
true. - graceful_
restart_ strmode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - graceful_
restart_ floattimer - BGP graceful restart timer in seconds. Defaults to
180. - multipath_
relax bool - Flag to enable BGP multipath relax option.
- path str
- The NSX path of the BGP configuration.
- peer_
route_ floatconvergence_ timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- revision float
- Indicates current revision number of the BGP configuration object.
- local
As StringNum - BGP AS number in ASPLAIN/ASDOT format.
- ecmp Boolean
- Flag to enable ECMP. Defaults to
true. - graceful
Restart StringMode - BGP graceful restart configuration mode. One of
DISABLE,GR_AND_HELPER,HELPER_ONLY. Defaults toHELPER_ONLY. - graceful
Restart NumberTimer - BGP graceful restart timer in seconds. Defaults to
180. - multipath
Relax Boolean - Flag to enable BGP multipath relax option.
- path String
- The NSX path of the BGP configuration.
- peer
Route NumberConvergence Timer - Extra time in seconds the router waits before sending UP notification after the peer session is established.
- revision Number
- Indicates current revision number of the BGP configuration object.
PolicyRouteControllerTag, PolicyRouteControllerTagArgs
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