1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getInstanceConsoleConnections
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

oci.Core.getInstanceConsoleConnections

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

    This data source provides the list of Instance Console Connections in Oracle Cloud Infrastructure Core service.

    Lists the console connections for the specified compartment or instance.

    For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testInstanceConsoleConnections = oci.Core.getInstanceConsoleConnections({
        compartmentId: compartmentId,
        instanceId: testInstance.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_instance_console_connections = oci.Core.get_instance_console_connections(compartment_id=compartment_id,
        instance_id=test_instance["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.GetInstanceConsoleConnections(ctx, &core.GetInstanceConsoleConnectionsArgs{
    			CompartmentId: compartmentId,
    			InstanceId:    pulumi.StringRef(testInstance.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 testInstanceConsoleConnections = Oci.Core.GetInstanceConsoleConnections.Invoke(new()
        {
            CompartmentId = compartmentId,
            InstanceId = testInstance.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.CoreFunctions;
    import com.pulumi.oci.Core.inputs.GetInstanceConsoleConnectionsArgs;
    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 testInstanceConsoleConnections = CoreFunctions.getInstanceConsoleConnections(GetInstanceConsoleConnectionsArgs.builder()
                .compartmentId(compartmentId)
                .instanceId(testInstance.id())
                .build());
    
        }
    }
    
    variables:
      testInstanceConsoleConnections:
        fn::invoke:
          Function: oci:Core:getInstanceConsoleConnections
          Arguments:
            compartmentId: ${compartmentId}
            instanceId: ${testInstance.id}
    

    Using getInstanceConsoleConnections

    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 getInstanceConsoleConnections(args: GetInstanceConsoleConnectionsArgs, opts?: InvokeOptions): Promise<GetInstanceConsoleConnectionsResult>
    function getInstanceConsoleConnectionsOutput(args: GetInstanceConsoleConnectionsOutputArgs, opts?: InvokeOptions): Output<GetInstanceConsoleConnectionsResult>
    def get_instance_console_connections(compartment_id: Optional[str] = None,
                                         filters: Optional[Sequence[_core.GetInstanceConsoleConnectionsFilter]] = None,
                                         instance_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetInstanceConsoleConnectionsResult
    def get_instance_console_connections_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetInstanceConsoleConnectionsFilterArgs]]]] = None,
                                         instance_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetInstanceConsoleConnectionsResult]
    func GetInstanceConsoleConnections(ctx *Context, args *GetInstanceConsoleConnectionsArgs, opts ...InvokeOption) (*GetInstanceConsoleConnectionsResult, error)
    func GetInstanceConsoleConnectionsOutput(ctx *Context, args *GetInstanceConsoleConnectionsOutputArgs, opts ...InvokeOption) GetInstanceConsoleConnectionsResultOutput

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

    public static class GetInstanceConsoleConnections 
    {
        public static Task<GetInstanceConsoleConnectionsResult> InvokeAsync(GetInstanceConsoleConnectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetInstanceConsoleConnectionsResult> Invoke(GetInstanceConsoleConnectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstanceConsoleConnectionsResult> getInstanceConsoleConnections(GetInstanceConsoleConnectionsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getInstanceConsoleConnections:getInstanceConsoleConnections
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    Filters List<GetInstanceConsoleConnectionsFilter>
    InstanceId string
    The OCID of the instance.
    CompartmentId string
    The OCID of the compartment.
    Filters []GetInstanceConsoleConnectionsFilter
    InstanceId string
    The OCID of the instance.
    compartmentId String
    The OCID of the compartment.
    filters List<GetInstanceConsoleConnectionsFilter>
    instanceId String
    The OCID of the instance.
    compartmentId string
    The OCID of the compartment.
    filters GetInstanceConsoleConnectionsFilter[]
    instanceId string
    The OCID of the instance.
    compartment_id str
    The OCID of the compartment.
    filters Sequence[core.GetInstanceConsoleConnectionsFilter]
    instance_id str
    The OCID of the instance.
    compartmentId String
    The OCID of the compartment.
    filters List<Property Map>
    instanceId String
    The OCID of the instance.

    getInstanceConsoleConnections Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment to contain the console connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceConsoleConnections List<GetInstanceConsoleConnectionsInstanceConsoleConnection>
    The list of instance_console_connections.
    Filters List<GetInstanceConsoleConnectionsFilter>
    InstanceId string
    The OCID of the instance the console connection connects to.
    CompartmentId string
    The OCID of the compartment to contain the console connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceConsoleConnections []GetInstanceConsoleConnectionsInstanceConsoleConnection
    The list of instance_console_connections.
    Filters []GetInstanceConsoleConnectionsFilter
    InstanceId string
    The OCID of the instance the console connection connects to.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceConsoleConnections List<GetInstanceConsoleConnectionsInstanceConsoleConnection>
    The list of instance_console_connections.
    filters List<GetInstanceConsoleConnectionsFilter>
    instanceId String
    The OCID of the instance the console connection connects to.
    compartmentId string
    The OCID of the compartment to contain the console connection.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceConsoleConnections GetInstanceConsoleConnectionsInstanceConsoleConnection[]
    The list of instance_console_connections.
    filters GetInstanceConsoleConnectionsFilter[]
    instanceId string
    The OCID of the instance the console connection connects to.
    compartment_id str
    The OCID of the compartment to contain the console connection.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_console_connections Sequence[core.GetInstanceConsoleConnectionsInstanceConsoleConnection]
    The list of instance_console_connections.
    filters Sequence[core.GetInstanceConsoleConnectionsFilter]
    instance_id str
    The OCID of the instance the console connection connects to.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceConsoleConnections List<Property Map>
    The list of instance_console_connections.
    filters List<Property Map>
    instanceId String
    The OCID of the instance the console connection connects to.

    Supporting Types

    GetInstanceConsoleConnectionsFilter

    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

    GetInstanceConsoleConnectionsInstanceConsoleConnection

    CompartmentId string
    The OCID of the compartment.
    ConnectionString string
    The SSH connection string for the console connection.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Fingerprint string
    The SSH public key's fingerprint for client authentication to the console connection.
    FreeformTags Dictionary<string, object>
    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"}
    Id string
    The OCID of the console connection.
    InstanceId string
    The OCID of the instance.
    PublicKey string
    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    VncConnectionString string
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
    CompartmentId string
    The OCID of the compartment.
    ConnectionString string
    The SSH connection string for the console connection.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Fingerprint string
    The SSH public key's fingerprint for client authentication to the console connection.
    FreeformTags map[string]interface{}
    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"}
    Id string
    The OCID of the console connection.
    InstanceId string
    The OCID of the instance.
    PublicKey string
    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    VncConnectionString string
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
    compartmentId String
    The OCID of the compartment.
    connectionString String
    The SSH connection string for the console connection.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    fingerprint String
    The SSH public key's fingerprint for client authentication to the console connection.
    freeformTags Map<String,Object>
    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"}
    id String
    The OCID of the console connection.
    instanceId String
    The OCID of the instance.
    publicKey String
    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    state String
    The current state of the console connection.
    vncConnectionString String
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
    compartmentId string
    The OCID of the compartment.
    connectionString string
    The SSH connection string for the console connection.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    fingerprint string
    The SSH public key's fingerprint for client authentication to the console connection.
    freeformTags {[key: string]: any}
    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"}
    id string
    The OCID of the console connection.
    instanceId string
    The OCID of the instance.
    publicKey string
    serviceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    state string
    The current state of the console connection.
    vncConnectionString string
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
    compartment_id str
    The OCID of the compartment.
    connection_string str
    The SSH connection string for the console connection.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    fingerprint str
    The SSH public key's fingerprint for client authentication to the console connection.
    freeform_tags Mapping[str, Any]
    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"}
    id str
    The OCID of the console connection.
    instance_id str
    The OCID of the instance.
    public_key str
    service_host_key_fingerprint str
    The SSH public key's fingerprint for the console connection service host.
    state str
    The current state of the console connection.
    vnc_connection_string str
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
    compartmentId String
    The OCID of the compartment.
    connectionString String
    The SSH connection string for the console connection.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    fingerprint String
    The SSH public key's fingerprint for client authentication to the console connection.
    freeformTags Map<Any>
    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"}
    id String
    The OCID of the console connection.
    instanceId String
    The OCID of the instance.
    publicKey String
    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    state String
    The current state of the console connection.
    vncConnectionString String
    The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi