Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.DatabaseManagement.getExternalListener
Explore with Pulumi AI
This data source provides details about a specific External Listener resource in Oracle Cloud Infrastructure Database Management service.
Gets the details for the external listener specified by externalListenerId.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testExternalListener = oci.DatabaseManagement.getExternalListener({
    externalListenerId: testExternalListenerOciDatabaseManagementExternalListener.id,
});
import pulumi
import pulumi_oci as oci
test_external_listener = oci.DatabaseManagement.get_external_listener(external_listener_id=test_external_listener_oci_database_management_external_listener["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/databasemanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.GetExternalListener(ctx, &databasemanagement.GetExternalListenerArgs{
			ExternalListenerId: testExternalListenerOciDatabaseManagementExternalListener.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 testExternalListener = Oci.DatabaseManagement.GetExternalListener.Invoke(new()
    {
        ExternalListenerId = testExternalListenerOciDatabaseManagementExternalListener.Id,
    });
});
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.GetExternalListenerArgs;
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 testExternalListener = DatabaseManagementFunctions.getExternalListener(GetExternalListenerArgs.builder()
            .externalListenerId(testExternalListenerOciDatabaseManagementExternalListener.id())
            .build());
    }
}
variables:
  testExternalListener:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalListener
      arguments:
        externalListenerId: ${testExternalListenerOciDatabaseManagementExternalListener.id}
Using getExternalListener
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 getExternalListener(args: GetExternalListenerArgs, opts?: InvokeOptions): Promise<GetExternalListenerResult>
function getExternalListenerOutput(args: GetExternalListenerOutputArgs, opts?: InvokeOptions): Output<GetExternalListenerResult>def get_external_listener(external_listener_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalListenerResult
def get_external_listener_output(external_listener_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetExternalListenerResult]func GetExternalListener(ctx *Context, args *GetExternalListenerArgs, opts ...InvokeOption) (*GetExternalListenerResult, error)
func GetExternalListenerOutput(ctx *Context, args *GetExternalListenerOutputArgs, opts ...InvokeOption) GetExternalListenerResultOutput> Note: This function is named GetExternalListener in the Go SDK.
public static class GetExternalListener 
{
    public static Task<GetExternalListenerResult> InvokeAsync(GetExternalListenerArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalListenerResult> Invoke(GetExternalListenerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetExternalListenerResult> getExternalListener(GetExternalListenerArgs args, InvokeOptions options)
public static Output<GetExternalListenerResult> getExternalListener(GetExternalListenerArgs args, InvokeOptions options)
fn::invoke:
  function: oci:DatabaseManagement/getExternalListener:getExternalListener
  arguments:
    # arguments dictionaryThe following arguments are supported:
- External
Listener stringId  - The OCID of the external listener.
 
- External
Listener stringId  - The OCID of the external listener.
 
- external
Listener StringId  - The OCID of the external listener.
 
- external
Listener stringId  - The OCID of the external listener.
 
- external_
listener_ strid  - The OCID of the external listener.
 
- external
Listener StringId  - The OCID of the external listener.
 
getExternalListener Result
The following output properties are available:
- Additional
Details Dictionary<string, string> - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - Adr
Home stringDirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Component
Name string - The name of the external listener.
 - Dictionary<string, string>
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Endpoints
List<Get
External Listener Endpoint>  - The list of protocol addresses the listener is configured to listen on.
 - External
Connector stringId  - The OCID of the external connector.
 - External
Db stringHome Id  - The OCID of the external DB home.
 - External
Db stringNode Id  - The OCID of the external DB node.
 - External
Db stringSystem Id  - The OCID of the external DB system that the listener is a part of.
 - External
Listener stringId  - Dictionary<string, string>
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - Host
Name string - The name of the host on which the external listener is running.
 - Id string
 - The OCID of the external database.
 - Lifecycle
Details string - Additional information about the current lifecycle state.
 - Listener
Alias string - The listener alias.
 - Listener
Ora stringLocation  - The location of the listener configuration file listener.ora.
 - Listener
Type string - The type of listener.
 - Log
Directory string - The destination directory of the listener log file.
 - Oracle
Home string - The Oracle home location of the listener.
 - Serviced
Asms List<GetExternal Listener Serviced Asm>  - The list of ASMs that are serviced by the listener.
 - Serviced
Databases List<GetExternal Listener Serviced Database>  - The list of databases that are serviced by the listener.
 - State string
 - The current lifecycle state of the external listener.
 - Dictionary<string, string>
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the external listener was created.
 - Time
Updated string - The date and time the external listener was last updated.
 - Trace
Directory string - The destination directory of the listener trace file.
 - Version string
 - The listener version.
 
- Additional
Details map[string]string - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - Adr
Home stringDirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Component
Name string - The name of the external listener.
 - map[string]string
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Endpoints
[]Get
External Listener Endpoint  - The list of protocol addresses the listener is configured to listen on.
 - External
Connector stringId  - The OCID of the external connector.
 - External
Db stringHome Id  - The OCID of the external DB home.
 - External
Db stringNode Id  - The OCID of the external DB node.
 - External
Db stringSystem Id  - The OCID of the external DB system that the listener is a part of.
 - External
Listener stringId  - map[string]string
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - Host
Name string - The name of the host on which the external listener is running.
 - Id string
 - The OCID of the external database.
 - Lifecycle
Details string - Additional information about the current lifecycle state.
 - Listener
Alias string - The listener alias.
 - Listener
Ora stringLocation  - The location of the listener configuration file listener.ora.
 - Listener
Type string - The type of listener.
 - Log
Directory string - The destination directory of the listener log file.
 - Oracle
Home string - The Oracle home location of the listener.
 - Serviced
Asms []GetExternal Listener Serviced Asm  - The list of ASMs that are serviced by the listener.
 - Serviced
Databases []GetExternal Listener Serviced Database  - The list of databases that are serviced by the listener.
 - State string
 - The current lifecycle state of the external listener.
 - map[string]string
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the external listener was created.
 - Time
Updated string - The date and time the external listener was last updated.
 - Trace
Directory string - The destination directory of the listener trace file.
 - Version string
 - The listener version.
 
- additional
Details Map<String,String> - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - adr
Home StringDirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - compartment
Id String - The OCID of the compartment in which the external database resides.
 - component
Name String - The name of the external listener.
 - Map<String,String>
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - endpoints
List<Get
External Listener Endpoint>  - The list of protocol addresses the listener is configured to listen on.
 - external
Connector StringId  - The OCID of the external connector.
 - external
Db StringHome Id  - The OCID of the external DB home.
 - external
Db StringNode Id  - The OCID of the external DB node.
 - external
Db StringSystem Id  - The OCID of the external DB system that the listener is a part of.
 - external
Listener StringId  - Map<String,String>
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - host
Name String - The name of the host on which the external listener is running.
 - id String
 - The OCID of the external database.
 - lifecycle
Details String - Additional information about the current lifecycle state.
 - listener
Alias String - The listener alias.
 - listener
Ora StringLocation  - The location of the listener configuration file listener.ora.
 - listener
Type String - The type of listener.
 - log
Directory String - The destination directory of the listener log file.
 - oracle
Home String - The Oracle home location of the listener.
 - serviced
Asms List<GetExternal Listener Serviced Asm>  - The list of ASMs that are serviced by the listener.
 - serviced
Databases List<GetExternal Listener Serviced Database>  - The list of databases that are serviced by the listener.
 - state String
 - The current lifecycle state of the external listener.
 - Map<String,String>
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the external listener was created.
 - time
Updated String - The date and time the external listener was last updated.
 - trace
Directory String - The destination directory of the listener trace file.
 - version String
 - The listener version.
 
- additional
Details {[key: string]: string} - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - adr
Home stringDirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - compartment
Id string - The OCID of the compartment in which the external database resides.
 - component
Name string - The name of the external listener.
 - {[key: string]: string}
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - endpoints
Get
External Listener Endpoint[]  - The list of protocol addresses the listener is configured to listen on.
 - external
Connector stringId  - The OCID of the external connector.
 - external
Db stringHome Id  - The OCID of the external DB home.
 - external
Db stringNode Id  - The OCID of the external DB node.
 - external
Db stringSystem Id  - The OCID of the external DB system that the listener is a part of.
 - external
Listener stringId  - {[key: string]: string}
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - host
Name string - The name of the host on which the external listener is running.
 - id string
 - The OCID of the external database.
 - lifecycle
Details string - Additional information about the current lifecycle state.
 - listener
Alias string - The listener alias.
 - listener
Ora stringLocation  - The location of the listener configuration file listener.ora.
 - listener
Type string - The type of listener.
 - log
Directory string - The destination directory of the listener log file.
 - oracle
Home string - The Oracle home location of the listener.
 - serviced
Asms GetExternal Listener Serviced Asm[]  - The list of ASMs that are serviced by the listener.
 - serviced
Databases GetExternal Listener Serviced Database[]  - The list of databases that are serviced by the listener.
 - state string
 - The current lifecycle state of the external listener.
 - {[key: string]: string}
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time the external listener was created.
 - time
Updated string - The date and time the external listener was last updated.
 - trace
Directory string - The destination directory of the listener trace file.
 - version string
 - The listener version.
 
- additional_
details Mapping[str, str] - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - adr_
home_ strdirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - compartment_
id str - The OCID of the compartment in which the external database resides.
 - component_
name str - The name of the external listener.
 - Mapping[str, str]
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - display_
name str - The user-friendly name for the database. The name does not have to be unique.
 - endpoints
Sequence[databasemanagement.
Get External Listener Endpoint]  - The list of protocol addresses the listener is configured to listen on.
 - external_
connector_ strid  - The OCID of the external connector.
 - external_
db_ strhome_ id  - The OCID of the external DB home.
 - external_
db_ strnode_ id  - The OCID of the external DB node.
 - external_
db_ strsystem_ id  - The OCID of the external DB system that the listener is a part of.
 - external_
listener_ strid  - Mapping[str, str]
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - 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_ strlocation  - 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 Sequence[databasemanagement.Get External Listener Serviced Asm]  - The list of ASMs that are serviced by the listener.
 - serviced_
databases Sequence[databasemanagement.Get External Listener Serviced Database]  - The list of databases that are serviced by the listener.
 - state str
 - The current lifecycle state of the external listener.
 - Mapping[str, str]
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - 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.
 
- additional
Details Map<String> - The additional details of the external listener defined in 
{"key": "value"}format. Example:{"bar-key": "value"} - adr
Home StringDirectory  - The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
 - compartment
Id String - The OCID of the compartment in which the external database resides.
 - component
Name String - The name of the external listener.
 - Map<String>
 - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: 
{"Operations.CostCenter": "42"} - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - endpoints List<Property Map>
 - The list of protocol addresses the listener is configured to listen on.
 - external
Connector StringId  - The OCID of the external connector.
 - external
Db StringHome Id  - The OCID of the external DB home.
 - external
Db StringNode Id  - The OCID of the external DB node.
 - external
Db StringSystem Id  - The OCID of the external DB system that the listener is a part of.
 - external
Listener StringId  - Map<String>
 - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: 
{"Department": "Finance"} - host
Name String - The name of the host on which the external listener is running.
 - id String
 - The OCID of the external database.
 - lifecycle
Details String - Additional information about the current lifecycle state.
 - listener
Alias String - The listener alias.
 - listener
Ora StringLocation  - The location of the listener configuration file listener.ora.
 - listener
Type String - The type of listener.
 - log
Directory String - The destination directory of the listener log file.
 - oracle
Home String - The Oracle home location of the listener.
 - serviced
Asms List<Property Map> - The list of ASMs that are serviced by the listener.
 - serviced
Databases List<Property Map> - The list of databases that are serviced by the listener.
 - state String
 - The current lifecycle state of the external listener.
 - Map<String>
 - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: 
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the external listener was created.
 - time
Updated String - The date and time the external listener was last updated.
 - trace
Directory String - The destination directory of the listener trace file.
 - version String
 - The listener version.
 
Supporting Types
GetExternalListenerEndpoint   
GetExternalListenerServicedAsm    
- Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Id string
 - The OCID of the external database.
 
- Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Id string
 - The OCID of the external database.
 
- compartment
Id String - The OCID of the compartment in which the external database resides.
 - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - id String
 - The OCID of the external database.
 
- compartment
Id string - The OCID of the compartment in which the external database resides.
 - display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - id string
 - The OCID of the external database.
 
- 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.
 - id str
 - The OCID of the external database.
 
- compartment
Id String - The OCID of the compartment in which the external database resides.
 - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - id String
 - The OCID of the external database.
 
GetExternalListenerServicedDatabase    
- Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Database
Sub stringType  - 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 string - The type of Oracle Database installation.
 - Db
Unique stringName  - The unique name of the external database.
 - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Id string
 - The OCID of the external database.
 - Is
Managed bool - Indicates whether the database is a Managed Database or not.
 
- Compartment
Id string - The OCID of the compartment in which the external database resides.
 - Database
Sub stringType  - 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 string - The type of Oracle Database installation.
 - Db
Unique stringName  - The unique name of the external database.
 - Display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - Id string
 - The OCID of the external database.
 - Is
Managed bool - Indicates whether the database is a Managed Database or not.
 
- compartment
Id String - The OCID of the compartment in which the external database resides.
 - database
Sub StringType  - 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 String - The type of Oracle Database installation.
 - db
Unique StringName  - The unique name of the external database.
 - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - id String
 - The OCID of the external database.
 - is
Managed Boolean - Indicates whether the database is a Managed Database or not.
 
- compartment
Id string - The OCID of the compartment in which the external database resides.
 - database
Sub stringType  - 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 string - The type of Oracle Database installation.
 - db
Unique stringName  - The unique name of the external database.
 - display
Name string - The user-friendly name for the database. The name does not have to be unique.
 - id string
 - The OCID of the external database.
 - is
Managed boolean - Indicates whether the database is a Managed Database or not.
 
- compartment_
id str - The OCID of the compartment in which the external database resides.
 - database_
sub_ strtype  - 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_ strname  - The unique name of the external database.
 - display_
name str - The user-friendly name for the database. The name does not have to be unique.
 - id str
 - The OCID of the external database.
 - is_
managed bool - Indicates whether the database is a Managed Database or not.
 
- compartment
Id String - The OCID of the compartment in which the external database resides.
 - database
Sub StringType  - 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 String - The type of Oracle Database installation.
 - db
Unique StringName  - The unique name of the external database.
 - display
Name String - The user-friendly name for the database. The name does not have to be unique.
 - id String
 - The OCID of the external database.
 - is
Managed Boolean - Indicates whether the database is a Managed Database or not.
 
Package Details
- Repository
 - oci pulumi/pulumi-oci
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
ociTerraform Provider.