vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vcd.getNsxtEdgegatewayBgpNeighbor
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Edge
Gateway stringId  - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
 - Ip
Address 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 stringId  - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
 - Ip
Address 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 StringId  - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
 - ip
Address 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 stringId  - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
 - ip
Address 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_ strid  - 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.
 
- edge
Gateway StringId  - An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
 - ip
Address 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:
- Allow
As boolIn  - Bfd
Dead doubleMultiple  - Bfd
Enabled bool - Bfd
Interval double - Edge
Gateway stringId  - Graceful
Restart stringMode  - Hold
Down doubleTimer  - Id string
 - In
Filter stringIp Prefix List Id  - Ip
Address string - Keep
Alive doubleTimer  - Out
Filter stringIp Prefix List Id  - Password string
 - Remote
As stringNumber  - Route
Filtering string - Org string
 
- Allow
As boolIn  - Bfd
Dead float64Multiple  - Bfd
Enabled bool - Bfd
Interval float64 - Edge
Gateway stringId  - Graceful
Restart stringMode  - Hold
Down float64Timer  - Id string
 - In
Filter stringIp Prefix List Id  - Ip
Address string - Keep
Alive float64Timer  - Out
Filter stringIp Prefix List Id  - Password string
 - Remote
As stringNumber  - Route
Filtering string - Org string
 
- allow
As BooleanIn  - bfd
Dead DoubleMultiple  - bfd
Enabled Boolean - bfd
Interval Double - edge
Gateway StringId  - graceful
Restart StringMode  - hold
Down DoubleTimer  - id String
 - in
Filter StringIp Prefix List Id  - ip
Address String - keep
Alive DoubleTimer  - out
Filter StringIp Prefix List Id  - password String
 - remote
As StringNumber  - route
Filtering String - org String
 
- allow
As booleanIn  - bfd
Dead numberMultiple  - bfd
Enabled boolean - bfd
Interval number - edge
Gateway stringId  - graceful
Restart stringMode  - hold
Down numberTimer  - id string
 - in
Filter stringIp Prefix List Id  - ip
Address string - keep
Alive numberTimer  - out
Filter stringIp Prefix List Id  - password string
 - remote
As stringNumber  - route
Filtering string - org string
 
- allow_
as_ boolin  - bfd_
dead_ floatmultiple  - bfd_
enabled bool - bfd_
interval float - edge_
gateway_ strid  - graceful_
restart_ strmode  - hold_
down_ floattimer  - id str
 - in_
filter_ strip_ prefix_ list_ id  - ip_
address str - keep_
alive_ floattimer  - out_
filter_ strip_ prefix_ list_ id  - password str
 - remote_
as_ strnumber  - route_
filtering str - org str
 
- allow
As BooleanIn  - bfd
Dead NumberMultiple  - bfd
Enabled Boolean - bfd
Interval Number - edge
Gateway StringId  - graceful
Restart StringMode  - hold
Down NumberTimer  - id String
 - in
Filter StringIp Prefix List Id  - ip
Address String - keep
Alive NumberTimer  - out
Filter StringIp Prefix List Id  - password String
 - remote
As StringNumber  - route
Filtering String - org String
 
Package Details
- Repository
 - vcd vmware/terraform-provider-vcd
 - License
 - Notes
 - This Pulumi package is based on the 
vcdTerraform Provider.