Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware
Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware
This data source provides information about a Route Controller BGP Neighbor configured in NSX.
This data source is applicable to NSX Policy Manager.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const test = nsxt.getPolicyRouteControllerBgpNeighbor({
displayName: "my-bgp-neighbor",
parentPath: "/infra/route-controllers/my-controller/bgp",
});
import pulumi
import pulumi_nsxt as nsxt
test = nsxt.get_policy_route_controller_bgp_neighbor(display_name="my-bgp-neighbor",
parent_path="/infra/route-controllers/my-controller/bgp")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := nsxt.LookupPolicyRouteControllerBgpNeighbor(ctx, &nsxt.LookupPolicyRouteControllerBgpNeighborArgs{
DisplayName: pulumi.StringRef("my-bgp-neighbor"),
ParentPath: pulumi.StringRef("/infra/route-controllers/my-controller/bgp"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;
return await Deployment.RunAsync(() =>
{
var test = Nsxt.GetPolicyRouteControllerBgpNeighbor.Invoke(new()
{
DisplayName = "my-bgp-neighbor",
ParentPath = "/infra/route-controllers/my-controller/bgp",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetPolicyRouteControllerBgpNeighborArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = NsxtFunctions.getPolicyRouteControllerBgpNeighbor(GetPolicyRouteControllerBgpNeighborArgs.builder()
.displayName("my-bgp-neighbor")
.parentPath("/infra/route-controllers/my-controller/bgp")
.build());
}
}
variables:
test:
fn::invoke:
function: nsxt:getPolicyRouteControllerBgpNeighbor
arguments:
displayName: my-bgp-neighbor
parentPath: /infra/route-controllers/my-controller/bgp
Example coming soon!
Using getPolicyRouteControllerBgpNeighbor
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPolicyRouteControllerBgpNeighbor(args: GetPolicyRouteControllerBgpNeighborArgs, opts?: InvokeOptions): Promise<GetPolicyRouteControllerBgpNeighborResult>
function getPolicyRouteControllerBgpNeighborOutput(args: GetPolicyRouteControllerBgpNeighborOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyRouteControllerBgpNeighborResult>def get_policy_route_controller_bgp_neighbor(description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
parent_path: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyRouteControllerBgpNeighborResult
def get_policy_route_controller_bgp_neighbor_output(description: pulumi.Input[Optional[str]] = None,
display_name: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
parent_path: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyRouteControllerBgpNeighborResult]func LookupPolicyRouteControllerBgpNeighbor(ctx *Context, args *LookupPolicyRouteControllerBgpNeighborArgs, opts ...InvokeOption) (*LookupPolicyRouteControllerBgpNeighborResult, error)
func LookupPolicyRouteControllerBgpNeighborOutput(ctx *Context, args *LookupPolicyRouteControllerBgpNeighborOutputArgs, opts ...InvokeOption) LookupPolicyRouteControllerBgpNeighborResultOutput> Note: This function is named LookupPolicyRouteControllerBgpNeighbor in the Go SDK.
public static class GetPolicyRouteControllerBgpNeighbor
{
public static Task<GetPolicyRouteControllerBgpNeighborResult> InvokeAsync(GetPolicyRouteControllerBgpNeighborArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyRouteControllerBgpNeighborResult> Invoke(GetPolicyRouteControllerBgpNeighborInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyRouteControllerBgpNeighborResult> Invoke(GetPolicyRouteControllerBgpNeighborInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetPolicyRouteControllerBgpNeighborResult> getPolicyRouteControllerBgpNeighbor(GetPolicyRouteControllerBgpNeighborArgs args, InvokeOptions options)
public static Output<GetPolicyRouteControllerBgpNeighborResult> getPolicyRouteControllerBgpNeighbor(GetPolicyRouteControllerBgpNeighborArgs args, InvokeOptions options)
public static Output<GetPolicyRouteControllerBgpNeighborResult> getPolicyRouteControllerBgpNeighbor(GetPolicyRouteControllerBgpNeighborArgs args, InvokeOutputOptions options)
fn::invoke:
function: nsxt:index/getPolicyRouteControllerBgpNeighbor:getPolicyRouteControllerBgpNeighbor
arguments:
# arguments dictionarydata "nsxt_get_policy_route_controller_bgp_neighbor" "name" {
# arguments
}The following arguments are supported:
- Description string
- The description of the BGP Neighbor to retrieve.
- Display
Name string - The Display Name of the BGP Neighbor to retrieve.
- Id string
- The ID of the BGP Neighbor to retrieve.
- Parent
Path string - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- Description string
- The description of the BGP Neighbor to retrieve.
- Display
Name string - The Display Name of the BGP Neighbor to retrieve.
- Id string
- The ID of the BGP Neighbor to retrieve.
- Parent
Path string - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- description string
- The description of the BGP Neighbor to retrieve.
- display_
name string - The Display Name of the BGP Neighbor to retrieve.
- id string
- The ID of the BGP Neighbor to retrieve.
- parent_
path string - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- description String
- The description of the BGP Neighbor to retrieve.
- display
Name String - The Display Name of the BGP Neighbor to retrieve.
- id String
- The ID of the BGP Neighbor to retrieve.
- parent
Path String - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- description string
- The description of the BGP Neighbor to retrieve.
- display
Name string - The Display Name of the BGP Neighbor to retrieve.
- id string
- The ID of the BGP Neighbor to retrieve.
- parent
Path string - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- description str
- The description of the BGP Neighbor to retrieve.
- display_
name str - The Display Name of the BGP Neighbor to retrieve.
- id str
- The ID of the BGP Neighbor to retrieve.
- parent_
path str - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
- description String
- The description of the BGP Neighbor to retrieve.
- display
Name String - The Display Name of the BGP Neighbor to retrieve.
- id String
- The ID of the BGP Neighbor to retrieve.
- parent
Path String - Policy path of the parent Route Controller BGP config. Narrows the search to neighbors belonging to this BGP config.
getPolicyRouteControllerBgpNeighbor Result
The following output properties are available:
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Description string
- Parent
Path string
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Description string
- Parent
Path string
- display_
name string - id string
- path string
- The NSX path of the policy resource.
- description string
- parent_
path string
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- description String
- parent
Path String
- display
Name string - id string
- path string
- The NSX path of the policy resource.
- description string
- parent
Path string
- display_
name str - id str
- path str
- The NSX path of the policy resource.
- description str
- parent_
path str
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- description String
- parent
Path String
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
published on Friday, Sep 11, 2026 by vmware