Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getExternalListeners

This data source provides the list of External Listeners in Oracle Cloud Infrastructure Database Management service.

Lists the listeners in the specified external DB system.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testExternalListeners = Oci.DatabaseManagement.GetExternalListeners.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.External_listener_display_name,
        ExternalDbSystemId = oci_database_management_external_db_system.Test_external_db_system.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.GetExternalListeners(ctx, &databasemanagement.GetExternalListenersArgs{
			CompartmentId:      pulumi.StringRef(_var.Compartment_id),
			DisplayName:        pulumi.StringRef(_var.External_listener_display_name),
			ExternalDbSystemId: pulumi.StringRef(oci_database_management_external_db_system.Test_external_db_system.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.DatabaseManagementFunctions;
import com.pulumi.oci.DatabaseManagement.inputs.GetExternalListenersArgs;
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 testExternalListeners = DatabaseManagementFunctions.getExternalListeners(GetExternalListenersArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.external_listener_display_name())
            .externalDbSystemId(oci_database_management_external_db_system.test_external_db_system().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_listeners = oci.DatabaseManagement.get_external_listeners(compartment_id=var["compartment_id"],
    display_name=var["external_listener_display_name"],
    external_db_system_id=oci_database_management_external_db_system["test_external_db_system"]["id"])

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

const testExternalListeners = oci.DatabaseManagement.getExternalListeners({
    compartmentId: _var.compartment_id,
    displayName: _var.external_listener_display_name,
    externalDbSystemId: oci_database_management_external_db_system.test_external_db_system.id,
});

variables:
  testExternalListeners:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalListeners
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.external_listener_display_name}
        externalDbSystemId: ${oci_database_management_external_db_system.test_external_db_system.id}

Using getExternalListeners

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 getExternalListeners(args: GetExternalListenersArgs, opts?: InvokeOptions): Promise<GetExternalListenersResult>
function getExternalListenersOutput(args: GetExternalListenersOutputArgs, opts?: InvokeOptions): Output<GetExternalListenersResult>

def get_external_listeners(compartment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           external_db_system_id: Optional[str] = None,
                           filters: Optional[Sequence[_databasemanagement.GetExternalListenersFilter]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetExternalListenersResult
def get_external_listeners_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           external_db_system_id: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetExternalListenersFilterArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetExternalListenersResult]

func GetExternalListeners(ctx *Context, args *GetExternalListenersArgs, opts ...InvokeOption) (*GetExternalListenersResult, error)
func GetExternalListenersOutput(ctx *Context, args *GetExternalListenersOutputArgs, opts ...InvokeOption) GetExternalListenersResultOutput

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

public static class GetExternalListeners 
{
    public static Task<GetExternalListenersResult> InvokeAsync(GetExternalListenersArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalListenersResult> Invoke(GetExternalListenersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalListenersResult> getExternalListeners(GetExternalListenersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseManagement/getExternalListeners:getExternalListeners
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters List<GetExternalListenersFilter>

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters []GetExternalListenersFilter

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<GetExternalListenersFilter>

compartmentId string: The OCID of the compartment.
displayName string: A filter to only return the resources that match the entire display name.
externalDbSystemId string: The OCID of the external DB system.
filters GetExternalListenersFilter[]

compartment_id str: The OCID of the compartment.
display_name str: A filter to only return the resources that match the entire display name.
external_db_system_id str: The OCID of the external DB system.
filters GetExternalListenersFilter]

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<Property Map>

getExternalListeners Result

The following output properties are available:

ExternalListenerCollections List<GetExternalListenersExternalListenerCollection>: The list of external_listener_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment in which the external database resides.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the listener is a part of.
Filters List<GetExternalListenersFilter>

ExternalListenerCollections []GetExternalListenersExternalListenerCollection: The list of external_listener_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment in which the external database resides.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the listener is a part of.
Filters []GetExternalListenersFilter

externalListenerCollections List<GetExternalListenersExternalListenerCollection>: The list of external_listener_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment in which the external database resides.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the listener is a part of.
filters List<GetExternalListenersFilter>

externalListenerCollections GetExternalListenersExternalListenerCollection[]: The list of external_listener_collection.
id string: The provider-assigned unique ID for this managed resource.
compartmentId string: The OCID of the compartment in which the external database resides.
displayName string: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId string: The OCID of the external DB system that the listener is a part of.
filters GetExternalListenersFilter[]

external_listener_collections GetExternalListenersExternalListenerCollection]: The list of external_listener_collection.
id str: The provider-assigned unique ID for this managed resource.
compartment_id str: The OCID of the compartment in which the external database resides.
display_name str: The user-friendly name for the database. The name does not have to be unique.
external_db_system_id str: The OCID of the external DB system that the listener is a part of.
filters GetExternalListenersFilter]

externalListenerCollections List<Property Map>: The list of external_listener_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment in which the external database resides.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the listener is a part of.
filters List<Property Map>

Supporting Types

GetExternalListenersExternalListenerCollection

Items List<GetExternalListenersExternalListenerCollectionItem>

Items []GetExternalListenersExternalListenerCollectionItem

items List<GetExternalListenersExternalListenerCollectionItem>

items GetExternalListenersExternalListenerCollectionItem[]

items GetExternalListenersExternalListenerCollectionItem]

items List<Property Map>

GetExternalListenersExternalListenerCollectionItem

AdditionalDetails Dictionary<string, object>: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
AdrHomeDirectory string: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external listener.
DisplayName string: A filter to only return the resources that match the entire display name.
Endpoints List<GetExternalListenersExternalListenerCollectionItemEndpoint>: The list of protocol addresses the listener is configured to listen on.
ExternalConnectorId string: The OCID of the external connector.
ExternalDbHomeId string: The OCID of the external DB home.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system.
ExternalListenerId string
HostName string: The name of the host on which the external listener is running.
Id string: The OCID of the external database.
LifecycleDetails string: Additional information about the current lifecycle state.
ListenerAlias string: The listener alias.
ListenerOraLocation string: The location of the listener configuration file listener.ora.
ListenerType string: The type of listener.
LogDirectory string: The destination directory of the listener log file.
OracleHome string: The Oracle home location of the listener.
ServicedAsms List<GetExternalListenersExternalListenerCollectionItemServicedAsm>: The list of ASMs that are serviced by the listener.
ServicedDatabases List<GetExternalListenersExternalListenerCollectionItemServicedDatabase>: The list of databases that are serviced by the listener.
State string: The current lifecycle state of the external listener.
TimeCreated string: The date and time the external listener was created.
TimeUpdated string: The date and time the external listener was last updated.
TraceDirectory string: The destination directory of the listener trace file.
Version string: The listener version.

AdditionalDetails map[string]interface{}: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
AdrHomeDirectory string: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external listener.
DisplayName string: A filter to only return the resources that match the entire display name.
Endpoints []GetExternalListenersExternalListenerCollectionItemEndpoint: The list of protocol addresses the listener is configured to listen on.
ExternalConnectorId string: The OCID of the external connector.
ExternalDbHomeId string: The OCID of the external DB home.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system.
ExternalListenerId string
HostName string: The name of the host on which the external listener is running.
Id string: The OCID of the external database.
LifecycleDetails string: Additional information about the current lifecycle state.
ListenerAlias string: The listener alias.
ListenerOraLocation string: The location of the listener configuration file listener.ora.
ListenerType string: The type of listener.
LogDirectory string: The destination directory of the listener log file.
OracleHome string: The Oracle home location of the listener.
ServicedAsms []GetExternalListenersExternalListenerCollectionItemServicedAsm: The list of ASMs that are serviced by the listener.
ServicedDatabases []GetExternalListenersExternalListenerCollectionItemServicedDatabase: The list of databases that are serviced by the listener.
State string: The current lifecycle state of the external listener.
TimeCreated string: The date and time the external listener was created.
TimeUpdated string: The date and time the external listener was last updated.
TraceDirectory string: The destination directory of the listener trace file.
Version string: The listener version.

additionalDetails Map<String,Object>: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
adrHomeDirectory String: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external listener.
displayName String: A filter to only return the resources that match the entire display name.
endpoints List<GetExternalListenersExternalListenerCollectionItemEndpoint>: The list of protocol addresses the listener is configured to listen on.
externalConnectorId String: The OCID of the external connector.
externalDbHomeId String: The OCID of the external DB home.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system.
externalListenerId String
hostName String: The name of the host on which the external listener is running.
id String: The OCID of the external database.
lifecycleDetails String: Additional information about the current lifecycle state.
listenerAlias String: The listener alias.
listenerOraLocation String: The location of the listener configuration file listener.ora.
listenerType String: The type of listener.
logDirectory String: The destination directory of the listener log file.
oracleHome String: The Oracle home location of the listener.
servicedAsms List<GetExternalListenersExternalListenerCollectionItemServicedAsm>: The list of ASMs that are serviced by the listener.
servicedDatabases List<GetExternalListenersExternalListenerCollectionItemServicedDatabase>: The list of databases that are serviced by the listener.
state String: The current lifecycle state of the external listener.
timeCreated String: The date and time the external listener was created.
timeUpdated String: The date and time the external listener was last updated.
traceDirectory String: The destination directory of the listener trace file.
version String: The listener version.

additionalDetails {[key: string]: any}: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
adrHomeDirectory string: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
compartmentId string: The OCID of the compartment.
componentName string: The name of the external listener.
displayName string: A filter to only return the resources that match the entire display name.
endpoints GetExternalListenersExternalListenerCollectionItemEndpoint[]: The list of protocol addresses the listener is configured to listen on.
externalConnectorId string: The OCID of the external connector.
externalDbHomeId string: The OCID of the external DB home.
externalDbNodeId string: The OCID of the external DB node.
externalDbSystemId string: The OCID of the external DB system.
externalListenerId string
hostName string: The name of the host on which the external listener is running.
id string: The OCID of the external database.
lifecycleDetails string: Additional information about the current lifecycle state.
listenerAlias string: The listener alias.
listenerOraLocation string: The location of the listener configuration file listener.ora.
listenerType string: The type of listener.
logDirectory string: The destination directory of the listener log file.
oracleHome string: The Oracle home location of the listener.
servicedAsms GetExternalListenersExternalListenerCollectionItemServicedAsm[]: The list of ASMs that are serviced by the listener.
servicedDatabases GetExternalListenersExternalListenerCollectionItemServicedDatabase[]: The list of databases that are serviced by the listener.
state string: The current lifecycle state of the external listener.
timeCreated string: The date and time the external listener was created.
timeUpdated string: The date and time the external listener was last updated.
traceDirectory string: The destination directory of the listener trace file.
version string: The listener version.

additional_details Mapping[str, Any]: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
adr_home_directory str: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
compartment_id str: The OCID of the compartment.
component_name str: The name of the external listener.
display_name str: A filter to only return the resources that match the entire display name.
endpoints GetExternalListenersExternalListenerCollectionItemEndpoint]: The list of protocol addresses the listener is configured to listen on.
external_connector_id str: The OCID of the external connector.
external_db_home_id str: The OCID of the external DB home.
external_db_node_id str: The OCID of the external DB node.
external_db_system_id str: The OCID of the external DB system.
external_listener_id str
host_name str: The name of the host on which the external listener is running.
id str: The OCID of the external database.
lifecycle_details str: Additional information about the current lifecycle state.
listener_alias str: The listener alias.
listener_ora_location str: The location of the listener configuration file listener.ora.
listener_type str: The type of listener.
log_directory str: The destination directory of the listener log file.
oracle_home str: The Oracle home location of the listener.
serviced_asms GetExternalListenersExternalListenerCollectionItemServicedAsm]: The list of ASMs that are serviced by the listener.
serviced_databases GetExternalListenersExternalListenerCollectionItemServicedDatabase]: The list of databases that are serviced by the listener.
state str: The current lifecycle state of the external listener.
time_created str: The date and time the external listener was created.
time_updated str: The date and time the external listener was last updated.
trace_directory str: The destination directory of the listener trace file.
version str: The listener version.

additionalDetails Map<Any>: The additional details of the external listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
adrHomeDirectory String: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external listener.
displayName String: A filter to only return the resources that match the entire display name.
endpoints List<Property Map>: The list of protocol addresses the listener is configured to listen on.
externalConnectorId String: The OCID of the external connector.
externalDbHomeId String: The OCID of the external DB home.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system.
externalListenerId String
hostName String: The name of the host on which the external listener is running.
id String: The OCID of the external database.
lifecycleDetails String: Additional information about the current lifecycle state.
listenerAlias String: The listener alias.
listenerOraLocation String: The location of the listener configuration file listener.ora.
listenerType String: The type of listener.
logDirectory String: The destination directory of the listener log file.
oracleHome String: The Oracle home location of the listener.
servicedAsms List<Property Map>: The list of ASMs that are serviced by the listener.
servicedDatabases List<Property Map>: The list of databases that are serviced by the listener.
state String: The current lifecycle state of the external listener.
timeCreated String: The date and time the external listener was created.
timeUpdated String: The date and time the external listener was last updated.
traceDirectory String: The destination directory of the listener trace file.
version String: The listener version.

GetExternalListenersExternalListenerCollectionItemEndpoint

Host string: The host name or IP address.
Key string: The unique name of the service.
Port int: The port number.
Protocol string: The listener protocol.
Services List<string>: The list of services registered with the listener.

Host string: The host name or IP address.
Key string: The unique name of the service.
Port int: The port number.
Protocol string: The listener protocol.
Services []string: The list of services registered with the listener.

host String: The host name or IP address.
key String: The unique name of the service.
port Integer: The port number.
protocol String: The listener protocol.
services List<String>: The list of services registered with the listener.

host string: The host name or IP address.
key string: The unique name of the service.
port number: The port number.
protocol string: The listener protocol.
services string[]: The list of services registered with the listener.

host str: The host name or IP address.
key str: The unique name of the service.
port int: The port number.
protocol str: The listener protocol.
services Sequence[str]: The list of services registered with the listener.

host String: The host name or IP address.
key String: The unique name of the service.
port Number: The port number.
protocol String: The listener protocol.
services List<String>: The list of services registered with the listener.

GetExternalListenersExternalListenerCollectionItemServicedAsm

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
Id string: The OCID of the external database.

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
Id string: The OCID of the external database.

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
id String: The OCID of the external database.

compartmentId string: The OCID of the compartment.
displayName string: A filter to only return the resources that match the entire display name.
id string: The OCID of the external database.

compartment_id str: The OCID of the compartment.
display_name str: A filter to only return the resources that match the entire display name.
id str: The OCID of the external database.

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
id String: The OCID of the external database.

GetExternalListenersExternalListenerCollectionItemServicedDatabase

CompartmentId string: The OCID of the compartment.
DatabaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
DatabaseType string: The type of Oracle Database installation.
DbUniqueName string: The unique name of the external database.
DisplayName string: A filter to only return the resources that match the entire display name.
Id string: The OCID of the external database.
IsManaged bool: Indicates whether the database is a Managed Database or not.

CompartmentId string: The OCID of the compartment.
DatabaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
DatabaseType string: The type of Oracle Database installation.
DbUniqueName string: The unique name of the external database.
DisplayName string: A filter to only return the resources that match the entire display name.
Id string: The OCID of the external database.
IsManaged bool: Indicates whether the database is a Managed Database or not.

compartmentId String: The OCID of the compartment.
databaseSubType String: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType String: The type of Oracle Database installation.
dbUniqueName String: The unique name of the external database.
displayName String: A filter to only return the resources that match the entire display name.
id String: The OCID of the external database.
isManaged Boolean: Indicates whether the database is a Managed Database or not.

compartmentId string: The OCID of the compartment.
databaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType string: The type of Oracle Database installation.
dbUniqueName string: The unique name of the external database.
displayName string: A filter to only return the resources that match the entire display name.
id string: The OCID of the external database.
isManaged boolean: Indicates whether the database is a Managed Database or not.

compartment_id str: The OCID of the compartment.
database_sub_type str: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
database_type str: The type of Oracle Database installation.
db_unique_name str: The unique name of the external database.
display_name str: A filter to only return the resources that match the entire display name.
id str: The OCID of the external database.
is_managed bool: Indicates whether the database is a Managed Database or not.

compartmentId String: The OCID of the compartment.
databaseSubType String: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType String: The type of Oracle Database installation.
dbUniqueName String: The unique name of the external database.
displayName String: A filter to only return the resources that match the entire display name.
id String: The OCID of the external database.
isManaged Boolean: Indicates whether the database is a Managed Database or not.

GetExternalListenersFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

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