Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyBgpNeighbor
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyBgpNeighbor

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyBgpNeighbor Resource

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

    Constructor syntax

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

@overload
def PolicyBgpNeighbor(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      remote_as_num: Optional[str] = None,
                      bgp_path: Optional[str] = None,
                      neighbor_address: Optional[str] = None,
                      maximum_hop_limit: Optional[float] = None,
                      graceful_restart_mode: Optional[str] = None,
                      hold_down_time: Optional[float] = None,
                      keep_alive_time: Optional[float] = None,
                      allow_as_in: Optional[bool] = None,
                      description: Optional[str] = None,
                      nsx_id: Optional[str] = None,
                      password: Optional[str] = None,
                      policy_bgp_neighbor_id: Optional[str] = None,
                      bfd_config: Optional[PolicyBgpNeighborBfdConfigArgs] = None,
                      route_filterings: Optional[Sequence[PolicyBgpNeighborRouteFilteringArgs]] = None,
                      source_addresses: Optional[Sequence[str]] = None,
                      tags: Optional[Sequence[PolicyBgpNeighborTagArgs]] = None)
    func NewPolicyBgpNeighbor(ctx *Context, name string, args PolicyBgpNeighborArgs, opts ...ResourceOption) (*PolicyBgpNeighbor, error)
    public PolicyBgpNeighbor(string name, PolicyBgpNeighborArgs args, CustomResourceOptions? opts = null)
    public PolicyBgpNeighbor(String name, PolicyBgpNeighborArgs args)
public PolicyBgpNeighbor(String name, PolicyBgpNeighborArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PolicyBgpNeighborArgs
    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 PolicyBgpNeighborArgs
    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 PolicyBgpNeighborArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyBgpNeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyBgpNeighborArgs
    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 policyBgpNeighborResource = new Nsxt.PolicyBgpNeighbor("policyBgpNeighborResource", new()
{
    DisplayName = "string",
    RemoteAsNum = "string",
    BgpPath = "string",
    NeighborAddress = "string",
    MaximumHopLimit = 0,
    GracefulRestartMode = "string",
    HoldDownTime = 0,
    KeepAliveTime = 0,
    AllowAsIn = false,
    Description = "string",
    NsxId = "string",
    Password = "string",
    PolicyBgpNeighborId = "string",
    BfdConfig = new Nsxt.Inputs.PolicyBgpNeighborBfdConfigArgs
    {
        Enabled = false,
        Interval = 0,
        Multiple = 0,
    },
    RouteFilterings = new[]
    {
        new Nsxt.Inputs.PolicyBgpNeighborRouteFilteringArgs
        {
            AddressFamily = "string",
            Enabled = false,
            InRouteFilter = "string",
            MaximumRoutes = 0,
            OutRouteFilter = "string",
        },
    },
    SourceAddresses = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyBgpNeighborTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyBgpNeighbor(ctx, "policyBgpNeighborResource", &nsxt.PolicyBgpNeighborArgs{
	DisplayName:         pulumi.String("string"),
	RemoteAsNum:         pulumi.String("string"),
	BgpPath:             pulumi.String("string"),
	NeighborAddress:     pulumi.String("string"),
	MaximumHopLimit:     pulumi.Float64(0),
	GracefulRestartMode: pulumi.String("string"),
	HoldDownTime:        pulumi.Float64(0),
	KeepAliveTime:       pulumi.Float64(0),
	AllowAsIn:           pulumi.Bool(false),
	Description:         pulumi.String("string"),
	NsxId:               pulumi.String("string"),
	Password:            pulumi.String("string"),
	PolicyBgpNeighborId: pulumi.String("string"),
	BfdConfig: &nsxt.PolicyBgpNeighborBfdConfigArgs{
		Enabled:  pulumi.Bool(false),
		Interval: pulumi.Float64(0),
		Multiple: pulumi.Float64(0),
	},
	RouteFilterings: nsxt.PolicyBgpNeighborRouteFilteringArray{
		&nsxt.PolicyBgpNeighborRouteFilteringArgs{
			AddressFamily:  pulumi.String("string"),
			Enabled:        pulumi.Bool(false),
			InRouteFilter:  pulumi.String("string"),
			MaximumRoutes:  pulumi.Float64(0),
			OutRouteFilter: pulumi.String("string"),
		},
	},
	SourceAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: nsxt.PolicyBgpNeighborTagArray{
		&nsxt.PolicyBgpNeighborTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyBgpNeighborResource = new PolicyBgpNeighbor("policyBgpNeighborResource", PolicyBgpNeighborArgs.builder()
    .displayName("string")
    .remoteAsNum("string")
    .bgpPath("string")
    .neighborAddress("string")
    .maximumHopLimit(0)
    .gracefulRestartMode("string")
    .holdDownTime(0)
    .keepAliveTime(0)
    .allowAsIn(false)
    .description("string")
    .nsxId("string")
    .password("string")
    .policyBgpNeighborId("string")
    .bfdConfig(PolicyBgpNeighborBfdConfigArgs.builder()
        .enabled(false)
        .interval(0)
        .multiple(0)
        .build())
    .routeFilterings(PolicyBgpNeighborRouteFilteringArgs.builder()
        .addressFamily("string")
        .enabled(false)
        .inRouteFilter("string")
        .maximumRoutes(0)
        .outRouteFilter("string")
        .build())
    .sourceAddresses("string")
    .tags(PolicyBgpNeighborTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_bgp_neighbor_resource = nsxt.PolicyBgpNeighbor("policyBgpNeighborResource",
    display_name="string",
    remote_as_num="string",
    bgp_path="string",
    neighbor_address="string",
    maximum_hop_limit=0,
    graceful_restart_mode="string",
    hold_down_time=0,
    keep_alive_time=0,
    allow_as_in=False,
    description="string",
    nsx_id="string",
    password="string",
    policy_bgp_neighbor_id="string",
    bfd_config={
        "enabled": False,
        "interval": 0,
        "multiple": 0,
    },
    route_filterings=[{
        "address_family": "string",
        "enabled": False,
        "in_route_filter": "string",
        "maximum_routes": 0,
        "out_route_filter": "string",
    }],
    source_addresses=["string"],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyBgpNeighborResource = new nsxt.PolicyBgpNeighbor("policyBgpNeighborResource", {
    displayName: "string",
    remoteAsNum: "string",
    bgpPath: "string",
    neighborAddress: "string",
    maximumHopLimit: 0,
    gracefulRestartMode: "string",
    holdDownTime: 0,
    keepAliveTime: 0,
    allowAsIn: false,
    description: "string",
    nsxId: "string",
    password: "string",
    policyBgpNeighborId: "string",
    bfdConfig: {
        enabled: false,
        interval: 0,
        multiple: 0,
    },
    routeFilterings: [{
        addressFamily: "string",
        enabled: false,
        inRouteFilter: "string",
        maximumRoutes: 0,
        outRouteFilter: "string",
    }],
    sourceAddresses: ["string"],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyBgpNeighbor
properties:
    allowAsIn: false
    bfdConfig:
        enabled: false
        interval: 0
        multiple: 0
    bgpPath: string
    description: string
    displayName: string
    gracefulRestartMode: string
    holdDownTime: 0
    keepAliveTime: 0
    maximumHopLimit: 0
    neighborAddress: string
    nsxId: string
    password: string
    policyBgpNeighborId: string
    remoteAsNum: string
    routeFilterings:
        - addressFamily: string
          enabled: false
          inRouteFilter: string
          maximumRoutes: 0
          outRouteFilter: string
    sourceAddresses:
        - string
    tags:
        - scope: string
          tag: string

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

    BgpPath string
    The policy path to the BGP configuration for this neighbor.
    DisplayName string
    Display name of the resource.
    NeighborAddress string
    Neighbor IP Address.
    RemoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    AllowAsIn bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    BfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    Description string
    Description of the resource.
    GracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    HoldDownTime double
    Wait time in seconds before declaring peer dead. Defaults to 180.
    KeepAliveTime double
    Interval between keep alive messages sent to peer. Defaults to 60.
    MaximumHopLimit double
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    NsxId 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. Set to the empty string to clear out the password.
    PolicyBgpNeighborId string
    ID of the resource.
    RouteFilterings List<PolicyBgpNeighborRouteFiltering>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    SourceAddresses List<string>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    Tags List<PolicyBgpNeighborTag>
    A list of scope + tag pairs to associate with this resource.
    BgpPath string
    The policy path to the BGP configuration for this neighbor.
    DisplayName string
    Display name of the resource.
    NeighborAddress string
    Neighbor IP Address.
    RemoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    AllowAsIn bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    BfdConfig PolicyBgpNeighborBfdConfigArgs
    The BFD configuration.
    Description string
    Description of the resource.
    GracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    HoldDownTime float64
    Wait time in seconds before declaring peer dead. Defaults to 180.
    KeepAliveTime float64
    Interval between keep alive messages sent to peer. Defaults to 60.
    MaximumHopLimit float64
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    NsxId 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. Set to the empty string to clear out the password.
    PolicyBgpNeighborId string
    ID of the resource.
    RouteFilterings []PolicyBgpNeighborRouteFilteringArgs
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    SourceAddresses []string
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    Tags []PolicyBgpNeighborTagArgs
    A list of scope + tag pairs to associate with this resource.
    bgpPath String
    The policy path to the BGP configuration for this neighbor.
    displayName String
    Display name of the resource.
    neighborAddress String
    Neighbor IP Address.
    remoteAsNum String
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    allowAsIn Boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    description String
    Description of the resource.
    gracefulRestartMode String
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime Double
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime Double
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit Double
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    nsxId 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. Set to the empty string to clear out the password.
    policyBgpNeighborId String
    ID of the resource.
    routeFilterings List<PolicyBgpNeighborRouteFiltering>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses List<String>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags List<PolicyBgpNeighborTag>
    A list of scope + tag pairs to associate with this resource.
    bgpPath string
    The policy path to the BGP configuration for this neighbor.
    displayName string
    Display name of the resource.
    neighborAddress string
    Neighbor IP Address.
    remoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    allowAsIn boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    description string
    Description of the resource.
    gracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime number
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime number
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit number
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    nsxId 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. Set to the empty string to clear out the password.
    policyBgpNeighborId string
    ID of the resource.
    routeFilterings PolicyBgpNeighborRouteFiltering[]
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses string[]
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags PolicyBgpNeighborTag[]
    A list of scope + tag pairs to associate with this resource.
    bgp_path str
    The policy path to the BGP configuration for this neighbor.
    display_name str
    Display name of the resource.
    neighbor_address str
    Neighbor IP Address.
    remote_as_num str
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    allow_as_in bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfd_config PolicyBgpNeighborBfdConfigArgs
    The BFD configuration.
    description str
    Description of the resource.
    graceful_restart_mode str
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    hold_down_time float
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keep_alive_time float
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximum_hop_limit float
    Maximum number of hops allowed to reach BGP neighbor. 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. Set to the empty string to clear out the password.
    policy_bgp_neighbor_id str
    ID of the resource.
    route_filterings Sequence[PolicyBgpNeighborRouteFilteringArgs]
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    source_addresses Sequence[str]
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags Sequence[PolicyBgpNeighborTagArgs]
    A list of scope + tag pairs to associate with this resource.
    bgpPath String
    The policy path to the BGP configuration for this neighbor.
    displayName String
    Display name of the resource.
    neighborAddress String
    Neighbor IP Address.
    remoteAsNum String
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    allowAsIn Boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig Property Map
    The BFD configuration.
    description String
    Description of the resource.
    gracefulRestartMode String
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime Number
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime Number
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit Number
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    nsxId 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. Set to the empty string to clear out the password.
    policyBgpNeighborId String
    ID of the resource.
    routeFilterings List<Property Map>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses List<String>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags 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 PolicyBgpNeighbor resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    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 PolicyBgpNeighbor Resource

    Get an existing PolicyBgpNeighbor 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?: PolicyBgpNeighborState, opts?: CustomResourceOptions): PolicyBgpNeighbor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_as_in: Optional[bool] = None,
        bfd_config: Optional[PolicyBgpNeighborBfdConfigArgs] = None,
        bgp_path: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[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,
        password: Optional[str] = None,
        path: Optional[str] = None,
        policy_bgp_neighbor_id: Optional[str] = None,
        remote_as_num: Optional[str] = None,
        revision: Optional[float] = None,
        route_filterings: Optional[Sequence[PolicyBgpNeighborRouteFilteringArgs]] = None,
        source_addresses: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyBgpNeighborTagArgs]] = None) -> PolicyBgpNeighbor
    func GetPolicyBgpNeighbor(ctx *Context, name string, id IDInput, state *PolicyBgpNeighborState, opts ...ResourceOption) (*PolicyBgpNeighbor, error)
    public static PolicyBgpNeighbor Get(string name, Input<string> id, PolicyBgpNeighborState? state, CustomResourceOptions? opts = null)
    public static PolicyBgpNeighbor get(String name, Output<String> id, PolicyBgpNeighborState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyBgpNeighbor    get:      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.
    The following state arguments are supported:
    AllowAsIn bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    BfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    BgpPath string
    The policy path to the BGP configuration for this neighbor.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    HoldDownTime double
    Wait time in seconds before declaring peer dead. Defaults to 180.
    KeepAliveTime double
    Interval between keep alive messages sent to peer. Defaults to 60.
    MaximumHopLimit double
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    NeighborAddress string
    Neighbor IP Address.
    NsxId 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. Set to the empty string to clear out the password.
    Path string
    The NSX path of the policy resource.
    PolicyBgpNeighborId string
    ID of the resource.
    RemoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RouteFilterings List<PolicyBgpNeighborRouteFiltering>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    SourceAddresses List<string>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    Tags List<PolicyBgpNeighborTag>
    A list of scope + tag pairs to associate with this resource.
    AllowAsIn bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    BfdConfig PolicyBgpNeighborBfdConfigArgs
    The BFD configuration.
    BgpPath string
    The policy path to the BGP configuration for this neighbor.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    HoldDownTime float64
    Wait time in seconds before declaring peer dead. Defaults to 180.
    KeepAliveTime float64
    Interval between keep alive messages sent to peer. Defaults to 60.
    MaximumHopLimit float64
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    NeighborAddress string
    Neighbor IP Address.
    NsxId 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. Set to the empty string to clear out the password.
    Path string
    The NSX path of the policy resource.
    PolicyBgpNeighborId string
    ID of the resource.
    RemoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RouteFilterings []PolicyBgpNeighborRouteFilteringArgs
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    SourceAddresses []string
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    Tags []PolicyBgpNeighborTagArgs
    A list of scope + tag pairs to associate with this resource.
    allowAsIn Boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    bgpPath String
    The policy path to the BGP configuration for this neighbor.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gracefulRestartMode String
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime Double
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime Double
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit Double
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    neighborAddress String
    Neighbor IP Address.
    nsxId 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. Set to the empty string to clear out the password.
    path String
    The NSX path of the policy resource.
    policyBgpNeighborId String
    ID of the resource.
    remoteAsNum String
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeFilterings List<PolicyBgpNeighborRouteFiltering>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses List<String>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags List<PolicyBgpNeighborTag>
    A list of scope + tag pairs to associate with this resource.
    allowAsIn boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig PolicyBgpNeighborBfdConfig
    The BFD configuration.
    bgpPath string
    The policy path to the BGP configuration for this neighbor.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    gracefulRestartMode string
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime number
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime number
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit number
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    neighborAddress string
    Neighbor IP Address.
    nsxId 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. Set to the empty string to clear out the password.
    path string
    The NSX path of the policy resource.
    policyBgpNeighborId string
    ID of the resource.
    remoteAsNum string
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeFilterings PolicyBgpNeighborRouteFiltering[]
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses string[]
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags PolicyBgpNeighborTag[]
    A list of scope + tag pairs to associate with this resource.
    allow_as_in bool
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfd_config PolicyBgpNeighborBfdConfigArgs
    The BFD configuration.
    bgp_path str
    The policy path to the BGP configuration for this neighbor.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    graceful_restart_mode str
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    hold_down_time float
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keep_alive_time float
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximum_hop_limit float
    Maximum number of hops allowed to reach BGP neighbor. 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.
    password str
    Password for BGP neighbor authentication. Set to the empty string to clear out the password.
    path str
    The NSX path of the policy resource.
    policy_bgp_neighbor_id str
    ID of the resource.
    remote_as_num str
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    route_filterings Sequence[PolicyBgpNeighborRouteFilteringArgs]
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    source_addresses Sequence[str]
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags Sequence[PolicyBgpNeighborTagArgs]
    A list of scope + tag pairs to associate with this resource.
    allowAsIn Boolean
    Flag to enable allowas_in option for BGP neighbor. Defaults to false.
    bfdConfig Property Map
    The BFD configuration.
    bgpPath String
    The policy path to the BGP configuration for this neighbor.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gracefulRestartMode String
    BGP Graceful Restart Configuration Mode. One of DISABLE, GR_AND_HELPER or HELPER_ONLY.
    holdDownTime Number
    Wait time in seconds before declaring peer dead. Defaults to 180.
    keepAliveTime Number
    Interval between keep alive messages sent to peer. Defaults to 60.
    maximumHopLimit Number
    Maximum number of hops allowed to reach BGP neighbor. Defaults to 1.
    neighborAddress String
    Neighbor IP Address.
    nsxId 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. Set to the empty string to clear out the password.
    path String
    The NSX path of the policy resource.
    policyBgpNeighborId String
    ID of the resource.
    remoteAsNum String
    ASN of the neighbor in ASPLAIN/ASDOT Format.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeFilterings List<Property Map>
    Up to 2 route filters for the neighbor. Note that prior to NSX version 3.0.0, only 1 element is supported.
    sourceAddresses List<String>
    A list of up to 8 source IP Addresses for BGP peering. ip_addresses field of an existing nsxt.PolicyTier0GatewayInterface can be used here.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyBgpNeighborBfdConfig, PolicyBgpNeighborBfdConfigArgs

    Enabled bool
    A boolean flag to enable/disable BFD. Defaults to false.
    Interval double
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    Multiple double
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.
    Enabled bool
    A boolean flag to enable/disable BFD. Defaults to false.
    Interval float64
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    Multiple float64
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.
    enabled Boolean
    A boolean flag to enable/disable BFD. Defaults to false.
    interval Double
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    multiple Double
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.
    enabled boolean
    A boolean flag to enable/disable BFD. Defaults to false.
    interval number
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    multiple number
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.
    enabled bool
    A boolean flag to enable/disable BFD. Defaults to false.
    interval float
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    multiple float
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.
    enabled Boolean
    A boolean flag to enable/disable BFD. Defaults to false.
    interval Number
    Time interval between heartbeat packets in milliseconds. Defaults to 500.
    multiple Number
    Number of times heartbeat packet is missed before BFD declares the neighbor is down. Defaults to 3.

    PolicyBgpNeighborRouteFiltering, PolicyBgpNeighborRouteFilteringArgs

    AddressFamily string
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    Enabled bool
    A boolean flag to enable/disable address family. Defaults to false.
    InRouteFilter string
    Path of prefix-list or route map to filter routes for IN direction.
    MaximumRoutes double
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    OutRouteFilter string
    Path of prefix-list or route map to filter routes for OUT direction.
    AddressFamily string
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    Enabled bool
    A boolean flag to enable/disable address family. Defaults to false.
    InRouteFilter string
    Path of prefix-list or route map to filter routes for IN direction.
    MaximumRoutes float64
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    OutRouteFilter string
    Path of prefix-list or route map to filter routes for OUT direction.
    addressFamily String
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    enabled Boolean
    A boolean flag to enable/disable address family. Defaults to false.
    inRouteFilter String
    Path of prefix-list or route map to filter routes for IN direction.
    maximumRoutes Double
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    outRouteFilter String
    Path of prefix-list or route map to filter routes for OUT direction.
    addressFamily string
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    enabled boolean
    A boolean flag to enable/disable address family. Defaults to false.
    inRouteFilter string
    Path of prefix-list or route map to filter routes for IN direction.
    maximumRoutes number
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    outRouteFilter string
    Path of prefix-list or route map to filter routes for OUT direction.
    address_family str
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    enabled bool
    A boolean flag to enable/disable address family. Defaults to false.
    in_route_filter str
    Path of prefix-list or route map to filter routes for IN direction.
    maximum_routes float
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    out_route_filter str
    Path of prefix-list or route map to filter routes for OUT direction.
    addressFamily String
    Address family type. Must be one of L2VPN_EVPN, IPV4 or IPV6. Note the L2VPN_EVPN property is only available starting with NSX version 3.0.0.
    enabled Boolean
    A boolean flag to enable/disable address family. Defaults to false.
    inRouteFilter String
    Path of prefix-list or route map to filter routes for IN direction.
    maximumRoutes Number
    Maximum number of routes for the address family. Note this property is only available starting with NSX version 3.0.0.
    outRouteFilter String
    Path of prefix-list or route map to filter routes for OUT direction.

    PolicyBgpNeighborTag, PolicyBgpNeighborTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt