OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
Use this data source to get the ID of an OpenStack Load Balancer listener.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";
const listener1 = openstack.loadbalancer.getListenerV2({
name: "listener_1",
});
import pulumi
import pulumi_openstack as openstack
listener1 = openstack.loadbalancer.get_listener_v2(name="listener_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.GetListenerV2(ctx, &loadbalancer.GetListenerV2Args{
Name: pulumi.StringRef("listener_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 listener1 = OpenStack.LoadBalancer.GetListenerV2.Invoke(new()
{
Name = "listener_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.GetListenerV2Args;
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 listener1 = LoadbalancerFunctions.getListenerV2(GetListenerV2Args.builder()
.name("listener_1")
.build());
}
}
variables:
listener1:
fn::invoke:
function: openstack:loadbalancer:getListenerV2
arguments:
name: listener_1
Using getListenerV2
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 getListenerV2(args: GetListenerV2Args, opts?: InvokeOptions): Promise<GetListenerV2Result>
function getListenerV2Output(args: GetListenerV2OutputArgs, opts?: InvokeOptions): Output<GetListenerV2Result>def get_listener_v2(listener_id: Optional[str] = None,
loadbalancer_id: Optional[str] = None,
name: Optional[str] = None,
protocol: Optional[str] = None,
protocol_port: Optional[int] = None,
region: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> GetListenerV2Result
def get_listener_v2_output(listener_id: Optional[pulumi.Input[str]] = None,
loadbalancer_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
protocol: Optional[pulumi.Input[str]] = None,
protocol_port: Optional[pulumi.Input[int]] = None,
region: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetListenerV2Result]func GetListenerV2(ctx *Context, args *GetListenerV2Args, opts ...InvokeOption) (*GetListenerV2Result, error)
func GetListenerV2Output(ctx *Context, args *GetListenerV2OutputArgs, opts ...InvokeOption) GetListenerV2ResultOutput> Note: This function is named GetListenerV2 in the Go SDK.
public static class GetListenerV2
{
public static Task<GetListenerV2Result> InvokeAsync(GetListenerV2Args args, InvokeOptions? opts = null)
public static Output<GetListenerV2Result> Invoke(GetListenerV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetListenerV2Result> getListenerV2(GetListenerV2Args args, InvokeOptions options)
public static Output<GetListenerV2Result> getListenerV2(GetListenerV2Args args, InvokeOptions options)
fn::invoke:
function: openstack:loadbalancer/getListenerV2:getListenerV2
arguments:
# arguments dictionaryThe following arguments are supported:
- Listener
Id string - The ID of the listener. Exactly one of
name,listener_idis required to be set. - Loadbalancer
Id string - The ID of the load balancer associated with the requested listener.
- Name string
- The name of the listener. Exactly one of
name,listener_idis required to be set. - Protocol string
- The protocol of the requested listener.
- Protocol
Port int - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
- Listener
Id string - The ID of the listener. Exactly one of
name,listener_idis required to be set. - Loadbalancer
Id string - The ID of the load balancer associated with the requested listener.
- Name string
- The name of the listener. Exactly one of
name,listener_idis required to be set. - Protocol string
- The protocol of the requested listener.
- Protocol
Port int - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
- listener
Id String - The ID of the listener. Exactly one of
name,listener_idis required to be set. - loadbalancer
Id String - The ID of the load balancer associated with the requested listener.
- name String
- The name of the listener. Exactly one of
name,listener_idis required to be set. - protocol String
- The protocol of the requested listener.
- protocol
Port Integer - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
- listener
Id string - The ID of the listener. Exactly one of
name,listener_idis required to be set. - loadbalancer
Id string - The ID of the load balancer associated with the requested listener.
- name string
- The name of the listener. Exactly one of
name,listener_idis required to be set. - protocol string
- The protocol of the requested listener.
- protocol
Port number - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
- listener_
id str - The ID of the listener. Exactly one of
name,listener_idis required to be set. - loadbalancer_
id str - The ID of the load balancer associated with the requested listener.
- name str
- The name of the listener. Exactly one of
name,listener_idis required to be set. - protocol str
- The protocol of the requested listener.
- protocol_
port int - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
- listener
Id String - The ID of the listener. Exactly one of
name,listener_idis required to be set. - loadbalancer
Id String - The ID of the load balancer associated with the requested listener.
- name String
- The name of the listener. Exactly one of
name,listener_idis required to be set. - protocol String
- The protocol of the requested listener.
- protocol
Port Number - The port on which the requested listener accepts client traffic.
- 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 listener. The loadbalancer' listener will be returned if it has all of the specified tags.
getListenerV2 Result
The following output properties are available:
- Admin
State boolUp - The administrative state of the Listener.
- Allowed
Cidrs List<string> - A list of IPv4, IPv6 or mix of both CIDRs.
- Alpn
Protocols List<string> - A list of ALPN protocols.
- Client
Authentication string - The TLS client authentication mode.
- Client
Ca stringTls Container Ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- Client
Crl stringContainer Ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- Connection
Limit int - The maximum number of connections allowed for the Loadbalancer.
- Default
Pool string - The default pool with which the Listener is associated.
- Default
Pool stringId - The UUID of default pool.
- Default
Tls stringContainer Ref - A reference to a Barbican container of TLS secrets.
- Description string
- The description of the listener.
- Hsts
Include boolSubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- Hsts
Max intAge - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- Hsts
Preload bool - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- Id string
- The provider-assigned unique ID for this managed resource.
- Insert
Headers Dictionary<string, string> - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- L7policies
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Listener V2L7policy> - L7policies are the L7 policies which are part of this listener.
- Listener
Id string - Loadbalancer
Id string - Loadbalancers
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Listener V2Loadbalancer> - A list of load balancer IDs.
- Name string
- The name of the listener.
- Operating
Status string - The operating status of the resource.
- Pools
List<Pulumi.
Open Stack. Load Balancer. Outputs. Get Listener V2Pool> - Pools are the pools which are part of this listener.
- Project
Id string - The owner (project/tenant) ID of the listener.
- Protocol string
- The protocol to loadbalance.
- Protocol
Port int - The port on which to listen to client traffic that is associated with the Loadbalancer.
- Provisioning
Status string - The provisioning status of the Listener.
- Region string
- Sni
Container List<string>Refs - The list of references to TLS secrets.
- List<string>
- Tags is a list of resource tags.
- Timeout
Client intData - Frontend client inactivity timeout in milliseconds.
- Timeout
Member intConnect - Backend member connection timeout in milliseconds.
- Timeout
Member intData - Backend member inactivity timeout in milliseconds.
- Timeout
Tcp intInspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- Tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- Tls
Versions List<string> - A list of TLS protocol versions.
- Admin
State boolUp - The administrative state of the Listener.
- Allowed
Cidrs []string - A list of IPv4, IPv6 or mix of both CIDRs.
- Alpn
Protocols []string - A list of ALPN protocols.
- Client
Authentication string - The TLS client authentication mode.
- Client
Ca stringTls Container Ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- Client
Crl stringContainer Ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- Connection
Limit int - The maximum number of connections allowed for the Loadbalancer.
- Default
Pool string - The default pool with which the Listener is associated.
- Default
Pool stringId - The UUID of default pool.
- Default
Tls stringContainer Ref - A reference to a Barbican container of TLS secrets.
- Description string
- The description of the listener.
- Hsts
Include boolSubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- Hsts
Max intAge - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- Hsts
Preload bool - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- Id string
- The provider-assigned unique ID for this managed resource.
- Insert
Headers map[string]string - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- L7policies
[]Get
Listener V2L7policy - L7policies are the L7 policies which are part of this listener.
- Listener
Id string - Loadbalancer
Id string - Loadbalancers
[]Get
Listener V2Loadbalancer - A list of load balancer IDs.
- Name string
- The name of the listener.
- Operating
Status string - The operating status of the resource.
- Pools
[]Get
Listener V2Pool - Pools are the pools which are part of this listener.
- Project
Id string - The owner (project/tenant) ID of the listener.
- Protocol string
- The protocol to loadbalance.
- Protocol
Port int - The port on which to listen to client traffic that is associated with the Loadbalancer.
- Provisioning
Status string - The provisioning status of the Listener.
- Region string
- Sni
Container []stringRefs - The list of references to TLS secrets.
- []string
- Tags is a list of resource tags.
- Timeout
Client intData - Frontend client inactivity timeout in milliseconds.
- Timeout
Member intConnect - Backend member connection timeout in milliseconds.
- Timeout
Member intData - Backend member inactivity timeout in milliseconds.
- Timeout
Tcp intInspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- Tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- Tls
Versions []string - A list of TLS protocol versions.
- admin
State BooleanUp - The administrative state of the Listener.
- allowed
Cidrs List<String> - A list of IPv4, IPv6 or mix of both CIDRs.
- alpn
Protocols List<String> - A list of ALPN protocols.
- client
Authentication String - The TLS client authentication mode.
- client
Ca StringTls Container Ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- client
Crl StringContainer Ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- connection
Limit Integer - The maximum number of connections allowed for the Loadbalancer.
- default
Pool String - The default pool with which the Listener is associated.
- default
Pool StringId - The UUID of default pool.
- default
Tls StringContainer Ref - A reference to a Barbican container of TLS secrets.
- description String
- The description of the listener.
- hsts
Include BooleanSubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- hsts
Max IntegerAge - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- hsts
Preload Boolean - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- id String
- The provider-assigned unique ID for this managed resource.
- insert
Headers Map<String,String> - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- l7policies
List<Get
Listener V2L7policy> - L7policies are the L7 policies which are part of this listener.
- listener
Id String - loadbalancer
Id String - loadbalancers
List<Get
Listener V2Loadbalancer> - A list of load balancer IDs.
- name String
- The name of the listener.
- operating
Status String - The operating status of the resource.
- pools
List<Get
Listener V2Pool> - Pools are the pools which are part of this listener.
- project
Id String - The owner (project/tenant) ID of the listener.
- protocol String
- The protocol to loadbalance.
- protocol
Port Integer - The port on which to listen to client traffic that is associated with the Loadbalancer.
- provisioning
Status String - The provisioning status of the Listener.
- region String
- sni
Container List<String>Refs - The list of references to TLS secrets.
- List<String>
- Tags is a list of resource tags.
- timeout
Client IntegerData - Frontend client inactivity timeout in milliseconds.
- timeout
Member IntegerConnect - Backend member connection timeout in milliseconds.
- timeout
Member IntegerData - Backend member inactivity timeout in milliseconds.
- timeout
Tcp IntegerInspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- tls
Ciphers String - List of ciphers in OpenSSL format (colon-separated).
- tls
Versions List<String> - A list of TLS protocol versions.
- admin
State booleanUp - The administrative state of the Listener.
- allowed
Cidrs string[] - A list of IPv4, IPv6 or mix of both CIDRs.
- alpn
Protocols string[] - A list of ALPN protocols.
- client
Authentication string - The TLS client authentication mode.
- client
Ca stringTls Container Ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- client
Crl stringContainer Ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- connection
Limit number - The maximum number of connections allowed for the Loadbalancer.
- default
Pool string - The default pool with which the Listener is associated.
- default
Pool stringId - The UUID of default pool.
- default
Tls stringContainer Ref - A reference to a Barbican container of TLS secrets.
- description string
- The description of the listener.
- hsts
Include booleanSubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- hsts
Max numberAge - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- hsts
Preload boolean - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- id string
- The provider-assigned unique ID for this managed resource.
- insert
Headers {[key: string]: string} - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- l7policies
Get
Listener V2L7policy[] - L7policies are the L7 policies which are part of this listener.
- listener
Id string - loadbalancer
Id string - loadbalancers
Get
Listener V2Loadbalancer[] - A list of load balancer IDs.
- name string
- The name of the listener.
- operating
Status string - The operating status of the resource.
- pools
Get
Listener V2Pool[] - Pools are the pools which are part of this listener.
- project
Id string - The owner (project/tenant) ID of the listener.
- protocol string
- The protocol to loadbalance.
- protocol
Port number - The port on which to listen to client traffic that is associated with the Loadbalancer.
- provisioning
Status string - The provisioning status of the Listener.
- region string
- sni
Container string[]Refs - The list of references to TLS secrets.
- string[]
- Tags is a list of resource tags.
- timeout
Client numberData - Frontend client inactivity timeout in milliseconds.
- timeout
Member numberConnect - Backend member connection timeout in milliseconds.
- timeout
Member numberData - Backend member inactivity timeout in milliseconds.
- timeout
Tcp numberInspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- tls
Ciphers string - List of ciphers in OpenSSL format (colon-separated).
- tls
Versions string[] - A list of TLS protocol versions.
- admin_
state_ boolup - The administrative state of the Listener.
- allowed_
cidrs Sequence[str] - A list of IPv4, IPv6 or mix of both CIDRs.
- alpn_
protocols Sequence[str] - A list of ALPN protocols.
- client_
authentication str - The TLS client authentication mode.
- client_
ca_ strtls_ container_ ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- client_
crl_ strcontainer_ ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- connection_
limit int - The maximum number of connections allowed for the Loadbalancer.
- default_
pool str - The default pool with which the Listener is associated.
- default_
pool_ strid - The UUID of default pool.
- default_
tls_ strcontainer_ ref - A reference to a Barbican container of TLS secrets.
- description str
- The description of the listener.
- hsts_
include_ boolsubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- hsts_
max_ intage - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- hsts_
preload bool - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- id str
- The provider-assigned unique ID for this managed resource.
- insert_
headers Mapping[str, str] - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- l7policies
Sequence[Get
Listener V2L7policy] - L7policies are the L7 policies which are part of this listener.
- listener_
id str - loadbalancer_
id str - loadbalancers
Sequence[Get
Listener V2Loadbalancer] - A list of load balancer IDs.
- name str
- The name of the listener.
- operating_
status str - The operating status of the resource.
- pools
Sequence[Get
Listener V2Pool] - Pools are the pools which are part of this listener.
- project_
id str - The owner (project/tenant) ID of the listener.
- protocol str
- The protocol to loadbalance.
- protocol_
port int - The port on which to listen to client traffic that is associated with the Loadbalancer.
- provisioning_
status str - The provisioning status of the Listener.
- region str
- sni_
container_ Sequence[str]refs - The list of references to TLS secrets.
- Sequence[str]
- Tags is a list of resource tags.
- timeout_
client_ intdata - Frontend client inactivity timeout in milliseconds.
- timeout_
member_ intconnect - Backend member connection timeout in milliseconds.
- timeout_
member_ intdata - Backend member inactivity timeout in milliseconds.
- timeout_
tcp_ intinspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- tls_
ciphers str - List of ciphers in OpenSSL format (colon-separated).
- tls_
versions Sequence[str] - A list of TLS protocol versions.
- admin
State BooleanUp - The administrative state of the Listener.
- allowed
Cidrs List<String> - A list of IPv4, IPv6 or mix of both CIDRs.
- alpn
Protocols List<String> - A list of ALPN protocols.
- client
Authentication String - The TLS client authentication mode.
- client
Ca StringTls Container Ref - The ref of the key manager service secret containing a PEM format client CA certificate bundle for TERMINATED_HTTPS listeners.
- client
Crl StringContainer Ref - The URI of the key manager service secret containing a PEM format CA revocation list file for TERMINATED_HTTPS listeners.
- connection
Limit Number - The maximum number of connections allowed for the Loadbalancer.
- default
Pool String - The default pool with which the Listener is associated.
- default
Pool StringId - The UUID of default pool.
- default
Tls StringContainer Ref - A reference to a Barbican container of TLS secrets.
- description String
- The description of the listener.
- hsts
Include BooleanSubdomains - Defines whether the includeSubDomains directive should be added to the Strict-Transport-Security HTTP response header.
- hsts
Max NumberAge - The value of the max_age directive for the Strict-Transport-Security HTTP response header.
- hsts
Preload Boolean - Defines whether the preload directive should be added to the Strict-Transport-Security HTTP response header.
- id String
- The provider-assigned unique ID for this managed resource.
- insert
Headers Map<String> - A dictionary of optional headers to insert into the request before it is sent to the backend member.
- l7policies List<Property Map>
- L7policies are the L7 policies which are part of this listener.
- listener
Id String - loadbalancer
Id String - loadbalancers List<Property Map>
- A list of load balancer IDs.
- name String
- The name of the listener.
- operating
Status String - The operating status of the resource.
- pools List<Property Map>
- Pools are the pools which are part of this listener.
- project
Id String - The owner (project/tenant) ID of the listener.
- protocol String
- The protocol to loadbalance.
- protocol
Port Number - The port on which to listen to client traffic that is associated with the Loadbalancer.
- provisioning
Status String - The provisioning status of the Listener.
- region String
- sni
Container List<String>Refs - The list of references to TLS secrets.
- List<String>
- Tags is a list of resource tags.
- timeout
Client NumberData - Frontend client inactivity timeout in milliseconds.
- timeout
Member NumberConnect - Backend member connection timeout in milliseconds.
- timeout
Member NumberData - Backend member inactivity timeout in milliseconds.
- timeout
Tcp NumberInspect - Time, in milliseconds, to wait for additional TCP packets for content inspection.
- tls
Ciphers String - List of ciphers in OpenSSL format (colon-separated).
- tls
Versions List<String> - A list of TLS protocol versions.
Supporting Types
GetListenerV2L7policy
- Id string
- Id string
- id String
- id string
- id str
- id String
GetListenerV2Loadbalancer
- Id string
- Id string
- id String
- id string
- id str
- id String
GetListenerV2Pool
- Id string
- Id string
- id String
- id string
- id str
- id String
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
openstackTerraform Provider.
OpenStack v5.4.0 published on Wednesday, Nov 12, 2025 by Pulumi
