Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.NetworkLoadBalancer.getListeners

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testListeners = oci.NetworkLoadBalancer.getListeners({
    networkLoadBalancerId: testNetworkLoadBalancer.id,
});

import pulumi
import pulumi_oci as oci

test_listeners = oci.NetworkLoadBalancer.get_listeners(network_load_balancer_id=test_network_load_balancer["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/networkloadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkloadbalancer.GetListeners(ctx, &networkloadbalancer.GetListenersArgs{
			NetworkLoadBalancerId: testNetworkLoadBalancer.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testListeners = Oci.NetworkLoadBalancer.GetListeners.Invoke(new()
    {
        NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancerFunctions;
import com.pulumi.oci.NetworkLoadBalancer.inputs.GetListenersArgs;
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 testListeners = NetworkLoadBalancerFunctions.getListeners(GetListenersArgs.builder()
            .networkLoadBalancerId(testNetworkLoadBalancer.id())
            .build());

    }
}

variables:
  testListeners:
    fn::invoke:
      function: oci:NetworkLoadBalancer:getListeners
      arguments:
        networkLoadBalancerId: ${testNetworkLoadBalancer.id}

Using getListeners

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.

TypeScript
Python
Go
C#
Java
YAML

function getListeners(args: GetListenersArgs, opts?: InvokeOptions): Promise<GetListenersResult>
function getListenersOutput(args: GetListenersOutputArgs, opts?: InvokeOptions): Output<GetListenersResult>

def get_listeners(filters: Optional[Sequence[_networkloadbalancer.GetListenersFilter]] = None,
                  network_load_balancer_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListenersResult
def get_listeners_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_networkloadbalancer.GetListenersFilterArgs]]]] = None,
                  network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListenersResult]

func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)
func GetListenersOutput(ctx *Context, args *GetListenersOutputArgs, opts ...InvokeOption) GetListenersResultOutput

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

public static class GetListeners 
{
    public static Task<GetListenersResult> InvokeAsync(GetListenersArgs args, InvokeOptions? opts = null)
    public static Output<GetListenersResult> Invoke(GetListenersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
public static Output<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)

fn::invoke:
  function: oci:NetworkLoadBalancer/getListeners:getListeners
  arguments:
    # arguments dictionary

The following arguments are supported:

NetworkLoadBalancerId string: The OCID of the network load balancer to update.
Filters List<GetListenersFilter>

NetworkLoadBalancerId string: The OCID of the network load balancer to update.
Filters []GetListenersFilter

networkLoadBalancerId String: The OCID of the network load balancer to update.
filters List<GetListenersFilter>

networkLoadBalancerId string: The OCID of the network load balancer to update.
filters GetListenersFilter[]

network_load_balancer_id str: The OCID of the network load balancer to update.
filters Sequence[networkloadbalancer.GetListenersFilter]

networkLoadBalancerId String: The OCID of the network load balancer to update.
filters List<Property Map>

getListeners Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ListenerCollections List<GetListenersListenerCollection>: The list of listener_collection.
NetworkLoadBalancerId string
Filters List<GetListenersFilter>

Id string: The provider-assigned unique ID for this managed resource.
ListenerCollections []GetListenersListenerCollection: The list of listener_collection.
NetworkLoadBalancerId string
Filters []GetListenersFilter

id String: The provider-assigned unique ID for this managed resource.
listenerCollections List<GetListenersListenerCollection>: The list of listener_collection.
networkLoadBalancerId String
filters List<GetListenersFilter>

id string: The provider-assigned unique ID for this managed resource.
listenerCollections GetListenersListenerCollection[]: The list of listener_collection.
networkLoadBalancerId string
filters GetListenersFilter[]

id str: The provider-assigned unique ID for this managed resource.
listener_collections Sequence[networkloadbalancer.GetListenersListenerCollection]: The list of listener_collection.
network_load_balancer_id str
filters Sequence[networkloadbalancer.GetListenersFilter]

id String: The provider-assigned unique ID for this managed resource.
listenerCollections List<Property Map>: The list of listener_collection.
networkLoadBalancerId String
filters List<Property Map>

Supporting Types

GetListenersFilter

Name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
Values List<string>
Regex bool

Name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
Values []string
Regex bool

name String: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
values List<String>
regex Boolean

name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
values string[]
regex boolean

name str: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
values Sequence[str]
regex bool

name String: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
values List<String>
regex Boolean

GetListenersListenerCollection

Items List<GetListenersListenerCollectionItem>

Items []GetListenersListenerCollectionItem

items List<GetListenersListenerCollectionItem>

items GetListenersListenerCollectionItem[]

items Sequence[networkloadbalancer.GetListenersListenerCollectionItem]

items List<Property Map>

GetListenersListenerCollectionItem

DefaultBackendSetName string: The name of the associated backend set. Example: example_backend_set
Id string
IpVersion string: IP version associated with the listener.
IsPpv2enabled bool: Property to enable/disable PPv2 feature for this listener.
L3ipIdleTimeout int: The duration for L3IP idle timeout in seconds. Example: 200
Name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
NetworkLoadBalancerId string: The OCID of the network load balancer to update.
Port int: The communication port for the listener. Example: 80
Protocol string: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
TcpIdleTimeout int: The duration for TCP idle timeout in seconds. Example: 300
UdpIdleTimeout int: The duration for UDP idle timeout in seconds. Example: 120

DefaultBackendSetName string: The name of the associated backend set. Example: example_backend_set
Id string
IpVersion string: IP version associated with the listener.
IsPpv2enabled bool: Property to enable/disable PPv2 feature for this listener.
L3ipIdleTimeout int: The duration for L3IP idle timeout in seconds. Example: 200
Name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
NetworkLoadBalancerId string: The OCID of the network load balancer to update.
Port int: The communication port for the listener. Example: 80
Protocol string: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
TcpIdleTimeout int: The duration for TCP idle timeout in seconds. Example: 300
UdpIdleTimeout int: The duration for UDP idle timeout in seconds. Example: 120

defaultBackendSetName String: The name of the associated backend set. Example: example_backend_set
id String
ipVersion String: IP version associated with the listener.
isPpv2enabled Boolean: Property to enable/disable PPv2 feature for this listener.
l3ipIdleTimeout Integer: The duration for L3IP idle timeout in seconds. Example: 200
name String: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
networkLoadBalancerId String: The OCID of the network load balancer to update.
port Integer: The communication port for the listener. Example: 80
protocol String: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
tcpIdleTimeout Integer: The duration for TCP idle timeout in seconds. Example: 300
udpIdleTimeout Integer: The duration for UDP idle timeout in seconds. Example: 120

defaultBackendSetName string: The name of the associated backend set. Example: example_backend_set
id string
ipVersion string: IP version associated with the listener.
isPpv2enabled boolean: Property to enable/disable PPv2 feature for this listener.
l3ipIdleTimeout number: The duration for L3IP idle timeout in seconds. Example: 200
name string: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
networkLoadBalancerId string: The OCID of the network load balancer to update.
port number: The communication port for the listener. Example: 80
protocol string: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
tcpIdleTimeout number: The duration for TCP idle timeout in seconds. Example: 300
udpIdleTimeout number: The duration for UDP idle timeout in seconds. Example: 120

default_backend_set_name str: The name of the associated backend set. Example: example_backend_set
id str
ip_version str: IP version associated with the listener.
is_ppv2enabled bool: Property to enable/disable PPv2 feature for this listener.
l3ip_idle_timeout int: The duration for L3IP idle timeout in seconds. Example: 200
name str: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
network_load_balancer_id str: The OCID of the network load balancer to update.
port int: The communication port for the listener. Example: 80
protocol str: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
tcp_idle_timeout int: The duration for TCP idle timeout in seconds. Example: 300
udp_idle_timeout int: The duration for UDP idle timeout in seconds. Example: 120

defaultBackendSetName String: The name of the associated backend set. Example: example_backend_set
id String
ipVersion String: IP version associated with the listener.
isPpv2enabled Boolean: Property to enable/disable PPv2 feature for this listener.
l3ipIdleTimeout Number: The duration for L3IP idle timeout in seconds. Example: 200
name String: A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
networkLoadBalancerId String: The OCID of the network load balancer to update.
port Number: The communication port for the listener. Example: 80
protocol String: The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
tcpIdleTimeout Number: The duration for TCP idle timeout in seconds. Example: 300
udpIdleTimeout Number: The duration for UDP idle timeout in seconds. Example: 120

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.NetworkLoadBalancer.getListeners

On this page

On this page

Example Usage

Using getListeners

getListeners Result

Supporting Types

GetListenersFilter

GetListenersListenerCollection

GetListenersListenerCollectionItem

Package Details

On this page

On this page