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

vcd.getNsxtAlbPool

Explore with Pulumi AI

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

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

    Provides a data source to read ALB Pools for particular NSX-T Edge Gateway. Pools maintain the list of servers assigned to them and perform health monitoring, load balancing, persistence. A pool may only be used or referenced by only one virtual service at a time.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const existing = vcd.getNsxtEdgegateway({
        org: "my-org",
        vdc: "nsxt-vdc",
        name: "nsxt-gw",
    });
    const test = vcd.getNsxtAlbPool({
        org: "my-org",
        edgeGatewayId: vcd_nsxt_alb_settings.existing.edge_gateway_id,
        name: "existing-alb-pool-1",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    existing = vcd.get_nsxt_edgegateway(org="my-org",
        vdc="nsxt-vdc",
        name="nsxt-gw")
    test = vcd.get_nsxt_alb_pool(org="my-org",
        edge_gateway_id=vcd_nsxt_alb_settings["existing"]["edge_gateway_id"],
        name="existing-alb-pool-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vcd.LookupNsxtEdgegateway(ctx, &vcd.LookupNsxtEdgegatewayArgs{
    			Org:  pulumi.StringRef("my-org"),
    			Vdc:  pulumi.StringRef("nsxt-vdc"),
    			Name: "nsxt-gw",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = vcd.LookupNsxtAlbPool(ctx, &vcd.LookupNsxtAlbPoolArgs{
    			Org:           pulumi.StringRef("my-org"),
    			EdgeGatewayId: vcd_nsxt_alb_settings.Existing.Edge_gateway_id,
    			Name:          "existing-alb-pool-1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var existing = Vcd.GetNsxtEdgegateway.Invoke(new()
        {
            Org = "my-org",
            Vdc = "nsxt-vdc",
            Name = "nsxt-gw",
        });
    
        var test = Vcd.GetNsxtAlbPool.Invoke(new()
        {
            Org = "my-org",
            EdgeGatewayId = vcd_nsxt_alb_settings.Existing.Edge_gateway_id,
            Name = "existing-alb-pool-1",
        });
    
    });
    
    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.GetNsxtAlbPoolArgs;
    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 test = VcdFunctions.getNsxtAlbPool(GetNsxtAlbPoolArgs.builder()
                .org("my-org")
                .edgeGatewayId(vcd_nsxt_alb_settings.existing().edge_gateway_id())
                .name("existing-alb-pool-1")
                .build());
    
        }
    }
    
    variables:
      existing:
        fn::invoke:
          function: vcd:getNsxtEdgegateway
          arguments:
            org: my-org
            vdc: nsxt-vdc
            name: nsxt-gw
      test:
        fn::invoke:
          function: vcd:getNsxtAlbPool
          arguments:
            org: my-org
            edgeGatewayId: ${vcd_nsxt_alb_settings.existing.edge_gateway_id}
            name: existing-alb-pool-1
    

    Using getNsxtAlbPool

    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 getNsxtAlbPool(args: GetNsxtAlbPoolArgs, opts?: InvokeOptions): Promise<GetNsxtAlbPoolResult>
    function getNsxtAlbPoolOutput(args: GetNsxtAlbPoolOutputArgs, opts?: InvokeOptions): Output<GetNsxtAlbPoolResult>
    def get_nsxt_alb_pool(associated_virtual_service_ids: Optional[Sequence[str]] = None,
                          edge_gateway_id: Optional[str] = None,
                          id: Optional[str] = None,
                          name: Optional[str] = None,
                          org: Optional[str] = None,
                          passive_monitoring_enabled: Optional[bool] = None,
                          vdc: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNsxtAlbPoolResult
    def get_nsxt_alb_pool_output(associated_virtual_service_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          edge_gateway_id: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          org: Optional[pulumi.Input[str]] = None,
                          passive_monitoring_enabled: Optional[pulumi.Input[bool]] = None,
                          vdc: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNsxtAlbPoolResult]
    func LookupNsxtAlbPool(ctx *Context, args *LookupNsxtAlbPoolArgs, opts ...InvokeOption) (*LookupNsxtAlbPoolResult, error)
    func LookupNsxtAlbPoolOutput(ctx *Context, args *LookupNsxtAlbPoolOutputArgs, opts ...InvokeOption) LookupNsxtAlbPoolResultOutput

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

    public static class GetNsxtAlbPool 
    {
        public static Task<GetNsxtAlbPoolResult> InvokeAsync(GetNsxtAlbPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetNsxtAlbPoolResult> Invoke(GetNsxtAlbPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNsxtAlbPoolResult> getNsxtAlbPool(GetNsxtAlbPoolArgs args, InvokeOptions options)
    public static Output<GetNsxtAlbPoolResult> getNsxtAlbPool(GetNsxtAlbPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNsxtAlbPool:getNsxtAlbPool
      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
    Name string
    Name of existing ALB Pool.
    AssociatedVirtualServiceIds List<string>
    Id string
    Org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    PassiveMonitoringEnabled bool
    Vdc string

    Deprecated: Deprecated

    EdgeGatewayId string
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    Name string
    Name of existing ALB Pool.
    AssociatedVirtualServiceIds []string
    Id string
    Org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    PassiveMonitoringEnabled bool
    Vdc string

    Deprecated: Deprecated

    edgeGatewayId String
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    name String
    Name of existing ALB Pool.
    associatedVirtualServiceIds List<String>
    id String
    org String
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    passiveMonitoringEnabled Boolean
    vdc String

    Deprecated: Deprecated

    edgeGatewayId string
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    name string
    Name of existing ALB Pool.
    associatedVirtualServiceIds string[]
    id string
    org string
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    passiveMonitoringEnabled boolean
    vdc string

    Deprecated: Deprecated

    edge_gateway_id str
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    name str
    Name of existing ALB Pool.
    associated_virtual_service_ids Sequence[str]
    id str
    org str
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    passive_monitoring_enabled bool
    vdc str

    Deprecated: Deprecated

    edgeGatewayId String
    An ID of NSX-T Edge Gateway. Can be looked up using vcd.NsxtEdgegateway data source
    name String
    Name of existing ALB Pool.
    associatedVirtualServiceIds List<String>
    id String
    org String
    The name of organization to which the edge gateway belongs. Optional if defined at provider level.
    passiveMonitoringEnabled Boolean
    vdc String

    Deprecated: Deprecated

    getNsxtAlbPool Result

    The following output properties are available:

    Supporting Types

    GetNsxtAlbPoolHealthMonitor

    Name string
    Name of existing ALB Pool.
    SystemDefined bool
    Type string
    Name string
    Name of existing ALB Pool.
    SystemDefined bool
    Type string
    name String
    Name of existing ALB Pool.
    systemDefined Boolean
    type String
    name string
    Name of existing ALB Pool.
    systemDefined boolean
    type string
    name str
    Name of existing ALB Pool.
    system_defined bool
    type str
    name String
    Name of existing ALB Pool.
    systemDefined Boolean
    type String

    GetNsxtAlbPoolMember

    DetailedHealthMessage string
    Enabled bool
    HealthStatus string
    IpAddress string
    MarkedDownBies List<string>
    Port double
    Ratio double
    DetailedHealthMessage string
    Enabled bool
    HealthStatus string
    IpAddress string
    MarkedDownBies []string
    Port float64
    Ratio float64
    detailedHealthMessage String
    enabled Boolean
    healthStatus String
    ipAddress String
    markedDownBies List<String>
    port Double
    ratio Double
    detailedHealthMessage string
    enabled boolean
    healthStatus string
    ipAddress string
    markedDownBies string[]
    port number
    ratio number
    detailedHealthMessage String
    enabled Boolean
    healthStatus String
    ipAddress String
    markedDownBies List<String>
    port Number
    ratio Number

    GetNsxtAlbPoolPersistenceProfile

    Name string
    Name of existing ALB Pool.
    Type string
    Value string
    Name string
    Name of existing ALB Pool.
    Type string
    Value string
    name String
    Name of existing ALB Pool.
    type String
    value String
    name string
    Name of existing ALB Pool.
    type string
    value string
    name str
    Name of existing ALB Pool.
    type str
    value str
    name String
    Name of existing ALB Pool.
    type String
    value String

    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