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

vcd.getLbServerPool

Explore with Pulumi AI

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

    Provides a VMware Cloud Director Edge Gateway Load Balancer Server Pool data source. A Server Pool defines a group of backend servers (defined as pool members), manages load balancer distribution methods, and has a service monitor attached to it for health check parameters.

    Note: See additional support notes in server pool resource page.

    Supported in provider v2.4+

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const sp_ds = vcd.getLbServerPool({
        edgeGateway: "my-edge-gw",
        name: "not-managed",
        org: "my-org",
        vdc: "my-org-vdc",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    sp_ds = vcd.get_lb_server_pool(edge_gateway="my-edge-gw",
        name="not-managed",
        org="my-org",
        vdc="my-org-vdc")
    
    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.LookupLbServerPool(ctx, &vcd.LookupLbServerPoolArgs{
    			EdgeGateway: "my-edge-gw",
    			Name:        "not-managed",
    			Org:         pulumi.StringRef("my-org"),
    			Vdc:         pulumi.StringRef("my-org-vdc"),
    		}, 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 sp_ds = Vcd.GetLbServerPool.Invoke(new()
        {
            EdgeGateway = "my-edge-gw",
            Name = "not-managed",
            Org = "my-org",
            Vdc = "my-org-vdc",
        });
    
    });
    
    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.GetLbServerPoolArgs;
    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 sp-ds = VcdFunctions.getLbServerPool(GetLbServerPoolArgs.builder()
                .edgeGateway("my-edge-gw")
                .name("not-managed")
                .org("my-org")
                .vdc("my-org-vdc")
                .build());
    
        }
    }
    
    variables:
      sp-ds:
        fn::invoke:
          function: vcd:getLbServerPool
          arguments:
            edgeGateway: my-edge-gw
            name: not-managed
            org: my-org
            vdc: my-org-vdc
    

    Using getLbServerPool

    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 getLbServerPool(args: GetLbServerPoolArgs, opts?: InvokeOptions): Promise<GetLbServerPoolResult>
    function getLbServerPoolOutput(args: GetLbServerPoolOutputArgs, opts?: InvokeOptions): Output<GetLbServerPoolResult>
    def get_lb_server_pool(edge_gateway: Optional[str] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           org: Optional[str] = None,
                           vdc: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetLbServerPoolResult
    def get_lb_server_pool_output(edge_gateway: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           org: Optional[pulumi.Input[str]] = None,
                           vdc: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetLbServerPoolResult]
    func LookupLbServerPool(ctx *Context, args *LookupLbServerPoolArgs, opts ...InvokeOption) (*LookupLbServerPoolResult, error)
    func LookupLbServerPoolOutput(ctx *Context, args *LookupLbServerPoolOutputArgs, opts ...InvokeOption) LookupLbServerPoolResultOutput

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

    public static class GetLbServerPool 
    {
        public static Task<GetLbServerPoolResult> InvokeAsync(GetLbServerPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetLbServerPoolResult> Invoke(GetLbServerPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLbServerPoolResult> getLbServerPool(GetLbServerPoolArgs args, InvokeOptions options)
    public static Output<GetLbServerPoolResult> getLbServerPool(GetLbServerPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getLbServerPool:getLbServerPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EdgeGateway string
    The name of the edge gateway on which the server pool is defined
    Name string
    Server Pool name for identifying the exact server pool
    Id string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Vdc string
    The name of VDC to use, optional if defined at provider level
    EdgeGateway string
    The name of the edge gateway on which the server pool is defined
    Name string
    Server Pool name for identifying the exact server pool
    Id string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Vdc string
    The name of VDC to use, optional if defined at provider level
    edgeGateway String
    The name of the edge gateway on which the server pool is defined
    name String
    Server Pool name for identifying the exact server pool
    id String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    vdc String
    The name of VDC to use, optional if defined at provider level
    edgeGateway string
    The name of the edge gateway on which the server pool is defined
    name string
    Server Pool name for identifying the exact server pool
    id string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    vdc string
    The name of VDC to use, optional if defined at provider level
    edge_gateway str
    The name of the edge gateway on which the server pool is defined
    name str
    Server Pool name for identifying the exact server pool
    id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    vdc str
    The name of VDC to use, optional if defined at provider level
    edgeGateway String
    The name of the edge gateway on which the server pool is defined
    name String
    Server Pool name for identifying the exact server pool
    id String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    vdc String
    The name of VDC to use, optional if defined at provider level

    getLbServerPool Result

    The following output properties are available:

    Supporting Types

    GetLbServerPoolMember

    Condition string
    Id string
    IpAddress string
    MaxConnections double
    MinConnections double
    MonitorPort double
    Name string
    Server Pool name for identifying the exact server pool
    Port double
    Weight double
    Condition string
    Id string
    IpAddress string
    MaxConnections float64
    MinConnections float64
    MonitorPort float64
    Name string
    Server Pool name for identifying the exact server pool
    Port float64
    Weight float64
    condition String
    id String
    ipAddress String
    maxConnections Double
    minConnections Double
    monitorPort Double
    name String
    Server Pool name for identifying the exact server pool
    port Double
    weight Double
    condition string
    id string
    ipAddress string
    maxConnections number
    minConnections number
    monitorPort number
    name string
    Server Pool name for identifying the exact server pool
    port number
    weight number
    condition str
    id str
    ip_address str
    max_connections float
    min_connections float
    monitor_port float
    name str
    Server Pool name for identifying the exact server pool
    port float
    weight float
    condition String
    id String
    ipAddress String
    maxConnections Number
    minConnections Number
    monitorPort Number
    name String
    Server Pool name for identifying the exact server pool
    port Number
    weight Number

    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