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 dictionaryThe following arguments are supported:
- Lb
Method string - The load balancing algorithm to distribute traffic to the pool's members.
- Loadbalancer
Id string - The ID of the load balancer associated with the requested pool.
- Name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - Pool
Id string - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - 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.
- Lb
Method string - The load balancing algorithm to distribute traffic to the pool's members.
- Loadbalancer
Id string - The ID of the load balancer associated with the requested pool.
- Name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - Pool
Id string - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - []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 String - The load balancing algorithm to distribute traffic to the pool's members.
- loadbalancer
Id String - The ID of the load balancer associated with the requested pool.
- name String
- The name of the pool. Exactly one of
name,pool_idis required to be set. - pool
Id String - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - 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.
- lb
Method string - The load balancing algorithm to distribute traffic to the pool's members.
- loadbalancer
Id string - The ID of the load balancer associated with the requested pool.
- name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - pool
Id string - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - 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_idis required to be set. - pool_
id str - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - 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.
- lb
Method String - The load balancing algorithm to distribute traffic to the pool's members.
- loadbalancer
Id String - The ID of the load balancer associated with the requested pool.
- name String
- The name of the pool. Exactly one of
name,pool_idis required to be set. - pool
Id String - The ID of the pool. Exactly one of
name,pool_idis 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
regionargument of the provider is used. - 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:
- Admin
State boolUp - The administrative state of the Pool, which is up (true) or down (false).
- Alpn
Protocols List<string> - A list of ALPN protocols.
- Ca
Tls stringContainer Ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- Crl
Container stringRef - 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.
- Healthmonitor
Id string - The ID of associated health monitor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lb
Method string - The load-balancer algorithm, which is round-robin, least-connections, and so on.
- Listeners
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Pool V2Listener> - A list of listeners objects IDs.
- Loadbalancer
Id string - Loadbalancers
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Pool V2Loadbalancer> - A list of load balancer objects IDs.
- Members
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Pool V2Member> - A list of member objects IDs.
- Name string
- The name of the pool.
- Operating
Status string - The operating status of the pool.
- Pool
Id string - Project
Id string - The owner (project/tenant) ID of the pool.
- Protocol string
- The protocol to loadbalance.
- Provisioning
Status string - The provisioning status of the pool.
- Region string
- Session
Persistences List<Pulumi.Open Stack. Load Balancer. Outputs. Get Pool V2Session Persistence> - Indicates whether connections in the same session will be processed by the same Pool member or not.
- List<string>
- Tags is a list of resource tags.
- Tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- Tls
Container stringRef - 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 List<string> - A list of TLS protocol versions.
- Admin
State boolUp - The administrative state of the Pool, which is up (true) or down (false).
- Alpn
Protocols []string - A list of ALPN protocols.
- Ca
Tls stringContainer Ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- Crl
Container stringRef - 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.
- Healthmonitor
Id string - The ID of associated health monitor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lb
Method string - The load-balancer algorithm, which is round-robin, least-connections, and so on.
- Listeners
[]Get
Pool V2Listener - A list of listeners objects IDs.
- Loadbalancer
Id string - Loadbalancers
[]Get
Pool V2Loadbalancer - A list of load balancer objects IDs.
- Members
[]Get
Pool V2Member - A list of member objects IDs.
- Name string
- The name of the pool.
- Operating
Status string - The operating status of the pool.
- Pool
Id string - Project
Id string - The owner (project/tenant) ID of the pool.
- Protocol string
- The protocol to loadbalance.
- Provisioning
Status string - The provisioning status of the pool.
- Region string
- Session
Persistences []GetPool V2Session Persistence - Indicates whether connections in the same session will be processed by the same Pool member or not.
- []string
- Tags is a list of resource tags.
- Tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- Tls
Container stringRef - 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 []string - A list of TLS protocol versions.
- admin
State BooleanUp - The administrative state of the Pool, which is up (true) or down (false).
- alpn
Protocols List<String> - A list of ALPN protocols.
- ca
Tls StringContainer Ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- crl
Container StringRef - 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.
- healthmonitor
Id String - The ID of associated health monitor.
- id String
- The provider-assigned unique ID for this managed resource.
- lb
Method String - The load-balancer algorithm, which is round-robin, least-connections, and so on.
- listeners
List<Get
Pool V2Listener> - A list of listeners objects IDs.
- loadbalancer
Id String - loadbalancers
List<Get
Pool V2Loadbalancer> - A list of load balancer objects IDs.
- members
List<Get
Pool V2Member> - A list of member objects IDs.
- name String
- The name of the pool.
- operating
Status String - The operating status of the pool.
- pool
Id String - project
Id String - The owner (project/tenant) ID of the pool.
- protocol String
- The protocol to loadbalance.
- provisioning
Status String - The provisioning status of the pool.
- region String
- session
Persistences List<GetPool V2Session Persistence> - Indicates whether connections in the same session will be processed by the same Pool member or not.
- List<String>
- Tags is a list of resource tags.
- tls
Ciphers String - List of ciphers in OpenSSL format (colon-separated).
- tls
Container StringRef - 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 Boolean - When true connections to backend member servers will use TLS encryption.
- tls
Versions List<String> - A list of TLS protocol versions.
- admin
State booleanUp - The administrative state of the Pool, which is up (true) or down (false).
- alpn
Protocols string[] - A list of ALPN protocols.
- ca
Tls stringContainer Ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- crl
Container stringRef - 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.
- healthmonitor
Id string - The ID of associated health monitor.
- id string
- The provider-assigned unique ID for this managed resource.
- lb
Method string - The load-balancer algorithm, which is round-robin, least-connections, and so on.
- listeners
Get
Pool V2Listener[] - A list of listeners objects IDs.
- loadbalancer
Id string - loadbalancers
Get
Pool V2Loadbalancer[] - A list of load balancer objects IDs.
- members
Get
Pool V2Member[] - A list of member objects IDs.
- name string
- The name of the pool.
- operating
Status string - The operating status of the pool.
- pool
Id string - project
Id string - The owner (project/tenant) ID of the pool.
- protocol string
- The protocol to loadbalance.
- provisioning
Status string - The provisioning status of the pool.
- region string
- session
Persistences GetPool V2Session Persistence[] - Indicates whether connections in the same session will be processed by the same Pool member or not.
- string[]
- Tags is a list of resource tags.
- tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- tls
Container stringRef - 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 boolean - When true connections to backend member servers will use TLS encryption.
- tls
Versions string[] - A list of TLS protocol versions.
- admin_
state_ boolup - The administrative state of the Pool, which is up (true) or down (false).
- alpn_
protocols Sequence[str] - A list of ALPN protocols.
- ca_
tls_ strcontainer_ ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- crl_
container_ strref - 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[Get
Pool V2Listener] - A list of listeners objects IDs.
- loadbalancer_
id str - loadbalancers
Sequence[Get
Pool V2Loadbalancer] - A list of load balancer objects IDs.
- members
Sequence[Get
Pool V2Member] - 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[GetPool V2Session Persistence] - Indicates whether connections in the same session will be processed by the same Pool member or not.
- Sequence[str]
- Tags is a list of resource tags.
- tls_
ciphers str - List of ciphers in OpenSSL format (colon-separated).
- tls_
container_ strref - 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.
- admin
State BooleanUp - The administrative state of the Pool, which is up (true) or down (false).
- alpn
Protocols List<String> - A list of ALPN protocols.
- ca
Tls StringContainer Ref - The reference of the key manager service secret containing a PEM format CA certificate bundle for tls_enabled pools.
- crl
Container StringRef - 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.
- healthmonitor
Id String - The ID of associated health monitor.
- id String
- The provider-assigned unique ID for this managed resource.
- lb
Method String - The load-balancer algorithm, which is round-robin, least-connections, and so on.
- listeners List<Property Map>
- A list of listeners objects IDs.
- loadbalancer
Id 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.
- operating
Status String - The operating status of the pool.
- pool
Id String - project
Id String - The owner (project/tenant) ID of the pool.
- protocol String
- The protocol to loadbalance.
- provisioning
Status String - The provisioning status of the pool.
- region String
- session
Persistences List<Property Map> - Indicates whether connections in the same session will be processed by the same Pool member or not.
- List<String>
- Tags is a list of resource tags.
- tls
Ciphers String - List of ciphers in OpenSSL format (colon-separated).
- tls
Container StringRef - 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 Boolean - When true connections to backend member servers will use TLS encryption.
- tls
Versions 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
- Admin
State boolUp - The administrative state of the Pool, which is up (true) or down (false).
- Backup bool
- Id string
- Monitor
Address string - Monitor
Port int - Name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - Operating
Status string - The operating status of the pool.
- Pool
Id string - The ID of the pool. Exactly one of
name,pool_idis required to be set. - Project
Id string - The owner (project/tenant) ID of the pool.
- Protocol
Port int - Provisioning
Status string - The provisioning status of the pool.
- Subnet
Id string - 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
- Admin
State boolUp - The administrative state of the Pool, which is up (true) or down (false).
- Backup bool
- Id string
- Monitor
Address string - Monitor
Port int - Name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - Operating
Status string - The operating status of the pool.
- Pool
Id string - The ID of the pool. Exactly one of
name,pool_idis required to be set. - Project
Id string - The owner (project/tenant) ID of the pool.
- Protocol
Port int - Provisioning
Status string - The provisioning status of the pool.
- Subnet
Id string - []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
- admin
State BooleanUp - The administrative state of the Pool, which is up (true) or down (false).
- backup Boolean
- id String
- monitor
Address String - monitor
Port Integer - name String
- The name of the pool. Exactly one of
name,pool_idis required to be set. - operating
Status String - The operating status of the pool.
- pool
Id String - The ID of the pool. Exactly one of
name,pool_idis required to be set. - project
Id String - The owner (project/tenant) ID of the pool.
- protocol
Port Integer - provisioning
Status String - The provisioning status of the pool.
- subnet
Id String - 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
- admin
State booleanUp - The administrative state of the Pool, which is up (true) or down (false).
- backup boolean
- id string
- monitor
Address string - monitor
Port number - name string
- The name of the pool. Exactly one of
name,pool_idis required to be set. - operating
Status string - The operating status of the pool.
- pool
Id string - The ID of the pool. Exactly one of
name,pool_idis required to be set. - project
Id string - The owner (project/tenant) ID of the pool.
- protocol
Port number - provisioning
Status string - The provisioning status of the pool.
- subnet
Id string - 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_ boolup - 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_idis 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_idis 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 - 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
- admin
State BooleanUp - The administrative state of the Pool, which is up (true) or down (false).
- backup Boolean
- id String
- monitor
Address String - monitor
Port Number - name String
- The name of the pool. Exactly one of
name,pool_idis required to be set. - operating
Status String - The operating status of the pool.
- pool
Id String - The ID of the pool. Exactly one of
name,pool_idis required to be set. - project
Id String - The owner (project/tenant) ID of the pool.
- protocol
Port Number - provisioning
Status String - The provisioning status of the pool.
- subnet
Id String - 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
- string
- Type string
- string
- Type string
- String
- type String
- string
- type string
- str
- type str
- String
- type String
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
openstackTerraform Provider.
