Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyBgpConfig
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyBgpConfig

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

Create PolicyBgpConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PolicyBgpConfig(name: string, args: PolicyBgpConfigArgs, opts?: CustomResourceOptions);
@overload
def PolicyBgpConfig(resource_name: str,
                    args: PolicyBgpConfigArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PolicyBgpConfig(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    gateway_path: Optional[str] = None,
                    inter_sr_ibgp: Optional[bool] = None,
                    enabled: Optional[bool] = None,
                    graceful_restart_mode: Optional[str] = None,
                    graceful_restart_stale_route_timer: Optional[float] = None,
                    graceful_restart_timer: Optional[float] = None,
                    ecmp: Optional[bool] = None,
                    local_as_num: Optional[str] = None,
                    multipath_relax: Optional[bool] = None,
                    policy_bgp_config_id: Optional[str] = None,
                    route_aggregations: Optional[Sequence[PolicyBgpConfigRouteAggregationArgs]] = None,
                    site_path: Optional[str] = None,
                    tags: Optional[Sequence[PolicyBgpConfigTagArgs]] = None)
func NewPolicyBgpConfig(ctx *Context, name string, args PolicyBgpConfigArgs, opts ...ResourceOption) (*PolicyBgpConfig, error)
public PolicyBgpConfig(string name, PolicyBgpConfigArgs args, CustomResourceOptions? opts = null)
public PolicyBgpConfig(String name, PolicyBgpConfigArgs args)
public PolicyBgpConfig(String name, PolicyBgpConfigArgs args, CustomResourceOptions options)

type: nsxt:PolicyBgpConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyBgpConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyBgpConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyBgpConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyBgpConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyBgpConfigArgs
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 policyBgpConfigResource = new Nsxt.PolicyBgpConfig("policyBgpConfigResource", new()
{
    GatewayPath = "string",
    InterSrIbgp = false,
    Enabled = false,
    GracefulRestartMode = "string",
    GracefulRestartStaleRouteTimer = 0,
    GracefulRestartTimer = 0,
    Ecmp = false,
    LocalAsNum = "string",
    MultipathRelax = false,
    PolicyBgpConfigId = "string",
    RouteAggregations = new[]
    {
        new Nsxt.Inputs.PolicyBgpConfigRouteAggregationArgs
        {
            Prefix = "string",
            SummaryOnly = false,
        },
    },
    SitePath = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyBgpConfigTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyBgpConfig(ctx, "policyBgpConfigResource", &nsxt.PolicyBgpConfigArgs{
GatewayPath: pulumi.String("string"),
InterSrIbgp: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
GracefulRestartMode: pulumi.String("string"),
GracefulRestartStaleRouteTimer: pulumi.Float64(0),
GracefulRestartTimer: pulumi.Float64(0),
Ecmp: pulumi.Bool(false),
LocalAsNum: pulumi.String("string"),
MultipathRelax: pulumi.Bool(false),
PolicyBgpConfigId: pulumi.String("string"),
RouteAggregations: .PolicyBgpConfigRouteAggregationArray{
&.PolicyBgpConfigRouteAggregationArgs{
Prefix: pulumi.String("string"),
SummaryOnly: pulumi.Bool(false),
},
},
SitePath: pulumi.String("string"),
Tags: .PolicyBgpConfigTagArray{
&.PolicyBgpConfigTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var policyBgpConfigResource = new PolicyBgpConfig("policyBgpConfigResource", PolicyBgpConfigArgs.builder()
    .gatewayPath("string")
    .interSrIbgp(false)
    .enabled(false)
    .gracefulRestartMode("string")
    .gracefulRestartStaleRouteTimer(0)
    .gracefulRestartTimer(0)
    .ecmp(false)
    .localAsNum("string")
    .multipathRelax(false)
    .policyBgpConfigId("string")
    .routeAggregations(PolicyBgpConfigRouteAggregationArgs.builder()
        .prefix("string")
        .summaryOnly(false)
        .build())
    .sitePath("string")
    .tags(PolicyBgpConfigTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_bgp_config_resource = nsxt.PolicyBgpConfig("policyBgpConfigResource",
    gateway_path="string",
    inter_sr_ibgp=False,
    enabled=False,
    graceful_restart_mode="string",
    graceful_restart_stale_route_timer=0,
    graceful_restart_timer=0,
    ecmp=False,
    local_as_num="string",
    multipath_relax=False,
    policy_bgp_config_id="string",
    route_aggregations=[{
        "prefix": "string",
        "summary_only": False,
    }],
    site_path="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyBgpConfigResource = new nsxt.PolicyBgpConfig("policyBgpConfigResource", {
    gatewayPath: "string",
    interSrIbgp: false,
    enabled: false,
    gracefulRestartMode: "string",
    gracefulRestartStaleRouteTimer: 0,
    gracefulRestartTimer: 0,
    ecmp: false,
    localAsNum: "string",
    multipathRelax: false,
    policyBgpConfigId: "string",
    routeAggregations: [{
        prefix: "string",
        summaryOnly: false,
    }],
    sitePath: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyBgpConfig
properties:
    ecmp: false
    enabled: false
    gatewayPath: string
    gracefulRestartMode: string
    gracefulRestartStaleRouteTimer: 0
    gracefulRestartTimer: 0
    interSrIbgp: false
    localAsNum: string
    multipathRelax: false
    policyBgpConfigId: string
    routeAggregations:
        - prefix: string
          summaryOnly: false
    sitePath: string
    tags:
        - scope: string
          tag: string
Copy

PolicyBgpConfig 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 PolicyBgpConfig resource accepts the following input properties:

GatewayPath This property is required. string
Gateway for this BGP config
Ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
Enabled bool
A boolean flag to enable/disable BGP. Default is true.
GracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
GracefulRestartStaleRouteTimer double
BGP stale route timer. Default is 600.
GracefulRestartTimer double
BGP graceful restart timer. Default is 180.
InterSrIbgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
LocalAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
MultipathRelax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
PolicyBgpConfigId string
ID of the resource.
RouteAggregations List<PolicyBgpConfigRouteAggregation>
Zero or more route aggregations for BGP.
SitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
Tags List<PolicyBgpConfigTag>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
GatewayPath This property is required. string
Gateway for this BGP config
Ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
Enabled bool
A boolean flag to enable/disable BGP. Default is true.
GracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
GracefulRestartStaleRouteTimer float64
BGP stale route timer. Default is 600.
GracefulRestartTimer float64
BGP graceful restart timer. Default is 180.
InterSrIbgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
LocalAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
MultipathRelax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
PolicyBgpConfigId string
ID of the resource.
RouteAggregations []PolicyBgpConfigRouteAggregationArgs
Zero or more route aggregations for BGP.
SitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
Tags []PolicyBgpConfigTagArgs
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
gatewayPath This property is required. String
Gateway for this BGP config
ecmp Boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled Boolean
A boolean flag to enable/disable BGP. Default is true.
gracefulRestartMode String
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer Double
BGP stale route timer. Default is 600.
gracefulRestartTimer Double
BGP graceful restart timer. Default is 180.
interSrIbgp Boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum String
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
multipathRelax Boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
policyBgpConfigId String
ID of the resource.
routeAggregations List<PolicyBgpConfigRouteAggregation>
Zero or more route aggregations for BGP.
sitePath String
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags List<PolicyBgpConfigTag>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
gatewayPath This property is required. string
Gateway for this BGP config
ecmp boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled boolean
A boolean flag to enable/disable BGP. Default is true.
gracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer number
BGP stale route timer. Default is 600.
gracefulRestartTimer number
BGP graceful restart timer. Default is 180.
interSrIbgp boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
multipathRelax boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
policyBgpConfigId string
ID of the resource.
routeAggregations PolicyBgpConfigRouteAggregation[]
Zero or more route aggregations for BGP.
sitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags PolicyBgpConfigTag[]
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
gateway_path This property is required. str
Gateway for this BGP config
ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
enabled bool
A boolean flag to enable/disable BGP. Default is true.
graceful_restart_mode str
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
graceful_restart_stale_route_timer float
BGP stale route timer. Default is 600.
graceful_restart_timer float
BGP graceful restart timer. Default is 180.
inter_sr_ibgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
local_as_num str
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
multipath_relax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
policy_bgp_config_id str
ID of the resource.
route_aggregations Sequence[PolicyBgpConfigRouteAggregationArgs]
Zero or more route aggregations for BGP.
site_path str
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags Sequence[PolicyBgpConfigTagArgs]
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
gatewayPath This property is required. String
Gateway for this BGP config
ecmp Boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled Boolean
A boolean flag to enable/disable BGP. Default is true.
gracefulRestartMode String
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer Number
BGP stale route timer. Default is 600.
gracefulRestartTimer Number
BGP graceful restart timer. Default is 180.
interSrIbgp Boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum String
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
multipathRelax Boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
policyBgpConfigId String
ID of the resource.
routeAggregations List<Property Map>
Zero or more route aggregations for BGP.
sitePath String
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags List<Property Map>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyBgpConfig resource produces the following output properties:

GatewayId string
NSX ID of associated Tier0 Gateway
Id string
The provider-assigned unique ID for this managed resource.
LocaleServiceId string
NSX ID of associated Gateway Locale Service
Path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
GatewayId string
NSX ID of associated Tier0 Gateway
Id string
The provider-assigned unique ID for this managed resource.
LocaleServiceId string
NSX ID of associated Gateway Locale Service
Path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
gatewayId String
NSX ID of associated Tier0 Gateway
id String
The provider-assigned unique ID for this managed resource.
localeServiceId String
NSX ID of associated Gateway Locale Service
path String
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
gatewayId string
NSX ID of associated Tier0 Gateway
id string
The provider-assigned unique ID for this managed resource.
localeServiceId string
NSX ID of associated Gateway Locale Service
path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
gateway_id str
NSX ID of associated Tier0 Gateway
id str
The provider-assigned unique ID for this managed resource.
locale_service_id str
NSX ID of associated Gateway Locale Service
path str
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
gatewayId String
NSX ID of associated Tier0 Gateway
id String
The provider-assigned unique ID for this managed resource.
localeServiceId String
NSX ID of associated Gateway Locale Service
path String
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing PolicyBgpConfig Resource

Get an existing PolicyBgpConfig 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?: PolicyBgpConfigState, opts?: CustomResourceOptions): PolicyBgpConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ecmp: Optional[bool] = None,
        enabled: Optional[bool] = None,
        gateway_id: Optional[str] = None,
        gateway_path: Optional[str] = None,
        graceful_restart_mode: Optional[str] = None,
        graceful_restart_stale_route_timer: Optional[float] = None,
        graceful_restart_timer: Optional[float] = None,
        inter_sr_ibgp: Optional[bool] = None,
        local_as_num: Optional[str] = None,
        locale_service_id: Optional[str] = None,
        multipath_relax: Optional[bool] = None,
        path: Optional[str] = None,
        policy_bgp_config_id: Optional[str] = None,
        revision: Optional[float] = None,
        route_aggregations: Optional[Sequence[PolicyBgpConfigRouteAggregationArgs]] = None,
        site_path: Optional[str] = None,
        tags: Optional[Sequence[PolicyBgpConfigTagArgs]] = None) -> PolicyBgpConfig
func GetPolicyBgpConfig(ctx *Context, name string, id IDInput, state *PolicyBgpConfigState, opts ...ResourceOption) (*PolicyBgpConfig, error)
public static PolicyBgpConfig Get(string name, Input<string> id, PolicyBgpConfigState? state, CustomResourceOptions? opts = null)
public static PolicyBgpConfig get(String name, Output<String> id, PolicyBgpConfigState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyBgpConfig    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
Enabled bool
A boolean flag to enable/disable BGP. Default is true.
GatewayId string
NSX ID of associated Tier0 Gateway
GatewayPath string
Gateway for this BGP config
GracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
GracefulRestartStaleRouteTimer double
BGP stale route timer. Default is 600.
GracefulRestartTimer double
BGP graceful restart timer. Default is 180.
InterSrIbgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
LocalAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
LocaleServiceId string
NSX ID of associated Gateway Locale Service
MultipathRelax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
Path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
PolicyBgpConfigId string
ID of the resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
RouteAggregations List<PolicyBgpConfigRouteAggregation>
Zero or more route aggregations for BGP.
SitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
Tags List<PolicyBgpConfigTag>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
Ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
Enabled bool
A boolean flag to enable/disable BGP. Default is true.
GatewayId string
NSX ID of associated Tier0 Gateway
GatewayPath string
Gateway for this BGP config
GracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
GracefulRestartStaleRouteTimer float64
BGP stale route timer. Default is 600.
GracefulRestartTimer float64
BGP graceful restart timer. Default is 180.
InterSrIbgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
LocalAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
LocaleServiceId string
NSX ID of associated Gateway Locale Service
MultipathRelax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
Path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
PolicyBgpConfigId string
ID of the resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
RouteAggregations []PolicyBgpConfigRouteAggregationArgs
Zero or more route aggregations for BGP.
SitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
Tags []PolicyBgpConfigTagArgs
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
ecmp Boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled Boolean
A boolean flag to enable/disable BGP. Default is true.
gatewayId String
NSX ID of associated Tier0 Gateway
gatewayPath String
Gateway for this BGP config
gracefulRestartMode String
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer Double
BGP stale route timer. Default is 600.
gracefulRestartTimer Double
BGP graceful restart timer. Default is 180.
interSrIbgp Boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum String
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
localeServiceId String
NSX ID of associated Gateway Locale Service
multipathRelax Boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
path String
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
policyBgpConfigId String
ID of the resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
routeAggregations List<PolicyBgpConfigRouteAggregation>
Zero or more route aggregations for BGP.
sitePath String
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags List<PolicyBgpConfigTag>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
ecmp boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled boolean
A boolean flag to enable/disable BGP. Default is true.
gatewayId string
NSX ID of associated Tier0 Gateway
gatewayPath string
Gateway for this BGP config
gracefulRestartMode string
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer number
BGP stale route timer. Default is 600.
gracefulRestartTimer number
BGP graceful restart timer. Default is 180.
interSrIbgp boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum string
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
localeServiceId string
NSX ID of associated Gateway Locale Service
multipathRelax boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
path string
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
policyBgpConfigId string
ID of the resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
routeAggregations PolicyBgpConfigRouteAggregation[]
Zero or more route aggregations for BGP.
sitePath string
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags PolicyBgpConfigTag[]
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
ecmp bool
A boolean flag to enable/disable ECMP. Default is true.
enabled bool
A boolean flag to enable/disable BGP. Default is true.
gateway_id str
NSX ID of associated Tier0 Gateway
gateway_path str
Gateway for this BGP config
graceful_restart_mode str
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
graceful_restart_stale_route_timer float
BGP stale route timer. Default is 600.
graceful_restart_timer float
BGP graceful restart timer. Default is 180.
inter_sr_ibgp bool
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
local_as_num str
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
locale_service_id str
NSX ID of associated Gateway Locale Service
multipath_relax bool
A boolean flag to enable/disable multipath relax for BGP. Default is true.
path str
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
policy_bgp_config_id str
ID of the resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
route_aggregations Sequence[PolicyBgpConfigRouteAggregationArgs]
Zero or more route aggregations for BGP.
site_path str
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags Sequence[PolicyBgpConfigTagArgs]
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
ecmp Boolean
A boolean flag to enable/disable ECMP. Default is true.
enabled Boolean
A boolean flag to enable/disable BGP. Default is true.
gatewayId String
NSX ID of associated Tier0 Gateway
gatewayPath String
Gateway for this BGP config
gracefulRestartMode String
Setting to control BGP graceful restart mode, one of DISABLE, GR_AND_HELPER, HELPER_ONLY.
gracefulRestartStaleRouteTimer Number
BGP stale route timer. Default is 600.
gracefulRestartTimer Number
BGP graceful restart timer. Default is 180.
interSrIbgp Boolean
A boolean flag to enable/disable inter SR IBGP configuration. Default is true.
localAsNum String
BGP AS number in ASPLAIN/ASDOT Format. This attribute is optional for VRF-Lite gateways, and is required otherwise.
localeServiceId String
NSX ID of associated Gateway Locale Service
multipathRelax Boolean
A boolean flag to enable/disable multipath relax for BGP. Default is true.
path String
The NSX path of the policy resource. This path should be used as bgp_path in nsxt.PolicyBgpNeighbor resource configuration.
policyBgpConfigId String
ID of the resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
routeAggregations List<Property Map>
Zero or more route aggregations for BGP.
sitePath String
Path for policy site. This attribute is required for Global Manager and is not relevant for Local Manager.
tags List<Property Map>
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.

Supporting Types

PolicyBgpConfigRouteAggregation
, PolicyBgpConfigRouteAggregationArgs

Prefix string
CIDR of aggregate address.
SummaryOnly bool
A boolean flag to enable/disable summarized route info. Default is true.
Prefix string
CIDR of aggregate address.
SummaryOnly bool
A boolean flag to enable/disable summarized route info. Default is true.
prefix String
CIDR of aggregate address.
summaryOnly Boolean
A boolean flag to enable/disable summarized route info. Default is true.
prefix string
CIDR of aggregate address.
summaryOnly boolean
A boolean flag to enable/disable summarized route info. Default is true.
prefix str
CIDR of aggregate address.
summary_only bool
A boolean flag to enable/disable summarized route info. Default is true.
prefix String
CIDR of aggregate address.
summaryOnly Boolean
A boolean flag to enable/disable summarized route info. Default is true.

PolicyBgpConfigTag
, PolicyBgpConfigTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
Scope string
Tag string
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
scope String
tag String
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
scope string
tag string
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
scope str
tag str
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.
scope String
tag String
A list of scope + tag pairs to associate with this Tier-0 gateway's BGP configuration.

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt