1. Packages
  2. Openstack Provider
  3. API Docs
  4. loadbalancer
  5. getPoolV2
OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-openstack

openstack.loadbalancer.getPoolV2

openstack logo
OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-openstack

    Use this data source to get the ID of an OpenStack Load Balancer pool.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const pool1 = openstack.loadbalancer.getPoolV2({
    name: "pool_1",
});

    import pulumi
import pulumi_openstack as openstack

pool1 = openstack.loadbalancer.get_pool_v2(name="pool_1")

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.GetPoolV2(ctx, &loadbalancer.GetPoolV2Args{
			Name: pulumi.StringRef("pool_1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var pool1 = OpenStack.LoadBalancer.GetPoolV2.Invoke(new()
    {
        Name = "pool_1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.loadbalancer.LoadbalancerFunctions;
import com.pulumi.openstack.loadbalancer.inputs.GetPoolV2Args;
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 pool1 = LoadbalancerFunctions.getPoolV2(GetPoolV2Args.builder()
            .name("pool_1")
            .build());

    }
}

    variables:
  pool1:
    fn::invoke:
      function: openstack:loadbalancer:getPoolV2
      arguments:
        name: pool_1

    Using getPoolV2

    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 getPoolV2(args: GetPoolV2Args, opts?: InvokeOptions): Promise<GetPoolV2Result>
function getPoolV2Output(args: GetPoolV2OutputArgs, opts?: InvokeOptions): Output<GetPoolV2Result>
    def get_pool_v2(lb_method: Optional[str] = None,
                loadbalancer_id: Optional[str] = None,
                name: Optional[str] = None,
                pool_id: Optional[str] = None,
                protocol: Optional[str] = None,
                region: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetPoolV2Result
def get_pool_v2_output(lb_method: Optional[pulumi.Input[str]] = None,
                loadbalancer_id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                pool_id: Optional[pulumi.Input[str]] = None,
                protocol: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPoolV2Result]
    func GetPoolV2(ctx *Context, args *GetPoolV2Args, opts ...InvokeOption) (*GetPoolV2Result, error)
func GetPoolV2Output(ctx *Context, args *GetPoolV2OutputArgs, opts ...InvokeOption) GetPoolV2ResultOutput

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

    public static class GetPoolV2 
{
    public static Task<GetPoolV2Result> InvokeAsync(GetPoolV2Args args, InvokeOptions? opts = null)
    public static Output<GetPoolV2Result> Invoke(GetPoolV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPoolV2Result> getPoolV2(GetPoolV2Args args, InvokeOptions options)
public static Output<GetPoolV2Result> getPoolV2(GetPoolV2Args args, InvokeOptions options)

    fn::invoke:
  function: openstack:loadbalancer/getPoolV2:getPoolV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LbMethod string
    The load balancing algorithm to distribute traffic to the pool's members.
    LoadbalancerId string
    The ID of the load balancer associated with the requested pool.
    Name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    PoolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    Protocol string
    The protocol of the requested pool.
    Region string
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    Tags List<string>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    LbMethod string
    The load balancing algorithm to distribute traffic to the pool's members.
    LoadbalancerId string
    The ID of the load balancer associated with the requested pool.
    Name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    PoolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    Protocol string
    The protocol of the requested pool.
    Region string
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    Tags []string
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    lbMethod String
    The load balancing algorithm to distribute traffic to the pool's members.
    loadbalancerId String
    The ID of the load balancer associated with the requested pool.
    name String
    The name of the pool. Exactly one of name, pool_id is required to be set.
    poolId String
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    protocol String
    The protocol of the requested pool.
    region String
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    tags List<String>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    lbMethod string
    The load balancing algorithm to distribute traffic to the pool's members.
    loadbalancerId string
    The ID of the load balancer associated with the requested pool.
    name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    poolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    protocol string
    The protocol of the requested pool.
    region string
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    tags string[]
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    lb_method str
    The load balancing algorithm to distribute traffic to the pool's members.
    loadbalancer_id str
    The ID of the load balancer associated with the requested pool.
    name str
    The name of the pool. Exactly one of name, pool_id is required to be set.
    pool_id str
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    protocol str
    The protocol of the requested pool.
    region str
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    tags Sequence[str]
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    lbMethod String
    The load balancing algorithm to distribute traffic to the pool's members.
    loadbalancerId String
    The ID of the load balancer associated with the requested pool.
    name String
    The name of the pool. Exactly one of name, pool_id is required to be set.
    poolId String
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    protocol String
    The protocol of the requested pool.
    region String
    The region in which to obtain the V2 Load Balancer client. If omitted, the region argument of the provider is used.
    tags List<String>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.

    getPoolV2 Result

    The following output properties are available:

    AdminStateUp bool
    The administrative state of the Pool, which is up (true) or down (false).
    AlpnProtocols List<string>
    A list of ALPN protocols.
    CaTlsContainerRef string
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    CrlContainerRef string
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    Description string
    The description of the pool.
    HealthmonitorId string
    The ID of associated health monitor.
    Id string
    The provider-assigned unique ID for this managed resource.
    LbMethod string
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    Listeners List<Pulumi.OpenStack.LoadBalancer.Outputs.GetPoolV2Listener>
    A list of listeners objects IDs.
    LoadbalancerId string
    Loadbalancers List<Pulumi.OpenStack.LoadBalancer.Outputs.GetPoolV2Loadbalancer>
    A list of load balancer objects IDs.
    Members List<Pulumi.OpenStack.LoadBalancer.Outputs.GetPoolV2Member>
    A list of member objects IDs.
    Name string
    The name of the pool.
    OperatingStatus string
    The operating status of the pool.
    PoolId string
    ProjectId string
    The owner (project/tenant) ID of the pool.
    Protocol string
    The protocol to loadbalance.
    ProvisioningStatus string
    The provisioning status of the pool.
    Region string
    SessionPersistences List<Pulumi.OpenStack.LoadBalancer.Outputs.GetPoolV2SessionPersistence>
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    Tags List<string>
    Tags is a list of resource tags.
    TlsCiphers string
    List of ciphers in OpenSSL format (colon-separated).
    TlsContainerRef string
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    TlsEnabled bool
    When true connections to backend member servers will use TLS encryption.
    TlsVersions List<string>
    A list of TLS protocol versions.
    AdminStateUp bool
    The administrative state of the Pool, which is up (true) or down (false).
    AlpnProtocols []string
    A list of ALPN protocols.
    CaTlsContainerRef string
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    CrlContainerRef string
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    Description string
    The description of the pool.
    HealthmonitorId string
    The ID of associated health monitor.
    Id string
    The provider-assigned unique ID for this managed resource.
    LbMethod string
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    Listeners []GetPoolV2Listener
    A list of listeners objects IDs.
    LoadbalancerId string
    Loadbalancers []GetPoolV2Loadbalancer
    A list of load balancer objects IDs.
    Members []GetPoolV2Member
    A list of member objects IDs.
    Name string
    The name of the pool.
    OperatingStatus string
    The operating status of the pool.
    PoolId string
    ProjectId string
    The owner (project/tenant) ID of the pool.
    Protocol string
    The protocol to loadbalance.
    ProvisioningStatus string
    The provisioning status of the pool.
    Region string
    SessionPersistences []GetPoolV2SessionPersistence
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    Tags []string
    Tags is a list of resource tags.
    TlsCiphers string
    List of ciphers in OpenSSL format (colon-separated).
    TlsContainerRef string
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    TlsEnabled bool
    When true connections to backend member servers will use TLS encryption.
    TlsVersions []string
    A list of TLS protocol versions.
    adminStateUp Boolean
    The administrative state of the Pool, which is up (true) or down (false).
    alpnProtocols List<String>
    A list of ALPN protocols.
    caTlsContainerRef String
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    crlContainerRef String
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    description String
    The description of the pool.
    healthmonitorId String
    The ID of associated health monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    lbMethod String
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    listeners List<GetPoolV2Listener>
    A list of listeners objects IDs.
    loadbalancerId String
    loadbalancers List<GetPoolV2Loadbalancer>
    A list of load balancer objects IDs.
    members List<GetPoolV2Member>
    A list of member objects IDs.
    name String
    The name of the pool.
    operatingStatus String
    The operating status of the pool.
    poolId String
    projectId String
    The owner (project/tenant) ID of the pool.
    protocol String
    The protocol to loadbalance.
    provisioningStatus String
    The provisioning status of the pool.
    region String
    sessionPersistences List<GetPoolV2SessionPersistence>
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    tags List<String>
    Tags is a list of resource tags.
    tlsCiphers String
    List of ciphers in OpenSSL format (colon-separated).
    tlsContainerRef String
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    tlsEnabled Boolean
    When true connections to backend member servers will use TLS encryption.
    tlsVersions List<String>
    A list of TLS protocol versions.
    adminStateUp boolean
    The administrative state of the Pool, which is up (true) or down (false).
    alpnProtocols string[]
    A list of ALPN protocols.
    caTlsContainerRef string
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    crlContainerRef string
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    description string
    The description of the pool.
    healthmonitorId string
    The ID of associated health monitor.
    id string
    The provider-assigned unique ID for this managed resource.
    lbMethod string
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    listeners GetPoolV2Listener[]
    A list of listeners objects IDs.
    loadbalancerId string
    loadbalancers GetPoolV2Loadbalancer[]
    A list of load balancer objects IDs.
    members GetPoolV2Member[]
    A list of member objects IDs.
    name string
    The name of the pool.
    operatingStatus string
    The operating status of the pool.
    poolId string
    projectId string
    The owner (project/tenant) ID of the pool.
    protocol string
    The protocol to loadbalance.
    provisioningStatus string
    The provisioning status of the pool.
    region string
    sessionPersistences GetPoolV2SessionPersistence[]
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    tags string[]
    Tags is a list of resource tags.
    tlsCiphers string
    List of ciphers in OpenSSL format (colon-separated).
    tlsContainerRef string
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    tlsEnabled boolean
    When true connections to backend member servers will use TLS encryption.
    tlsVersions string[]
    A list of TLS protocol versions.
    admin_state_up bool
    The administrative state of the Pool, which is up (true) or down (false).
    alpn_protocols Sequence[str]
    A list of ALPN protocols.
    ca_tls_container_ref str
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    crl_container_ref str
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    description str
    The description of the pool.
    healthmonitor_id str
    The ID of associated health monitor.
    id str
    The provider-assigned unique ID for this managed resource.
    lb_method str
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    listeners Sequence[GetPoolV2Listener]
    A list of listeners objects IDs.
    loadbalancer_id str
    loadbalancers Sequence[GetPoolV2Loadbalancer]
    A list of load balancer objects IDs.
    members Sequence[GetPoolV2Member]
    A list of member objects IDs.
    name str
    The name of the pool.
    operating_status str
    The operating status of the pool.
    pool_id str
    project_id str
    The owner (project/tenant) ID of the pool.
    protocol str
    The protocol to loadbalance.
    provisioning_status str
    The provisioning status of the pool.
    region str
    session_persistences Sequence[GetPoolV2SessionPersistence]
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    tags Sequence[str]
    Tags is a list of resource tags.
    tls_ciphers str
    List of ciphers in OpenSSL format (colon-separated).
    tls_container_ref str
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    tls_enabled bool
    When true connections to backend member servers will use TLS encryption.
    tls_versions Sequence[str]
    A list of TLS protocol versions.
    adminStateUp Boolean
    The administrative state of the Pool, which is up (true) or down (false).
    alpnProtocols List<String>
    A list of ALPN protocols.
    caTlsContainerRef String
    The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
    crlContainerRef String
    The reference of the key manager service secret containing a PEM format CA revocation list file for tls_enabled pools.
    description String
    The description of the pool.
    healthmonitorId String
    The ID of associated health monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    lbMethod String
    The load-balancer algorithm, which is round-robin, least-connections, and so on.
    listeners List<Property Map>
    A list of listeners objects IDs.
    loadbalancerId String
    loadbalancers List<Property Map>
    A list of load balancer objects IDs.
    members List<Property Map>
    A list of member objects IDs.
    name String
    The name of the pool.
    operatingStatus String
    The operating status of the pool.
    poolId String
    projectId String
    The owner (project/tenant) ID of the pool.
    protocol String
    The protocol to loadbalance.
    provisioningStatus String
    The provisioning status of the pool.
    region String
    sessionPersistences List<Property Map>
    Indicates whether connections in the same session will be processed by the same Pool member or not.
    tags List<String>
    Tags is a list of resource tags.
    tlsCiphers String
    List of ciphers in OpenSSL format (colon-separated).
    tlsContainerRef String
    The reference to the key manager service secret containing a PKCS12 format certificate/key bundle for tls_enabled pools for TLS client authentication to the member servers.
    tlsEnabled Boolean
    When true connections to backend member servers will use TLS encryption.
    tlsVersions List<String>
    A list of TLS protocol versions.

    Supporting Types

    GetPoolV2Listener

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetPoolV2Loadbalancer

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetPoolV2Member

    Address string
    AdminStateUp bool
    The administrative state of the Pool, which is up (true) or down (false).
    Backup bool
    Id string
    MonitorAddress string
    MonitorPort int
    Name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    OperatingStatus string
    The operating status of the pool.
    PoolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    ProjectId string
    The owner (project/tenant) ID of the pool.
    ProtocolPort int
    ProvisioningStatus string
    The provisioning status of the pool.
    SubnetId string
    Tags List<string>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    Weight int
    Address string
    AdminStateUp bool
    The administrative state of the Pool, which is up (true) or down (false).
    Backup bool
    Id string
    MonitorAddress string
    MonitorPort int
    Name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    OperatingStatus string
    The operating status of the pool.
    PoolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    ProjectId string
    The owner (project/tenant) ID of the pool.
    ProtocolPort int
    ProvisioningStatus string
    The provisioning status of the pool.
    SubnetId string
    Tags []string
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    Weight int
    address String
    adminStateUp Boolean
    The administrative state of the Pool, which is up (true) or down (false).
    backup Boolean
    id String
    monitorAddress String
    monitorPort Integer
    name String
    The name of the pool. Exactly one of name, pool_id is required to be set.
    operatingStatus String
    The operating status of the pool.
    poolId String
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    projectId String
    The owner (project/tenant) ID of the pool.
    protocolPort Integer
    provisioningStatus String
    The provisioning status of the pool.
    subnetId String
    tags List<String>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    weight Integer
    address string
    adminStateUp boolean
    The administrative state of the Pool, which is up (true) or down (false).
    backup boolean
    id string
    monitorAddress string
    monitorPort number
    name string
    The name of the pool. Exactly one of name, pool_id is required to be set.
    operatingStatus string
    The operating status of the pool.
    poolId string
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    projectId string
    The owner (project/tenant) ID of the pool.
    protocolPort number
    provisioningStatus string
    The provisioning status of the pool.
    subnetId string
    tags string[]
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    weight number
    address str
    admin_state_up bool
    The administrative state of the Pool, which is up (true) or down (false).
    backup bool
    id str
    monitor_address str
    monitor_port int
    name str
    The name of the pool. Exactly one of name, pool_id is required to be set.
    operating_status str
    The operating status of the pool.
    pool_id str
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    project_id str
    The owner (project/tenant) ID of the pool.
    protocol_port int
    provisioning_status str
    The provisioning status of the pool.
    subnet_id str
    tags Sequence[str]
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    weight int
    address String
    adminStateUp Boolean
    The administrative state of the Pool, which is up (true) or down (false).
    backup Boolean
    id String
    monitorAddress String
    monitorPort Number
    name String
    The name of the pool. Exactly one of name, pool_id is required to be set.
    operatingStatus String
    The operating status of the pool.
    poolId String
    The ID of the pool. Exactly one of name, pool_id is required to be set.
    projectId String
    The owner (project/tenant) ID of the pool.
    protocolPort Number
    provisioningStatus String
    The provisioning status of the pool.
    subnetId String
    tags List<String>
    A set of tags applied to the loadbalancer's pool. The loadbalancer' pool will be returned if it has all of the specified tags.
    weight Number

    GetPoolV2SessionPersistence

    CookieName string
    Type string
    CookieName string
    Type string
    cookieName String
    type String
    cookieName string
    type string
    cookieName String
    type String

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-openstack
      Meet Neo: Your AI Platform Teammate