1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtEdgegatewayBgpNeighbor
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtEdgegatewayBgpNeighbor

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Supported in provider v3.7+ and VCD 10.2+ with NSX-T

    Provides a data source to read NSX-T Edge Gateway BGP Neighbors and their configuration.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vcd.VcdFunctions;
    import com.pulumi.vcd.inputs.GetNsxtEdgegatewayArgs;
    import com.pulumi.vcd.inputs.GetNsxtEdgegatewayBgpNeighborArgs;
    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 existing = VcdFunctions.getNsxtEdgegateway(GetNsxtEdgegatewayArgs.builder()
                .org("my-org")
                .vdc("nsxt-vdc")
                .name("nsxt-gw")
                .build());
    
            final var first = VcdFunctions.getNsxtEdgegatewayBgpNeighbor(GetNsxtEdgegatewayBgpNeighborArgs.builder()
                .org("my-org")
                .vdc("nsxt-vdc")
                .edgeGatewayId(existing.applyValue(getNsxtEdgegatewayResult -> getNsxtEdgegatewayResult.id()))
                .ipAddress("192.168.102.45")
                .build());
    
        }
    }
    
    variables:
      existing:
        fn::invoke:
          function: vcd:getNsxtEdgegateway
          arguments:
            org: my-org
            vdc: nsxt-vdc
            name: nsxt-gw
      first:
        fn::invoke:
          function: vcd:getNsxtEdgegatewayBgpNeighbor
          arguments:
            org: my-org
            vdc: nsxt-vdc
            edgeGatewayId: ${existing.id}
            ipAddress: 192.168.102.45
    

    Using getNsxtEdgegatewayBgpNeighbor

    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 getNsxtEdgegatewayBgpNeighbor(args: GetNsxtEdgegatewayBgpNeighborArgs, opts?: InvokeOptions): Promise<GetNsxtEdgegatewayBgpNeighborResult>
    function getNsxtEdgegatewayBgpNeighborOutput(args: GetNsxtEdgegatewayBgpNeighborOutputArgs, opts?: InvokeOptions): Output<GetNsxtEdgegatewayBgpNeighborResult>
    def get_nsxt_edgegateway_bgp_neighbor(edge_gateway_id: Optional[str] = None,
                                          id: Optional[str] = None,
                                          ip_address: Optional[str] = None,
                                          org: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetNsxtEdgegatewayBgpNeighborResult
    def get_nsxt_edgegateway_bgp_neighbor_output(edge_gateway_id: Optional[pulumi.Input[str]] = None,
                                          id: Optional[pulumi.Input[str]] = None,
                                          ip_address: Optional[pulumi.Input[str]] = None,
                                          org: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetNsxtEdgegatewayBgpNeighborResult]
    func LookupNsxtEdgegatewayBgpNeighbor(ctx *Context, args *LookupNsxtEdgegatewayBgpNeighborArgs, opts ...InvokeOption) (*LookupNsxtEdgegatewayBgpNeighborResult, error)
    func LookupNsxtEdgegatewayBgpNeighborOutput(ctx *Context, args *LookupNsxtEdgegatewayBgpNeighborOutputArgs, opts ...InvokeOption) LookupNsxtEdgegatewayBgpNeighborResultOutput

    > Note: This function is named LookupNsxtEdgegatewayBgpNeighbor in the Go SDK.

    public static class GetNsxtEdgegatewayBgpNeighbor 
    {
        public static Task<GetNsxtEdgegatewayBgpNeighborResult> InvokeAsync(GetNsxtEdgegatewayBgpNeighborArgs args, InvokeOptions? opts = null)
        public static Output<GetNsxtEdgegatewayBgpNeighborResult> Invoke(GetNsxtEdgegatewayBgpNeighborInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNsxtEdgegatewayBgpNeighborResult> getNsxtEdgegatewayBgpNeighbor(GetNsxtEdgegatewayBgpNeighborArgs args, InvokeOptions options)
    public static Output<GetNsxtEdgegatewayBgpNeighborResult> getNsxtEdgegatewayBgpNeighbor(GetNsxtEdgegatewayBgpNeighborArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNsxtEdgegatewayBgpNeighbor:getNsxtEdgegatewayBgpNeighbor
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EdgeGatewayId string
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    IpAddress string
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    Id string
    Org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    EdgeGatewayId string
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    IpAddress string
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    Id string
    Org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    edgeGatewayId String
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    ipAddress String
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    id String
    org String
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    edgeGatewayId string
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    ipAddress string
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    id string
    org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    edge_gateway_id str
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    ip_address str
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    id str
    org str
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    edgeGatewayId String
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    ipAddress String
    An IP Address (IPv4 or IPv6) of existing BGP Neighbor in specified Edge Gateway
    id String
    org String
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.

    getNsxtEdgegatewayBgpNeighbor Result

    The following output properties are available:

    Package Details

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