Oracle Cloud Infrastructure v2.30.0, Apr 14 25

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

oci.Core.getInstance

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 testInstance = oci.Core.getInstance({
    instanceId: testInstanceOciCoreInstance.id,
});

import pulumi
import pulumi_oci as oci

test_instance = oci.Core.get_instance(instance_id=test_instance_oci_core_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.GetInstance(ctx, &core.GetInstanceArgs{
			InstanceId: testInstanceOciCoreInstance.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 testInstance = Oci.Core.GetInstance.Invoke(new()
    {
        InstanceId = testInstanceOciCoreInstance.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.GetInstanceArgs;
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 testInstance = CoreFunctions.getInstance(GetInstanceArgs.builder()
            .instanceId(testInstanceOciCoreInstance.id())
            .build());

    }
}

variables:
  testInstance:
    fn::invoke:
      function: oci:Core:getInstance
      arguments:
        instanceId: ${testInstanceOciCoreInstance.id}

Using getInstance

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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(instance_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func GetInstance(ctx *Context, args *GetInstanceArgs, opts ...InvokeOption) (*GetInstanceResult, error)
func GetInstanceOutput(ctx *Context, args *GetInstanceOutputArgs, opts ...InvokeOption) GetInstanceResultOutput

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

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getInstance:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The OCID of the instance.

InstanceId string: The OCID of the instance.

instanceId String: The OCID of the instance.

instanceId string: The OCID of the instance.

instance_id str: The OCID of the instance.

instanceId String: The OCID of the instance.

getInstance Result

The following output properties are available:

AgentConfigs List<GetInstanceAgentConfig>

Configuration options for the Oracle Cloud Agent software running on the instance.

Async bool

AvailabilityConfigs List<GetInstanceAvailabilityConfig>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

AvailabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

BootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

CapacityReservationId string

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

ClusterPlacementGroupId string

The OCID of the cluster placement group of the instance.

CompartmentId string

The OCID of the compartment containing images to search

ComputeClusterId string

CreateVnicDetails List<GetInstanceCreateVnicDetail>

DedicatedVmHostId string

The OCID of the dedicated virtual machine host that the instance is placed on.

DefinedTags 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"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExtendedMetadata Dictionary<string, string>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

FaultDomain string

The name of the fault domain the instance is running in.

FreeformTags 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"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

Id string

The OCID of the instance.

Image string

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

InstanceConfigurationId string

The OCID of the Instance Configuration used to source launch details for this instance. Any other fields supplied in the instance launch request override the details stored in the Instance Configuration for this instance launch.

InstanceId string

InstanceOptions List<GetInstanceInstanceOption>

Optional mutable instance options

IpxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

IsCrossNumaNode bool

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

LaunchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

LaunchOptions List<GetInstanceLaunchOption>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

LaunchVolumeAttachments List<GetInstanceLaunchVolumeAttachment>

LicensingConfigs List<GetInstanceLicensingConfig>

List of licensing configurations associated with the instance.

Metadata Dictionary<string, string>

Custom metadata that you provide.

PlatformConfigs List<GetInstancePlatformConfig>

The platform configuration for the instance.

PreemptibleInstanceConfigs List<GetInstancePreemptibleInstanceConfig>

(Optional) Configuration options for preemptible instances.

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

PreserveDataVolumesCreatedAtLaunch bool

PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

PublicIp string

The public IP address of instance VNIC (if enabled).

Region string

The region that contains the availability domain the instance is running in.

SecurityAttributes Dictionary<string, string>

Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}

SecurityAttributesState string

The lifecycle state of the securityAttributes

Shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

ShapeConfigs List<GetInstanceShapeConfig>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

SourceDetails List<GetInstanceSourceDetail>

State string

The current state of the instance.

SubnetId string

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

SystemTags Dictionary<string, string>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeMaintenanceRebootDue string

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

UpdateOperationConstraint string

AgentConfigs []GetInstanceAgentConfig

Configuration options for the Oracle Cloud Agent software running on the instance.

Async bool

AvailabilityConfigs []GetInstanceAvailabilityConfig

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

AvailabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

BootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

CapacityReservationId string

ClusterPlacementGroupId string

The OCID of the cluster placement group of the instance.

CompartmentId string

The OCID of the compartment containing images to search

ComputeClusterId string

CreateVnicDetails []GetInstanceCreateVnicDetail

DedicatedVmHostId string

The OCID of the dedicated virtual machine host that the instance is placed on.

DefinedTags 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"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExtendedMetadata map[string]string

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

FaultDomain string

The name of the fault domain the instance is running in.

FreeformTags 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"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

Id string

The OCID of the instance.

Image string

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

InstanceConfigurationId string

InstanceId string

InstanceOptions []GetInstanceInstanceOption

Optional mutable instance options

IpxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

IsCrossNumaNode bool

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

LaunchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

LaunchOptions []GetInstanceLaunchOption

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

LaunchVolumeAttachments []GetInstanceLaunchVolumeAttachment

LicensingConfigs []GetInstanceLicensingConfig

List of licensing configurations associated with the instance.

Metadata map[string]string

Custom metadata that you provide.

PlatformConfigs []GetInstancePlatformConfig

The platform configuration for the instance.

PreemptibleInstanceConfigs []GetInstancePreemptibleInstanceConfig

(Optional) Configuration options for preemptible instances.

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

PreserveDataVolumesCreatedAtLaunch bool

PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

PublicIp string

The public IP address of instance VNIC (if enabled).

Region string

The region that contains the availability domain the instance is running in.

SecurityAttributes map[string]string

SecurityAttributesState string

The lifecycle state of the securityAttributes

Shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

ShapeConfigs []GetInstanceShapeConfig

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

SourceDetails []GetInstanceSourceDetail

State string

The current state of the instance.

SubnetId string

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

SystemTags map[string]string

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeMaintenanceRebootDue string

UpdateOperationConstraint string

agentConfigs List<GetInstanceAgentConfig>

Configuration options for the Oracle Cloud Agent software running on the instance.

async Boolean

availabilityConfigs List<GetInstanceAvailabilityConfig>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain String

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId String

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId String

clusterPlacementGroupId String

The OCID of the cluster placement group of the instance.

compartmentId String

The OCID of the compartment containing images to search

computeClusterId String

createVnicDetails List<GetInstanceCreateVnicDetail>

dedicatedVmHostId String

The OCID of the dedicated virtual machine host that the instance is placed on.

definedTags 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"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata Map<String,String>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain String

The name of the fault domain the instance is running in.

freeformTags 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"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id String

The OCID of the instance.

image String

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceConfigurationId String

instanceId String

instanceOptions List<GetInstanceInstanceOption>

Optional mutable instance options

ipxeScript String

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isCrossNumaNode Boolean

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode String

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

launchOptions List<GetInstanceLaunchOption>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

launchVolumeAttachments List<GetInstanceLaunchVolumeAttachment>

licensingConfigs List<GetInstanceLicensingConfig>

List of licensing configurations associated with the instance.

metadata Map<String,String>

Custom metadata that you provide.

platformConfigs List<GetInstancePlatformConfig>

The platform configuration for the instance.

preemptibleInstanceConfigs List<GetInstancePreemptibleInstanceConfig>

(Optional) Configuration options for preemptible instances.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

preserveDataVolumesCreatedAtLaunch Boolean

privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp String

The public IP address of instance VNIC (if enabled).

region String

The region that contains the availability domain the instance is running in.

securityAttributes Map<String,String>

securityAttributesState String

The lifecycle state of the securityAttributes

shape String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs List<GetInstanceShapeConfig>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails List<GetInstanceSourceDetail>

state String

The current state of the instance.

subnetId String

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags Map<String,String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue String

updateOperationConstraint String

agentConfigs GetInstanceAgentConfig[]

Configuration options for the Oracle Cloud Agent software running on the instance.

async boolean

availabilityConfigs GetInstanceAvailabilityConfig[]

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId string

clusterPlacementGroupId string

The OCID of the cluster placement group of the instance.

compartmentId string

The OCID of the compartment containing images to search

computeClusterId string

createVnicDetails GetInstanceCreateVnicDetail[]

dedicatedVmHostId string

The OCID of the dedicated virtual machine host that the instance is placed on.

definedTags {[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"}

displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata {[key: string]: string}

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain string

The name of the fault domain the instance is running in.

freeformTags {[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"}

hostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id string

The OCID of the instance.

image string

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceConfigurationId string

instanceId string

instanceOptions GetInstanceInstanceOption[]

Optional mutable instance options

ipxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isCrossNumaNode boolean

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

isPvEncryptionInTransitEnabled boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

launchOptions GetInstanceLaunchOption[]

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

launchVolumeAttachments GetInstanceLaunchVolumeAttachment[]

licensingConfigs GetInstanceLicensingConfig[]

List of licensing configurations associated with the instance.

metadata {[key: string]: string}

Custom metadata that you provide.

platformConfigs GetInstancePlatformConfig[]

The platform configuration for the instance.

preemptibleInstanceConfigs GetInstancePreemptibleInstanceConfig[]

(Optional) Configuration options for preemptible instances.

preserveBootVolume boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

preserveDataVolumesCreatedAtLaunch boolean

privateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp string

The public IP address of instance VNIC (if enabled).

region string

The region that contains the availability domain the instance is running in.

securityAttributes {[key: string]: string}

securityAttributesState string

The lifecycle state of the securityAttributes

shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs GetInstanceShapeConfig[]

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails GetInstanceSourceDetail[]

state string

The current state of the instance.

subnetId string

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags {[key: string]: string}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue string

updateOperationConstraint string

agent_configs Sequence[core.GetInstanceAgentConfig]

Configuration options for the Oracle Cloud Agent software running on the instance.

async_ bool

availability_configs Sequence[core.GetInstanceAvailabilityConfig]

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availability_domain str

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

boot_volume_id str

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacity_reservation_id str

cluster_placement_group_id str

The OCID of the cluster placement group of the instance.

compartment_id str

The OCID of the compartment containing images to search

compute_cluster_id str

create_vnic_details Sequence[core.GetInstanceCreateVnicDetail]

dedicated_vm_host_id str

The OCID of the dedicated virtual machine host that the instance is placed on.

defined_tags 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

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extended_metadata Mapping[str, str]

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

fault_domain str

The name of the fault domain the instance is running in.

freeform_tags 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"}

hostname_label str

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id str

The OCID of the instance.

image str

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instance_configuration_id str

instance_id str

instance_options Sequence[core.GetInstanceInstanceOption]

Optional mutable instance options

ipxe_script str

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

is_cross_numa_node bool

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

is_pv_encryption_in_transit_enabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launch_mode str

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

launch_options Sequence[core.GetInstanceLaunchOption]

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

launch_volume_attachments Sequence[core.GetInstanceLaunchVolumeAttachment]

licensing_configs Sequence[core.GetInstanceLicensingConfig]

List of licensing configurations associated with the instance.

metadata Mapping[str, str]

Custom metadata that you provide.

platform_configs Sequence[core.GetInstancePlatformConfig]

The platform configuration for the instance.

preemptible_instance_configs Sequence[core.GetInstancePreemptibleInstanceConfig]

(Optional) Configuration options for preemptible instances.

preserve_boot_volume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

preserve_data_volumes_created_at_launch bool

private_ip str

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

public_ip str

The public IP address of instance VNIC (if enabled).

region str

The region that contains the availability domain the instance is running in.

security_attributes Mapping[str, str]

security_attributes_state str

The lifecycle state of the securityAttributes

shape str

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shape_configs Sequence[core.GetInstanceShapeConfig]

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

source_details Sequence[core.GetInstanceSourceDetail]

state str

The current state of the instance.

subnet_id str

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

system_tags Mapping[str, str]

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

time_created str

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

time_maintenance_reboot_due str

update_operation_constraint str

agentConfigs List<Property Map>

Configuration options for the Oracle Cloud Agent software running on the instance.

async Boolean

availabilityConfigs List<Property Map>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain String

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId String

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId String

clusterPlacementGroupId String

The OCID of the cluster placement group of the instance.

compartmentId String

The OCID of the compartment containing images to search

computeClusterId String

createVnicDetails List<Property Map>

dedicatedVmHostId String

The OCID of the dedicated virtual machine host that the instance is placed on.

definedTags 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"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata Map<String>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain String

The name of the fault domain the instance is running in.

freeformTags 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"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

Deprecated: The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id String

The OCID of the instance.

image String

Deprecated. Use sourceDetails instead.

Deprecated: The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceConfigurationId String

instanceId String

instanceOptions List<Property Map>

Optional mutable instance options

ipxeScript String

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isCrossNumaNode Boolean

Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode String

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

launchOptions List<Property Map>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

launchVolumeAttachments List<Property Map>

licensingConfigs List<Property Map>

List of licensing configurations associated with the instance.

metadata Map<String>

Custom metadata that you provide.

platformConfigs List<Property Map>

The platform configuration for the instance.

preemptibleInstanceConfigs List<Property Map>

(Optional) Configuration options for preemptible instances.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

preserveDataVolumesCreatedAtLaunch Boolean

privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp String

The public IP address of instance VNIC (if enabled).

region String

The region that contains the availability domain the instance is running in.

securityAttributes Map<String>

securityAttributesState String

The lifecycle state of the securityAttributes

shape String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs List<Property Map>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails List<Property Map>

state String

The current state of the instance.

subnetId String

Deprecated: The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags Map<String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue String

updateOperationConstraint String

Supporting Types

GetInstanceAgentConfig

AreAllPluginsDisabled bool: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
IsManagementDisabled bool: Whether Oracle Cloud Agent can run all the available management plugins.
IsMonitoringDisabled bool: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
PluginsConfigs List<GetInstanceAgentConfigPluginsConfig>: The configuration of plugins associated with this instance.

AreAllPluginsDisabled bool: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
IsManagementDisabled bool: Whether Oracle Cloud Agent can run all the available management plugins.
IsMonitoringDisabled bool: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
PluginsConfigs []GetInstanceAgentConfigPluginsConfig: The configuration of plugins associated with this instance.

areAllPluginsDisabled Boolean: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
isManagementDisabled Boolean: Whether Oracle Cloud Agent can run all the available management plugins.
isMonitoringDisabled Boolean: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
pluginsConfigs List<GetInstanceAgentConfigPluginsConfig>: The configuration of plugins associated with this instance.

areAllPluginsDisabled boolean: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
isManagementDisabled boolean: Whether Oracle Cloud Agent can run all the available management plugins.
isMonitoringDisabled boolean: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
pluginsConfigs GetInstanceAgentConfigPluginsConfig[]: The configuration of plugins associated with this instance.

are_all_plugins_disabled bool: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
is_management_disabled bool: Whether Oracle Cloud Agent can run all the available management plugins.
is_monitoring_disabled bool: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
plugins_configs Sequence[core.GetInstanceAgentConfigPluginsConfig]: The configuration of plugins associated with this instance.

areAllPluginsDisabled Boolean: Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
isManagementDisabled Boolean: Whether Oracle Cloud Agent can run all the available management plugins.
isMonitoringDisabled Boolean: Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
pluginsConfigs List<Property Map>: The configuration of plugins associated with this instance.

GetInstanceAgentConfigPluginsConfig

DesiredState string: Whether the plugin should be enabled or disabled.
Name string: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

DesiredState string: Whether the plugin should be enabled or disabled.
Name string: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState String: Whether the plugin should be enabled or disabled.
name String: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState string: Whether the plugin should be enabled or disabled.
name string: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desired_state str: Whether the plugin should be enabled or disabled.
name str: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState String: Whether the plugin should be enabled or disabled.
name String: The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

GetInstanceAvailabilityConfig

IsLiveMigrationPreferred bool

Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.

RecoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

IsLiveMigrationPreferred bool

RecoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

isLiveMigrationPreferred Boolean

recoveryAction String

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

isLiveMigrationPreferred boolean

recoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

is_live_migration_preferred bool

recovery_action str

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

isLiveMigrationPreferred Boolean

recoveryAction String

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
STOP_INSTANCE - The instance is recovered in the stopped state.

GetInstanceCreateVnicDetail

AssignIpv6ip bool
AssignPrivateDnsRecord bool
AssignPublicIp string
DefinedTags 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"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
HostnameLabel string: The hostname for the instance VNIC's primary private IP.
Ipv6addressIpv6subnetCidrPairDetails List<GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail>
NsgIds List<string>
PrivateIp string: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
SecurityAttributes Dictionary<string, string>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
SkipSourceDestCheck bool
SubnetId string
VlanId string

AssignIpv6ip bool
AssignPrivateDnsRecord bool
AssignPublicIp string
DefinedTags 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"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
HostnameLabel string: The hostname for the instance VNIC's primary private IP.
Ipv6addressIpv6subnetCidrPairDetails []GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail
NsgIds []string
PrivateIp string: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
SecurityAttributes map[string]string: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
SkipSourceDestCheck bool
SubnetId string
VlanId string

assignIpv6ip Boolean
assignPrivateDnsRecord Boolean
assignPublicIp String
definedTags 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"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
hostnameLabel String: The hostname for the instance VNIC's primary private IP.
ipv6addressIpv6subnetCidrPairDetails List<GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail>
nsgIds List<String>
privateIp String: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
securityAttributes Map<String,String>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
skipSourceDestCheck Boolean
subnetId String
vlanId String

assignIpv6ip boolean
assignPrivateDnsRecord boolean
assignPublicIp string
definedTags {[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"}
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[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"}
hostnameLabel string: The hostname for the instance VNIC's primary private IP.
ipv6addressIpv6subnetCidrPairDetails GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]
nsgIds string[]
privateIp string: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
securityAttributes {[key: string]: string}: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
skipSourceDestCheck boolean
subnetId string
vlanId string

assign_ipv6ip bool
assign_private_dns_record bool
assign_public_ip str
defined_tags 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeform_tags 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"}
hostname_label str: The hostname for the instance VNIC's primary private IP.
ipv6address_ipv6subnet_cidr_pair_details Sequence[core.GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail]
nsg_ids Sequence[str]
private_ip str: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
security_attributes Mapping[str, str]: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
skip_source_dest_check bool
subnet_id str
vlan_id str

assignIpv6ip Boolean
assignPrivateDnsRecord Boolean
assignPublicIp String
definedTags 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"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
hostnameLabel String: The hostname for the instance VNIC's primary private IP.
ipv6addressIpv6subnetCidrPairDetails List<Property Map>
nsgIds List<String>
privateIp String: The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.
securityAttributes Map<String>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
skipSourceDestCheck Boolean
subnetId String
vlanId String

GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail

Ipv6address string
Ipv6subnetCidr string

Ipv6address string
Ipv6subnetCidr string

ipv6address String
ipv6subnetCidr String

ipv6address string
ipv6subnetCidr string

ipv6address str
ipv6subnet_cidr str

ipv6address String
ipv6subnetCidr String

GetInstanceInstanceOption

AreLegacyImdsEndpointsDisabled bool: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

AreLegacyImdsEndpointsDisabled bool: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled Boolean: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled boolean: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

are_legacy_imds_endpoints_disabled bool: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled Boolean: Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

GetInstanceLaunchOption

BootVolumeType string

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

Firmware string

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

IsConsistentVolumeNamingEnabled bool

Whether to enable consistent volume naming feature. Defaults to false.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

NetworkType string

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

RemoteDataVolumeType string

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

BootVolumeType string

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

Firmware string

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

IsConsistentVolumeNamingEnabled bool

Whether to enable consistent volume naming feature. Defaults to false.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

NetworkType string

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

RemoteDataVolumeType string

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

bootVolumeType String

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

firmware String

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

isConsistentVolumeNamingEnabled Boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType String

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

remoteDataVolumeType String

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

bootVolumeType string

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

firmware string

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

isConsistentVolumeNamingEnabled boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType string

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

remoteDataVolumeType string

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

boot_volume_type str

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

firmware str

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

is_consistent_volume_naming_enabled bool

Whether to enable consistent volume naming feature. Defaults to false.

is_pv_encryption_in_transit_enabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

network_type str

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

remote_data_volume_type str

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

bootVolumeType String

Emulation type for the boot volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

firmware String

Firmware used to boot VM. Select the option that matches your operating system.

BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.

isConsistentVolumeNamingEnabled Boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType String

Emulation type for the physical network interface card (NIC).

E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.

remoteDataVolumeType String

Emulation type for volume.

ISCSI - ISCSI attached block storage device.
SCSI - Emulated SCSI disk.
IDE - Emulated IDE disk.
VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

GetInstanceLaunchVolumeAttachment

Device string
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncryptionInTransitType string
IsAgentAutoIscsiLoginEnabled bool
IsPvEncryptionInTransitEnabled bool: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
IsReadOnly bool
IsShareable bool
LaunchCreateVolumeDetails List<GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail>
Type string: (Required) The type of action to run when the instance is interrupted for eviction.
UseChap bool
VolumeId string

Device string
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncryptionInTransitType string
IsAgentAutoIscsiLoginEnabled bool
IsPvEncryptionInTransitEnabled bool: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
IsReadOnly bool
IsShareable bool
LaunchCreateVolumeDetails []GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail
Type string: (Required) The type of action to run when the instance is interrupted for eviction.
UseChap bool
VolumeId string

device String
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryptionInTransitType String
isAgentAutoIscsiLoginEnabled Boolean
isPvEncryptionInTransitEnabled Boolean: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
isReadOnly Boolean
isShareable Boolean
launchCreateVolumeDetails List<GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail>
type String: (Required) The type of action to run when the instance is interrupted for eviction.
useChap Boolean
volumeId String

device string
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryptionInTransitType string
isAgentAutoIscsiLoginEnabled boolean
isPvEncryptionInTransitEnabled boolean: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
isReadOnly boolean
isShareable boolean
launchCreateVolumeDetails GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail[]
type string: (Required) The type of action to run when the instance is interrupted for eviction.
useChap boolean
volumeId string

device str
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryption_in_transit_type str
is_agent_auto_iscsi_login_enabled bool
is_pv_encryption_in_transit_enabled bool: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
is_read_only bool
is_shareable bool
launch_create_volume_details Sequence[core.GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail]
type str: (Required) The type of action to run when the instance is interrupted for eviction.
use_chap bool
volume_id str

device String
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryptionInTransitType String
isAgentAutoIscsiLoginEnabled Boolean
isPvEncryptionInTransitEnabled Boolean: Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
isReadOnly Boolean
isShareable Boolean
launchCreateVolumeDetails List<Property Map>
type String: (Required) The type of action to run when the instance is interrupted for eviction.
useChap Boolean
volumeId String

GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail

CompartmentId string: The OCID of the compartment containing images to search
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
SizeInGbs string
VolumeCreationType string
VpusPerGb string

CompartmentId string: The OCID of the compartment containing images to search
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
SizeInGbs string
VolumeCreationType string
VpusPerGb string

compartmentId String: The OCID of the compartment containing images to search
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sizeInGbs String
volumeCreationType String
vpusPerGb String

compartmentId string: The OCID of the compartment containing images to search
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sizeInGbs string
volumeCreationType string
vpusPerGb string

compartment_id str: The OCID of the compartment containing images to search
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kms_key_id str: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
size_in_gbs str
volume_creation_type str
vpus_per_gb str

compartmentId String: The OCID of the compartment containing images to search
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sizeInGbs String
volumeCreationType String
vpusPerGb String

GetInstanceLicensingConfig

LicenseType string

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

OsVersion string

The Operating System version of the license config.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

LicenseType string

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

OsVersion string

The Operating System version of the license config.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

licenseType String

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

osVersion String

The Operating System version of the license config.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

licenseType string

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

osVersion string

The Operating System version of the license config.

type string

(Required) The type of action to run when the instance is interrupted for eviction.

license_type str

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

os_version str

The Operating System version of the license config.

type str

(Required) The type of action to run when the instance is interrupted for eviction.

licenseType String

License Type for the OS license.

OCI_PROVIDED - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).
BRING_YOUR_OWN_LICENSE - Bring your own license.

osVersion String

The Operating System version of the license config.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

GetInstancePlatformConfig

AreVirtualInstructionsEnabled bool: Whether virtualization instructions are available.
ConfigMap Dictionary<string, string>: Instance Platform Configuration Configuration Map for flexible setting input.
IsAccessControlServiceEnabled bool: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
IsInputOutputMemoryManagementUnitEnabled bool: Whether the input-output memory management unit is enabled.
IsMeasuredBootEnabled bool: Whether the Measured Boot is to be enabled on the instance
IsMemoryEncryptionEnabled bool: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
IsSecureBootEnabled bool: Whether the Secure Boot is to be enabled on the instance.
IsSymmetricMultiThreadingEnabled bool: Whether symmetric multi-threading is enabled on the instance.
IsTrustedPlatformModuleEnabled bool: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
NumaNodesPerSocket string: The number of NUMA nodes per socket (NPS).
PercentageOfCoresEnabled int: The percentage of cores enabled.
Type string: (Required) The type of action to run when the instance is interrupted for eviction.

AreVirtualInstructionsEnabled bool: Whether virtualization instructions are available.
ConfigMap map[string]string: Instance Platform Configuration Configuration Map for flexible setting input.
IsAccessControlServiceEnabled bool: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
IsInputOutputMemoryManagementUnitEnabled bool: Whether the input-output memory management unit is enabled.
IsMeasuredBootEnabled bool: Whether the Measured Boot is to be enabled on the instance
IsMemoryEncryptionEnabled bool: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
IsSecureBootEnabled bool: Whether the Secure Boot is to be enabled on the instance.
IsSymmetricMultiThreadingEnabled bool: Whether symmetric multi-threading is enabled on the instance.
IsTrustedPlatformModuleEnabled bool: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
NumaNodesPerSocket string: The number of NUMA nodes per socket (NPS).
PercentageOfCoresEnabled int: The percentage of cores enabled.
Type string: (Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled Boolean: Whether virtualization instructions are available.
configMap Map<String,String>: Instance Platform Configuration Configuration Map for flexible setting input.
isAccessControlServiceEnabled Boolean: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
isInputOutputMemoryManagementUnitEnabled Boolean: Whether the input-output memory management unit is enabled.
isMeasuredBootEnabled Boolean: Whether the Measured Boot is to be enabled on the instance
isMemoryEncryptionEnabled Boolean: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
isSecureBootEnabled Boolean: Whether the Secure Boot is to be enabled on the instance.
isSymmetricMultiThreadingEnabled Boolean: Whether symmetric multi-threading is enabled on the instance.
isTrustedPlatformModuleEnabled Boolean: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
numaNodesPerSocket String: The number of NUMA nodes per socket (NPS).
percentageOfCoresEnabled Integer: The percentage of cores enabled.
type String: (Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled boolean: Whether virtualization instructions are available.
configMap {[key: string]: string}: Instance Platform Configuration Configuration Map for flexible setting input.
isAccessControlServiceEnabled boolean: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
isInputOutputMemoryManagementUnitEnabled boolean: Whether the input-output memory management unit is enabled.
isMeasuredBootEnabled boolean: Whether the Measured Boot is to be enabled on the instance
isMemoryEncryptionEnabled boolean: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
isSecureBootEnabled boolean: Whether the Secure Boot is to be enabled on the instance.
isSymmetricMultiThreadingEnabled boolean: Whether symmetric multi-threading is enabled on the instance.
isTrustedPlatformModuleEnabled boolean: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
numaNodesPerSocket string: The number of NUMA nodes per socket (NPS).
percentageOfCoresEnabled number: The percentage of cores enabled.
type string: (Required) The type of action to run when the instance is interrupted for eviction.

are_virtual_instructions_enabled bool: Whether virtualization instructions are available.
config_map Mapping[str, str]: Instance Platform Configuration Configuration Map for flexible setting input.
is_access_control_service_enabled bool: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
is_input_output_memory_management_unit_enabled bool: Whether the input-output memory management unit is enabled.
is_measured_boot_enabled bool: Whether the Measured Boot is to be enabled on the instance
is_memory_encryption_enabled bool: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
is_secure_boot_enabled bool: Whether the Secure Boot is to be enabled on the instance.
is_symmetric_multi_threading_enabled bool: Whether symmetric multi-threading is enabled on the instance.
is_trusted_platform_module_enabled bool: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
numa_nodes_per_socket str: The number of NUMA nodes per socket (NPS).
percentage_of_cores_enabled int: The percentage of cores enabled.
type str: (Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled Boolean: Whether virtualization instructions are available.
configMap Map<String>: Instance Platform Configuration Configuration Map for flexible setting input.
isAccessControlServiceEnabled Boolean: Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.
isInputOutputMemoryManagementUnitEnabled Boolean: Whether the input-output memory management unit is enabled.
isMeasuredBootEnabled Boolean: Whether the Measured Boot is to be enabled on the instance
isMemoryEncryptionEnabled Boolean: Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
isSecureBootEnabled Boolean: Whether the Secure Boot is to be enabled on the instance.
isSymmetricMultiThreadingEnabled Boolean: Whether symmetric multi-threading is enabled on the instance.
isTrustedPlatformModuleEnabled Boolean: Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
numaNodesPerSocket String: The number of NUMA nodes per socket (NPS).
percentageOfCoresEnabled Number: The percentage of cores enabled.
type String: (Required) The type of action to run when the instance is interrupted for eviction.

GetInstancePreemptibleInstanceConfig

PreemptionActions List<GetInstancePreemptibleInstanceConfigPreemptionAction>: (Required) The action to run when the preemptible instance is interrupted for eviction.

PreemptionActions []GetInstancePreemptibleInstanceConfigPreemptionAction: (Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions List<GetInstancePreemptibleInstanceConfigPreemptionAction>: (Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions GetInstancePreemptibleInstanceConfigPreemptionAction[]: (Required) The action to run when the preemptible instance is interrupted for eviction.

preemption_actions Sequence[core.GetInstancePreemptibleInstanceConfigPreemptionAction]: (Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions List<Property Map>: (Required) The action to run when the preemptible instance is interrupted for eviction.

GetInstancePreemptibleInstanceConfigPreemptionAction

PreserveBootVolume bool: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
Type string: (Required) The type of action to run when the instance is interrupted for eviction.

PreserveBootVolume bool: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
Type string: (Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume Boolean: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
type String: (Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume boolean: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
type string: (Required) The type of action to run when the instance is interrupted for eviction.

preserve_boot_volume bool: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
type str: (Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume Boolean: (Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
type String: (Required) The type of action to run when the instance is interrupted for eviction.

GetInstanceShapeConfig

BaselineOcpuUtilization string: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
GpuDescription string: A short description of the instance's graphics processing unit (GPU).
Gpus int: The number of GPUs available to the instance.
LocalDiskDescription string: A short description of the local disks available to this instance.
LocalDisks int: The number of local disks available to the instance.
LocalDisksTotalSizeInGbs double: The aggregate size of all local disks, in gigabytes.
MaxVnicAttachments int: The maximum number of VNIC attachments for the instance.
MemoryInGbs double: The total amount of memory available to the instance, in gigabytes.
NetworkingBandwidthInGbps double: The networking bandwidth available to the instance, in gigabits per second.
Nvmes int
Ocpus double: The total number of OCPUs available to the instance.
ProcessorDescription string: A short description of the instance's processor (CPU).
Vcpus int: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

BaselineOcpuUtilization string: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
GpuDescription string: A short description of the instance's graphics processing unit (GPU).
Gpus int: The number of GPUs available to the instance.
LocalDiskDescription string: A short description of the local disks available to this instance.
LocalDisks int: The number of local disks available to the instance.
LocalDisksTotalSizeInGbs float64: The aggregate size of all local disks, in gigabytes.
MaxVnicAttachments int: The maximum number of VNIC attachments for the instance.
MemoryInGbs float64: The total amount of memory available to the instance, in gigabytes.
NetworkingBandwidthInGbps float64: The networking bandwidth available to the instance, in gigabits per second.
Nvmes int
Ocpus float64: The total number of OCPUs available to the instance.
ProcessorDescription string: A short description of the instance's processor (CPU).
Vcpus int: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

baselineOcpuUtilization String: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
gpuDescription String: A short description of the instance's graphics processing unit (GPU).
gpus Integer: The number of GPUs available to the instance.
localDiskDescription String: A short description of the local disks available to this instance.
localDisks Integer: The number of local disks available to the instance.
localDisksTotalSizeInGbs Double: The aggregate size of all local disks, in gigabytes.
maxVnicAttachments Integer: The maximum number of VNIC attachments for the instance.
memoryInGbs Double: The total amount of memory available to the instance, in gigabytes.
networkingBandwidthInGbps Double: The networking bandwidth available to the instance, in gigabits per second.
nvmes Integer
ocpus Double: The total number of OCPUs available to the instance.
processorDescription String: A short description of the instance's processor (CPU).
vcpus Integer: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

baselineOcpuUtilization string: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
gpuDescription string: A short description of the instance's graphics processing unit (GPU).
gpus number: The number of GPUs available to the instance.
localDiskDescription string: A short description of the local disks available to this instance.
localDisks number: The number of local disks available to the instance.
localDisksTotalSizeInGbs number: The aggregate size of all local disks, in gigabytes.
maxVnicAttachments number: The maximum number of VNIC attachments for the instance.
memoryInGbs number: The total amount of memory available to the instance, in gigabytes.
networkingBandwidthInGbps number: The networking bandwidth available to the instance, in gigabits per second.
nvmes number
ocpus number: The total number of OCPUs available to the instance.
processorDescription string: A short description of the instance's processor (CPU).
vcpus number: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

baseline_ocpu_utilization str: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
gpu_description str: A short description of the instance's graphics processing unit (GPU).
gpus int: The number of GPUs available to the instance.
local_disk_description str: A short description of the local disks available to this instance.
local_disks int: The number of local disks available to the instance.
local_disks_total_size_in_gbs float: The aggregate size of all local disks, in gigabytes.
max_vnic_attachments int: The maximum number of VNIC attachments for the instance.
memory_in_gbs float: The total amount of memory available to the instance, in gigabytes.
networking_bandwidth_in_gbps float: The networking bandwidth available to the instance, in gigabits per second.
nvmes int
ocpus float: The total number of OCPUs available to the instance.
processor_description str: A short description of the instance's processor (CPU).
vcpus int: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

baselineOcpuUtilization String: The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.
gpuDescription String: A short description of the instance's graphics processing unit (GPU).
gpus Number: The number of GPUs available to the instance.
localDiskDescription String: A short description of the local disks available to this instance.
localDisks Number: The number of local disks available to the instance.
localDisksTotalSizeInGbs Number: The aggregate size of all local disks, in gigabytes.
maxVnicAttachments Number: The maximum number of VNIC attachments for the instance.
memoryInGbs Number: The total amount of memory available to the instance, in gigabytes.
networkingBandwidthInGbps Number: The networking bandwidth available to the instance, in gigabits per second.
nvmes Number
ocpus Number: The total number of OCPUs available to the instance.
processorDescription String: A short description of the instance's processor (CPU).
vcpus Number: The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

GetInstanceSourceDetail

BootVolumeSizeInGbs string: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
BootVolumeVpusPerGb string: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
InstanceSourceImageFilterDetails List<GetInstanceSourceDetailInstanceSourceImageFilterDetail>: These are the criteria for selecting an image. This is required if imageId is not specified.
IsPreserveBootVolumeEnabled bool
KmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
SourceId string: The OCID of the boot volume used to boot the instance.
SourceType string: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

BootVolumeSizeInGbs string: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
BootVolumeVpusPerGb string: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
InstanceSourceImageFilterDetails []GetInstanceSourceDetailInstanceSourceImageFilterDetail: These are the criteria for selecting an image. This is required if imageId is not specified.
IsPreserveBootVolumeEnabled bool
KmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
SourceId string: The OCID of the boot volume used to boot the instance.
SourceType string: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs String: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
bootVolumeVpusPerGb String: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
instanceSourceImageFilterDetails List<GetInstanceSourceDetailInstanceSourceImageFilterDetail>: These are the criteria for selecting an image. This is required if imageId is not specified.
isPreserveBootVolumeEnabled Boolean
kmsKeyId String: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sourceId String: The OCID of the boot volume used to boot the instance.
sourceType String: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs string: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
bootVolumeVpusPerGb string: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
instanceSourceImageFilterDetails GetInstanceSourceDetailInstanceSourceImageFilterDetail[]: These are the criteria for selecting an image. This is required if imageId is not specified.
isPreserveBootVolumeEnabled boolean
kmsKeyId string: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sourceId string: The OCID of the boot volume used to boot the instance.
sourceType string: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

boot_volume_size_in_gbs str: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
boot_volume_vpus_per_gb str: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
instance_source_image_filter_details Sequence[core.GetInstanceSourceDetailInstanceSourceImageFilterDetail]: These are the criteria for selecting an image. This is required if imageId is not specified.
is_preserve_boot_volume_enabled bool
kms_key_id str: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
source_id str: The OCID of the boot volume used to boot the instance.
source_type str: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs String: The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
bootVolumeVpusPerGb String: The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
instanceSourceImageFilterDetails List<Property Map>: These are the criteria for selecting an image. This is required if imageId is not specified.
isPreserveBootVolumeEnabled Boolean
kmsKeyId String: The OCID of the Vault service key to assign as the master encryption key for the boot volume.
sourceId String: The OCID of the boot volume used to boot the instance.
sourceType String: The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

GetInstanceSourceDetailInstanceSourceImageFilterDetail

CompartmentId string: The OCID of the compartment containing images to search
DefinedTagsFilter Dictionary<string, string>: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
OperatingSystem string: The image's operating system. Example: Oracle Linux
OperatingSystemVersion string: The image's operating system version. Example: 7.2

CompartmentId string: The OCID of the compartment containing images to search
DefinedTagsFilter map[string]string: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
OperatingSystem string: The image's operating system. Example: Oracle Linux
OperatingSystemVersion string: The image's operating system version. Example: 7.2

compartmentId String: The OCID of the compartment containing images to search
definedTagsFilter Map<String,String>: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
operatingSystem String: The image's operating system. Example: Oracle Linux
operatingSystemVersion String: The image's operating system version. Example: 7.2

compartmentId string: The OCID of the compartment containing images to search
definedTagsFilter {[key: string]: string}: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
operatingSystem string: The image's operating system. Example: Oracle Linux
operatingSystemVersion string: The image's operating system version. Example: 7.2

compartment_id str: The OCID of the compartment containing images to search
defined_tags_filter Mapping[str, str]: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
operating_system str: The image's operating system. Example: Oracle Linux
operating_system_version str: The image's operating system version. Example: 7.2

compartmentId String: The OCID of the compartment containing images to search
definedTagsFilter Map<String>: Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
operatingSystem String: The image's operating system. Example: Oracle Linux
operatingSystemVersion String: The image's operating system version. Example: 7.2

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.Core.getInstance

On this page

On this page

Example Usage

Using getInstance

getInstance Result

Supporting Types

GetInstanceAgentConfig

GetInstanceAgentConfigPluginsConfig

GetInstanceAvailabilityConfig

GetInstanceCreateVnicDetail

GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail

GetInstanceInstanceOption

GetInstanceLaunchOption

GetInstanceLaunchVolumeAttachment

GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail

GetInstanceLicensingConfig

GetInstancePlatformConfig

GetInstancePreemptibleInstanceConfig

GetInstancePreemptibleInstanceConfigPreemptionAction

GetInstanceShapeConfig

GetInstanceSourceDetail

GetInstanceSourceDetailInstanceSourceImageFilterDetail

Package Details

On this page

On this page