oci.Core.getInstance
Explore with Pulumi AI
This data source provides details about a specific Instance resource in Oracle Cloud Infrastructure Core service.
Gets information about the specified instance.
Note: To retrieve public and private IP addresses for an instance, use the ListVnicAttachments operation to get the VNIC ID for the instance, and then call GetVnic with the VNIC ID.
Example Usage
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Core/getInstance:getInstance
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - The OCID of the instance.
- Instance
Id string - The OCID of the instance.
- instance
Id String - The OCID of the instance.
- instance
Id string - The OCID of the instance.
- instance_
id str - The OCID of the instance.
- instance
Id String - The OCID of the instance.
getInstance Result
The following output properties are available:
- Agent
Configs List<GetInstance Agent Config> - Configuration options for the Oracle Cloud Agent software running on the instance.
- Async bool
- Availability
Configs List<GetInstance Availability Config> - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- Availability
Domain string - The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- Boot
Volume stringId - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - Capacity
Reservation stringId - 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.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the instance.
- Compartment
Id string - The OCID of the compartment containing images to search
- Compute
Cluster stringId - Create
Vnic List<GetDetails Instance Create Vnic Detail> - Dedicated
Vm stringHost Id - The OCID of the dedicated virtual machine host that the instance is placed on.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Extended
Metadata Dictionary<string, string> - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the
metadata
object. - Fault
Domain string - The name of the fault domain the instance is running in.
- 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"}
- Hostname
Label string - The hostname for the instance VNIC's primary private IP.
- Id string
- The OCID of the instance.
- Image string
- Deprecated. Use
sourceDetails
instead. - Instance
Configuration stringId - 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.
- Instance
Id string - Instance
Options List<GetInstance Instance Option> - Optional mutable instance options
- Ipxe
Script 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.
- Is
Cross boolNuma Node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Launch
Mode 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 theLaunchOptions
parameter.
- Launch
Options List<GetInstance Launch Option> - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- Launch
Volume List<GetAttachments Instance Launch Volume Attachment> - Metadata Dictionary<string, string>
- Custom metadata that you provide.
- Platform
Configs List<GetInstance Platform Config> - The platform configuration for the instance.
- Preemptible
Instance List<GetConfigs Instance Preemptible Instance Config> - (Optional) Configuration options for preemptible instances.
- Preserve
Boot boolVolume - (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 boolVolumes Created At Launch - Private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - Public
Ip string - The public IP address of instance VNIC (if enabled).
- Region string
- The region that contains the availability domain the instance is running in.
- Security
Attributes 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"}
- Security
Attributes stringState - 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.
- Shape
Configs List<GetInstance Shape Config> - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- Source
Details List<GetInstance Source Detail> - State string
- The current state of the instance.
- Subnet
Id string - Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Time
Maintenance stringReboot Due - 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
- Update
Operation stringConstraint
- Agent
Configs []GetInstance Agent Config - Configuration options for the Oracle Cloud Agent software running on the instance.
- Async bool
- Availability
Configs []GetInstance Availability Config - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- Availability
Domain string - The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- Boot
Volume stringId - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - Capacity
Reservation stringId - 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.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the instance.
- Compartment
Id string - The OCID of the compartment containing images to search
- Compute
Cluster stringId - Create
Vnic []GetDetails Instance Create Vnic Detail - Dedicated
Vm stringHost Id - The OCID of the dedicated virtual machine host that the instance is placed on.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Extended
Metadata map[string]string - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the
metadata
object. - Fault
Domain string - The name of the fault domain the instance is running in.
- 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"}
- Hostname
Label string - The hostname for the instance VNIC's primary private IP.
- Id string
- The OCID of the instance.
- Image string
- Deprecated. Use
sourceDetails
instead. - Instance
Configuration stringId - 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.
- Instance
Id string - Instance
Options []GetInstance Instance Option - Optional mutable instance options
- Ipxe
Script 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.
- Is
Cross boolNuma Node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Launch
Mode 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 theLaunchOptions
parameter.
- Launch
Options []GetInstance Launch Option - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- Launch
Volume []GetAttachments Instance Launch Volume Attachment - Metadata map[string]string
- Custom metadata that you provide.
- Platform
Configs []GetInstance Platform Config - The platform configuration for the instance.
- Preemptible
Instance []GetConfigs Instance Preemptible Instance Config - (Optional) Configuration options for preemptible instances.
- Preserve
Boot boolVolume - (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 boolVolumes Created At Launch - Private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - Public
Ip string - The public IP address of instance VNIC (if enabled).
- Region string
- The region that contains the availability domain the instance is running in.
- Security
Attributes 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"}
- Security
Attributes stringState - 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.
- Shape
Configs []GetInstance Shape Config - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- Source
Details []GetInstance Source Detail - State string
- The current state of the instance.
- Subnet
Id string - map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Time
Maintenance stringReboot Due - 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
- Update
Operation stringConstraint
- agent
Configs List<GetInstance Agent Config> - Configuration options for the Oracle Cloud Agent software running on the instance.
- async Boolean
- availability
Configs List<GetInstance Availability Config> - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- availability
Domain String - The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- boot
Volume StringId - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - capacity
Reservation StringId - 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.
- cluster
Placement StringGroup Id - The OCID of the cluster placement group of the instance.
- compartment
Id String - The OCID of the compartment containing images to search
- compute
Cluster StringId - create
Vnic List<GetDetails Instance Create Vnic Detail> - dedicated
Vm StringHost Id - The OCID of the dedicated virtual machine host that the instance is placed on.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- extended
Metadata Map<String,String> - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the
metadata
object. - fault
Domain String - The name of the fault domain the instance is running in.
- 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"}
- hostname
Label String - The hostname for the instance VNIC's primary private IP.
- id String
- The OCID of the instance.
- image String
- Deprecated. Use
sourceDetails
instead. - instance
Configuration StringId - 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.
- instance
Id String - instance
Options List<GetInstance Instance Option> - Optional mutable instance options
- ipxe
Script 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.
- is
Cross BooleanNuma Node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - launch
Mode 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 theLaunchOptions
parameter.
- launch
Options List<GetInstance Launch Option> - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- launch
Volume List<GetAttachments Instance Launch Volume Attachment> - metadata Map<String,String>
- Custom metadata that you provide.
- platform
Configs List<GetInstance Platform Config> - The platform configuration for the instance.
- preemptible
Instance List<GetConfigs Instance Preemptible Instance Config> - (Optional) Configuration options for preemptible instances.
- preserve
Boot BooleanVolume - (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 BooleanVolumes Created At Launch - private
Ip String - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - public
Ip String - The public IP address of instance VNIC (if enabled).
- region String
- The region that contains the availability domain the instance is running in.
- security
Attributes 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"}
- security
Attributes StringState - 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.
- shape
Configs List<GetInstance Shape Config> - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source
Details List<GetInstance Source Detail> - state String
- The current state of the instance.
- subnet
Id String - Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- time
Maintenance StringReboot Due - 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
- update
Operation StringConstraint
- agent
Configs GetInstance Agent Config[] - Configuration options for the Oracle Cloud Agent software running on the instance.
- async boolean
- availability
Configs GetInstance Availability Config[] - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- availability
Domain string - The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- boot
Volume stringId - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - capacity
Reservation stringId - 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.
- cluster
Placement stringGroup Id - The OCID of the cluster placement group of the instance.
- compartment
Id string - The OCID of the compartment containing images to search
- compute
Cluster stringId - create
Vnic GetDetails Instance Create Vnic Detail[] - dedicated
Vm stringHost Id - The OCID of the dedicated virtual machine host that the instance is placed on.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- extended
Metadata {[key: string]: string} - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the
metadata
object. - fault
Domain string - The name of the fault domain the instance is running in.
- {[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"}
- hostname
Label string - The hostname for the instance VNIC's primary private IP.
- id string
- The OCID of the instance.
- image string
- Deprecated. Use
sourceDetails
instead. - instance
Configuration stringId - 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.
- instance
Id string - instance
Options GetInstance Instance Option[] - Optional mutable instance options
- ipxe
Script 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.
- is
Cross booleanNuma Node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- is
Pv booleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - launch
Mode 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 theLaunchOptions
parameter.
- launch
Options GetInstance Launch Option[] - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- launch
Volume GetAttachments Instance Launch Volume Attachment[] - metadata {[key: string]: string}
- Custom metadata that you provide.
- platform
Configs GetInstance Platform Config[] - The platform configuration for the instance.
- preemptible
Instance GetConfigs Instance Preemptible Instance Config[] - (Optional) Configuration options for preemptible instances.
- preserve
Boot booleanVolume - (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 booleanVolumes Created At Launch - private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - public
Ip string - The public IP address of instance VNIC (if enabled).
- region string
- The region that contains the availability domain the instance is running in.
- security
Attributes {[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"}
- security
Attributes stringState - 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.
- shape
Configs GetInstance Shape Config[] - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source
Details GetInstance Source Detail[] - state string
- The current state of the instance.
- subnet
Id string - {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created string - The date and time the instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- time
Maintenance stringReboot Due - 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
- update
Operation stringConstraint
- agent_
configs Sequence[core.Get Instance Agent Config] - Configuration options for the Oracle Cloud Agent software running on the instance.
- async_ bool
- availability_
configs Sequence[core.Get Instance Availability Config] - 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_ strid - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - capacity_
reservation_ strid - 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.
- cluster_
placement_ strgroup_ id - The OCID of the cluster placement group of the instance.
- compartment_
id str - The OCID of the compartment containing images to search
- compute_
cluster_ strid - create_
vnic_ Sequence[core.details Get Instance Create Vnic Detail] - dedicated_
vm_ strhost_ id - The OCID of the dedicated virtual machine host that the instance is placed on.
- 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.
- 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.
- id str
- The OCID of the instance.
- image str
- Deprecated. Use
sourceDetails
instead. - instance_
configuration_ strid - 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.
- instance_
id str - instance_
options Sequence[core.Get Instance Instance Option] - 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_ boolnuma_ node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- is_
pv_ boolencryption_ in_ transit_ enabled - 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 theLaunchOptions
parameter.
- launch_
options Sequence[core.Get Instance Launch Option] - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- launch_
volume_ Sequence[core.attachments Get Instance Launch Volume Attachment] - metadata Mapping[str, str]
- Custom metadata that you provide.
- platform_
configs Sequence[core.Get Instance Platform Config] - The platform configuration for the instance.
- preemptible_
instance_ Sequence[core.configs Get Instance Preemptible Instance Config] - (Optional) Configuration options for preemptible instances.
- preserve_
boot_ boolvolume - (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_ boolvolumes_ created_ at_ launch - 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 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"}
- security_
attributes_ strstate - 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.Get Instance Shape Config] - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source_
details Sequence[core.Get Instance Source Detail] - state str
- The current state of the instance.
- subnet_
id str - 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_ strreboot_ due - 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
- update_
operation_ strconstraint
- agent
Configs List<Property Map> - Configuration options for the Oracle Cloud Agent software running on the instance.
- async Boolean
- availability
Configs List<Property Map> - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- availability
Domain String - The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- boot
Volume StringId - The OCID of the attached boot volume. If the
source_type
isbootVolume
, this will be the same OCID as thesource_id
. - capacity
Reservation StringId - 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.
- cluster
Placement StringGroup Id - The OCID of the cluster placement group of the instance.
- compartment
Id String - The OCID of the compartment containing images to search
- compute
Cluster StringId - create
Vnic List<Property Map>Details - dedicated
Vm StringHost Id - The OCID of the dedicated virtual machine host that the instance is placed on.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- extended
Metadata Map<String> - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the
metadata
object. - fault
Domain String - The name of the fault domain the instance is running in.
- 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"}
- hostname
Label String - The hostname for the instance VNIC's primary private IP.
- id String
- The OCID of the instance.
- image String
- Deprecated. Use
sourceDetails
instead. - instance
Configuration StringId - 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.
- instance
Id String - instance
Options List<Property Map> - Optional mutable instance options
- ipxe
Script 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.
- is
Cross BooleanNuma Node - Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
- is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - launch
Mode 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 theLaunchOptions
parameter.
- launch
Options List<Property Map> - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- launch
Volume List<Property Map>Attachments - metadata Map<String>
- Custom metadata that you provide.
- platform
Configs List<Property Map> - The platform configuration for the instance.
- preemptible
Instance List<Property Map>Configs - (Optional) Configuration options for preemptible instances.
- preserve
Boot BooleanVolume - (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 BooleanVolumes Created At Launch - private
Ip String - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - public
Ip String - The public IP address of instance VNIC (if enabled).
- region String
- The region that contains the availability domain the instance is running in.
- security
Attributes 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"}
- security
Attributes StringState - 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.
- shape
Configs List<Property Map> - The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source
Details List<Property Map> - state String
- The current state of the instance.
- subnet
Id String - Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the instance was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- time
Maintenance StringReboot Due - 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
- update
Operation StringConstraint
Supporting Types
GetInstanceAgentConfig
- Are
All boolPlugins Disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- Is
Management boolDisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- Is
Monitoring boolDisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- Plugins
Configs List<GetInstance Agent Config Plugins Config> - The configuration of plugins associated with this instance.
- Are
All boolPlugins Disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- Is
Management boolDisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- Is
Monitoring boolDisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- Plugins
Configs []GetInstance Agent Config Plugins Config - The configuration of plugins associated with this instance.
- are
All BooleanPlugins Disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- is
Management BooleanDisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- is
Monitoring BooleanDisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- plugins
Configs List<GetInstance Agent Config Plugins Config> - The configuration of plugins associated with this instance.
- are
All booleanPlugins Disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- is
Management booleanDisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- is
Monitoring booleanDisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- plugins
Configs GetInstance Agent Config Plugins Config[] - The configuration of plugins associated with this instance.
- are_
all_ boolplugins_ disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- is_
management_ booldisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- is_
monitoring_ booldisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- plugins_
configs Sequence[core.Get Instance Agent Config Plugins Config] - The configuration of plugins associated with this instance.
- are
All BooleanPlugins Disabled - Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
- is
Management BooleanDisabled - Whether Oracle Cloud Agent can run all the available management plugins.
- is
Monitoring BooleanDisabled - Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.
- plugins
Configs List<Property Map> - The configuration of plugins associated with this instance.
GetInstanceAgentConfigPluginsConfig
- Desired
State 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 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 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 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.
- desired
State 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
- Is
Live boolMigration Preferred - 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.
- Recovery
Action 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 boolMigration Preferred - 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.
- Recovery
Action 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 BooleanMigration Preferred - 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.
- recovery
Action 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 booleanMigration Preferred - 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.
- recovery
Action 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_ boolmigration_ preferred - 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.
- 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.
- is
Live BooleanMigration Preferred - 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.
- recovery
Action 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
- Assign
Ipv6ip bool - Assign
Private boolDns Record - Assign
Public stringIp - Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Hostname
Label string - The hostname for the instance VNIC's primary private IP.
- Ipv6address
Ipv6subnet List<GetCidr Pair Details Instance Create Vnic Detail Ipv6address Ipv6subnet Cidr Pair Detail> - Nsg
Ids List<string> - Private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - Security
Attributes 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"}
- Skip
Source boolDest Check - Subnet
Id string - Vlan
Id string
- Assign
Ipv6ip bool - Assign
Private boolDns Record - Assign
Public stringIp - map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Hostname
Label string - The hostname for the instance VNIC's primary private IP.
- Ipv6address
Ipv6subnet []GetCidr Pair Details Instance Create Vnic Detail Ipv6address Ipv6subnet Cidr Pair Detail - Nsg
Ids []string - Private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - Security
Attributes 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"}
- Skip
Source boolDest Check - Subnet
Id string - Vlan
Id string
- assign
Ipv6ip Boolean - assign
Private BooleanDns Record - assign
Public StringIp - Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- hostname
Label String - The hostname for the instance VNIC's primary private IP.
- ipv6address
Ipv6subnet List<GetCidr Pair Details Instance Create Vnic Detail Ipv6address Ipv6subnet Cidr Pair Detail> - nsg
Ids List<String> - private
Ip String - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - security
Attributes 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"}
- skip
Source BooleanDest Check - subnet
Id String - vlan
Id String
- assign
Ipv6ip boolean - assign
Private booleanDns Record - assign
Public stringIp - {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"}
- hostname
Label string - The hostname for the instance VNIC's primary private IP.
- ipv6address
Ipv6subnet GetCidr Pair Details Instance Create Vnic Detail Ipv6address Ipv6subnet Cidr Pair Detail[] - nsg
Ids string[] - private
Ip string - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - security
Attributes {[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"}
- skip
Source booleanDest Check - subnet
Id string - vlan
Id string
- assign_
ipv6ip bool - assign_
private_ booldns_ record - assign_
public_ strip - 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.
- 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_ Sequence[core.cidr_ pair_ details Get Instance Create Vnic Detail Ipv6address Ipv6subnet Cidr Pair Detail] - 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_ booldest_ check - subnet_
id str - vlan_
id str
- assign
Ipv6ip Boolean - assign
Private BooleanDns Record - assign
Public StringIp - Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- hostname
Label String - The hostname for the instance VNIC's primary private IP.
- ipv6address
Ipv6subnet List<Property Map>Cidr Pair Details - nsg
Ids List<String> - private
Ip String - The private IP address of instance VNIC. To set the private IP address, use the
private_ip
argument in create_vnic_details. - security
Attributes 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"}
- skip
Source BooleanDest Check - subnet
Id String - vlan
Id String
GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail
- Ipv6address string
- Ipv6subnet
Cidr string
- Ipv6address string
- Ipv6subnet
Cidr string
- ipv6address String
- ipv6subnet
Cidr String
- ipv6address string
- ipv6subnet
Cidr string
- ipv6address str
- ipv6subnet_
cidr str
- ipv6address String
- ipv6subnet
Cidr String
GetInstanceInstanceOption
- Are
Legacy boolImds Endpoints Disabled - 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 boolImds Endpoints Disabled - 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 BooleanImds Endpoints Disabled - 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 booleanImds Endpoints Disabled - 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_ boolimds_ endpoints_ disabled - 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 BooleanImds Endpoints Disabled - 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
- Boot
Volume stringType - 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.
- Is
Consistent boolVolume Naming Enabled - Whether to enable consistent volume naming feature. Defaults to false.
- Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Network
Type 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.
- Remote
Data stringVolume Type - 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 stringType - 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.
- Is
Consistent boolVolume Naming Enabled - Whether to enable consistent volume naming feature. Defaults to false.
- Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Network
Type 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.
- Remote
Data stringVolume Type - 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 StringType - 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.
- is
Consistent BooleanVolume Naming Enabled - Whether to enable consistent volume naming feature. Defaults to false.
- is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - network
Type 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.
- remote
Data StringVolume Type - 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 stringType - 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.
- is
Consistent booleanVolume Naming Enabled - Whether to enable consistent volume naming feature. Defaults to false.
- is
Pv booleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - network
Type 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.
- remote
Data stringVolume Type - 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_ strtype - 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_ boolvolume_ naming_ enabled - Whether to enable consistent volume naming feature. Defaults to false.
- is_
pv_ boolencryption_ in_ transit_ enabled - 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_ strvolume_ type - 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 StringType - 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.
- is
Consistent BooleanVolume Naming Enabled - Whether to enable consistent volume naming feature. Defaults to false.
- is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - network
Type 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.
- remote
Data StringVolume Type - 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
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Encryption
In stringTransit Type - Is
Agent boolAuto Iscsi Login Enabled - Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Is
Read boolOnly - bool
- Launch
Create List<GetVolume Details Instance Launch Volume Attachment Launch Create Volume Detail> - Type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- Use
Chap bool - Volume
Id string
- Device string
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Encryption
In stringTransit Type - Is
Agent boolAuto Iscsi Login Enabled - Is
Pv boolEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - Is
Read boolOnly - bool
- Launch
Create []GetVolume Details Instance Launch Volume Attachment Launch Create Volume Detail - Type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- Use
Chap bool - Volume
Id string
- device String
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- encryption
In StringTransit Type - is
Agent BooleanAuto Iscsi Login Enabled - is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - is
Read BooleanOnly - Boolean
- launch
Create List<GetVolume Details Instance Launch Volume Attachment Launch Create Volume Detail> - type String
- (Required) The type of action to run when the instance is interrupted for eviction.
- use
Chap Boolean - volume
Id String
- device string
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- encryption
In stringTransit Type - is
Agent booleanAuto Iscsi Login Enabled - is
Pv booleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - is
Read booleanOnly - boolean
- launch
Create GetVolume Details Instance Launch Volume Attachment Launch Create Volume Detail[] - type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- use
Chap boolean - volume
Id 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_ strtransit_ type - is_
agent_ boolauto_ iscsi_ login_ enabled - is_
pv_ boolencryption_ in_ transit_ enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - is_
read_ boolonly - bool
- launch_
create_ Sequence[core.volume_ details Get Instance Launch Volume Attachment Launch Create Volume Detail] - type str
- (Required) The type of action to run when the instance is interrupted for eviction.
- use_
chap bool - volume_
id str
- device String
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- encryption
In StringTransit Type - is
Agent BooleanAuto Iscsi Login Enabled - is
Pv BooleanEncryption In Transit Enabled - Deprecated. Instead use
isPvEncryptionInTransitEnabled
in LaunchInstanceDetails. - is
Read BooleanOnly - Boolean
- launch
Create List<Property Map>Volume Details - type String
- (Required) The type of action to run when the instance is interrupted for eviction.
- use
Chap Boolean - volume
Id String
GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail
- Compartment
Id string - The OCID of the compartment containing images to search
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - Volume
Creation stringType - Vpus
Per stringGb
- Compartment
Id string - The OCID of the compartment containing images to search
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - Volume
Creation stringType - Vpus
Per stringGb
- compartment
Id String - The OCID of the compartment containing images to search
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key StringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - volume
Creation StringType - vpus
Per StringGb
- compartment
Id string - The OCID of the compartment containing images to search
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In stringGbs - volume
Creation stringType - vpus
Per stringGb
- 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_ strid - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size_
in_ strgbs - volume_
creation_ strtype - vpus_
per_ strgb
- compartment
Id String - The OCID of the compartment containing images to search
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key StringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - volume
Creation StringType - vpus
Per StringGb
GetInstancePlatformConfig
- Are
Virtual boolInstructions Enabled - Whether virtualization instructions are available.
- Config
Map Dictionary<string, string> - Instance Platform Configuration Configuration Map for flexible setting input.
- Is
Access boolControl Service Enabled - 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 boolOutput Memory Management Unit Enabled - Whether the input-output memory management unit is enabled.
- Is
Measured boolBoot Enabled - Whether the Measured Boot is to be enabled on the instance
- Is
Memory boolEncryption Enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - Is
Secure boolBoot Enabled - Whether the Secure Boot is to be enabled on the instance.
- Is
Symmetric boolMulti Threading Enabled - Whether symmetric multi-threading is enabled on the instance.
- Is
Trusted boolPlatform Module Enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- Numa
Nodes stringPer Socket - The number of NUMA nodes per socket (NPS).
- Percentage
Of intCores Enabled - The percentage of cores enabled.
- Type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- Are
Virtual boolInstructions Enabled - Whether virtualization instructions are available.
- Config
Map map[string]string - Instance Platform Configuration Configuration Map for flexible setting input.
- Is
Access boolControl Service Enabled - 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 boolOutput Memory Management Unit Enabled - Whether the input-output memory management unit is enabled.
- Is
Measured boolBoot Enabled - Whether the Measured Boot is to be enabled on the instance
- Is
Memory boolEncryption Enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - Is
Secure boolBoot Enabled - Whether the Secure Boot is to be enabled on the instance.
- Is
Symmetric boolMulti Threading Enabled - Whether symmetric multi-threading is enabled on the instance.
- Is
Trusted boolPlatform Module Enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- Numa
Nodes stringPer Socket - The number of NUMA nodes per socket (NPS).
- Percentage
Of intCores Enabled - The percentage of cores enabled.
- Type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- are
Virtual BooleanInstructions Enabled - Whether virtualization instructions are available.
- config
Map Map<String,String> - Instance Platform Configuration Configuration Map for flexible setting input.
- is
Access BooleanControl Service Enabled - 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 BooleanOutput Memory Management Unit Enabled - Whether the input-output memory management unit is enabled.
- is
Measured BooleanBoot Enabled - Whether the Measured Boot is to be enabled on the instance
- is
Memory BooleanEncryption Enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - is
Secure BooleanBoot Enabled - Whether the Secure Boot is to be enabled on the instance.
- is
Symmetric BooleanMulti Threading Enabled - Whether symmetric multi-threading is enabled on the instance.
- is
Trusted BooleanPlatform Module Enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- numa
Nodes StringPer Socket - The number of NUMA nodes per socket (NPS).
- percentage
Of IntegerCores Enabled - The percentage of cores enabled.
- type String
- (Required) The type of action to run when the instance is interrupted for eviction.
- are
Virtual booleanInstructions Enabled - Whether virtualization instructions are available.
- config
Map {[key: string]: string} - Instance Platform Configuration Configuration Map for flexible setting input.
- is
Access booleanControl Service Enabled - 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 booleanOutput Memory Management Unit Enabled - Whether the input-output memory management unit is enabled.
- is
Measured booleanBoot Enabled - Whether the Measured Boot is to be enabled on the instance
- is
Memory booleanEncryption Enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - is
Secure booleanBoot Enabled - Whether the Secure Boot is to be enabled on the instance.
- is
Symmetric booleanMulti Threading Enabled - Whether symmetric multi-threading is enabled on the instance.
- is
Trusted booleanPlatform Module Enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- numa
Nodes stringPer Socket - The number of NUMA nodes per socket (NPS).
- percentage
Of numberCores Enabled - The percentage of cores enabled.
- type string
- (Required) The type of action to run when the instance is interrupted for eviction.
- are_
virtual_ boolinstructions_ enabled - Whether virtualization instructions are available.
- config_
map Mapping[str, str] - Instance Platform Configuration Configuration Map for flexible setting input.
- is_
access_ boolcontrol_ service_ enabled - 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_ booloutput_ memory_ management_ unit_ enabled - Whether the input-output memory management unit is enabled.
- is_
measured_ boolboot_ enabled - Whether the Measured Boot is to be enabled on the instance
- is_
memory_ boolencryption_ enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - is_
secure_ boolboot_ enabled - Whether the Secure Boot is to be enabled on the instance.
- is_
symmetric_ boolmulti_ threading_ enabled - Whether symmetric multi-threading is enabled on the instance.
- is_
trusted_ boolplatform_ module_ enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- numa_
nodes_ strper_ socket - The number of NUMA nodes per socket (NPS).
- percentage_
of_ intcores_ enabled - The percentage of cores enabled.
- type str
- (Required) The type of action to run when the instance is interrupted for eviction.
- are
Virtual BooleanInstructions Enabled - Whether virtualization instructions are available.
- config
Map Map<String> - Instance Platform Configuration Configuration Map for flexible setting input.
- is
Access BooleanControl Service Enabled - 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 BooleanOutput Memory Management Unit Enabled - Whether the input-output memory management unit is enabled.
- is
Measured BooleanBoot Enabled - Whether the Measured Boot is to be enabled on the instance
- is
Memory BooleanEncryption Enabled - Whether the instance is a confidential instance. If this value is
true
, the instance is a confidential instance. The default value isfalse
. - is
Secure BooleanBoot Enabled - Whether the Secure Boot is to be enabled on the instance.
- is
Symmetric BooleanMulti Threading Enabled - Whether symmetric multi-threading is enabled on the instance.
- is
Trusted BooleanPlatform Module Enabled - Whether the Trusted Platform Module (TPM) is to be enabled on the instance.
- numa
Nodes StringPer Socket - The number of NUMA nodes per socket (NPS).
- percentage
Of NumberCores Enabled - The percentage of cores enabled.
- type String
- (Required) The type of action to run when the instance is interrupted for eviction.
GetInstancePreemptibleInstanceConfig
- Preemption
Actions List<GetInstance Preemptible Instance Config Preemption Action> - (Required) The action to run when the preemptible instance is interrupted for eviction.
- Preemption
Actions []GetInstance Preemptible Instance Config Preemption Action - (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption
Actions List<GetInstance Preemptible Instance Config Preemption Action> - (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption
Actions GetInstance Preemptible Instance Config Preemption Action[] - (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption_
actions Sequence[core.Get Instance Preemptible Instance Config Preemption Action] - (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption
Actions List<Property Map> - (Required) The action to run when the preemptible instance is interrupted for eviction.
GetInstancePreemptibleInstanceConfigPreemptionAction
- Preserve
Boot boolVolume - (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 boolVolume - (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 BooleanVolume - (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 booleanVolume - (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_ boolvolume - (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.
- preserve
Boot BooleanVolume - (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
- Baseline
Ocpu stringUtilization - 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 string - A short description of the instance's graphics processing unit (GPU).
- Gpus int
- The number of GPUs available to the instance.
- Local
Disk stringDescription - 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 doubleTotal Size In Gbs - The aggregate size of all local disks, in gigabytes.
- Max
Vnic intAttachments - The maximum number of VNIC attachments for the instance.
- Memory
In doubleGbs - The total amount of memory available to the instance, in gigabytes.
- Networking
Bandwidth doubleIn Gbps - The networking bandwidth available to the instance, in gigabits per second.
- Nvmes int
- Ocpus double
- The total number of OCPUs available to the instance.
- Processor
Description 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.
- Baseline
Ocpu stringUtilization - 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 string - A short description of the instance's graphics processing unit (GPU).
- Gpus int
- The number of GPUs available to the instance.
- Local
Disk stringDescription - 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 float64Total Size In Gbs - The aggregate size of all local disks, in gigabytes.
- Max
Vnic intAttachments - The maximum number of VNIC attachments for the instance.
- Memory
In float64Gbs - The total amount of memory available to the instance, in gigabytes.
- Networking
Bandwidth float64In Gbps - The networking bandwidth available to the instance, in gigabits per second.
- Nvmes int
- Ocpus float64
- The total number of OCPUs available to the instance.
- Processor
Description 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.
- baseline
Ocpu StringUtilization - 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 String - A short description of the instance's graphics processing unit (GPU).
- gpus Integer
- The number of GPUs available to the instance.
- local
Disk StringDescription - A short description of the local disks available to this instance.
- local
Disks Integer - The number of local disks available to the instance.
- local
Disks DoubleTotal Size In Gbs - The aggregate size of all local disks, in gigabytes.
- max
Vnic IntegerAttachments - The maximum number of VNIC attachments for the instance.
- memory
In DoubleGbs - The total amount of memory available to the instance, in gigabytes.
- networking
Bandwidth DoubleIn Gbps - The networking bandwidth available to the instance, in gigabits per second.
- nvmes Integer
- ocpus Double
- The total number of OCPUs available to the instance.
- processor
Description 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.
- baseline
Ocpu stringUtilization - 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 string - A short description of the instance's graphics processing unit (GPU).
- gpus number
- The number of GPUs available to the instance.
- local
Disk stringDescription - A short description of the local disks available to this instance.
- local
Disks number - The number of local disks available to the instance.
- local
Disks numberTotal Size In Gbs - The aggregate size of all local disks, in gigabytes.
- max
Vnic numberAttachments - The maximum number of VNIC attachments for the instance.
- memory
In numberGbs - The total amount of memory available to the instance, in gigabytes.
- networking
Bandwidth numberIn Gbps - The networking bandwidth available to the instance, in gigabits per second.
- nvmes number
- ocpus number
- The total number of OCPUs available to the instance.
- processor
Description 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_ strutilization - 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_ strdescription - 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_ floattotal_ size_ in_ gbs - The aggregate size of all local disks, in gigabytes.
- max_
vnic_ intattachments - The maximum number of VNIC attachments for the instance.
- memory_
in_ floatgbs - The total amount of memory available to the instance, in gigabytes.
- networking_
bandwidth_ floatin_ gbps - 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.
- baseline
Ocpu StringUtilization - 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 String - A short description of the instance's graphics processing unit (GPU).
- gpus Number
- The number of GPUs available to the instance.
- local
Disk StringDescription - A short description of the local disks available to this instance.
- local
Disks Number - The number of local disks available to the instance.
- local
Disks NumberTotal Size In Gbs - The aggregate size of all local disks, in gigabytes.
- max
Vnic NumberAttachments - The maximum number of VNIC attachments for the instance.
- memory
In NumberGbs - The total amount of memory available to the instance, in gigabytes.
- networking
Bandwidth NumberIn Gbps - The networking bandwidth available to the instance, in gigabits per second.
- nvmes Number
- ocpus Number
- The total number of OCPUs available to the instance.
- processor
Description 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
- Boot
Volume stringSize In Gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- Boot
Volume stringVpus Per Gb - 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 List<GetImage Filter Details Instance Source Detail Instance Source Image Filter Detail> - These are the criteria for selecting an image. This is required if imageId is not specified.
- Is
Preserve boolBoot Volume Enabled - Kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Source
Id string - The OCID of the boot volume used to boot the instance.
- Source
Type string - The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
- Boot
Volume stringSize In Gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- Boot
Volume stringVpus Per Gb - 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 []GetImage Filter Details Instance Source Detail Instance Source Image Filter Detail - These are the criteria for selecting an image. This is required if imageId is not specified.
- Is
Preserve boolBoot Volume Enabled - Kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Source
Id string - The OCID of the boot volume used to boot the instance.
- Source
Type string - The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
- boot
Volume StringSize In Gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- boot
Volume StringVpus Per Gb - 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 List<GetImage Filter Details Instance Source Detail Instance Source Image Filter Detail> - These are the criteria for selecting an image. This is required if imageId is not specified.
- is
Preserve BooleanBoot Volume Enabled - kms
Key StringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- source
Id String - The OCID of the boot volume used to boot the instance.
- source
Type String - The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
- boot
Volume stringSize In Gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- boot
Volume stringVpus Per Gb - 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 GetImage Filter Details Instance Source Detail Instance Source Image Filter Detail[] - These are the criteria for selecting an image. This is required if imageId is not specified.
- is
Preserve booleanBoot Volume Enabled - kms
Key stringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- source
Id string - The OCID of the boot volume used to boot the instance.
- source
Type string - The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
- boot_
volume_ strsize_ in_ gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- boot_
volume_ strvpus_ per_ gb - 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_ Sequence[core.image_ filter_ details Get Instance Source Detail Instance Source Image Filter Detail] - These are the criteria for selecting an image. This is required if imageId is not specified.
- is_
preserve_ boolboot_ volume_ enabled - kms_
key_ strid - 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. UsebootVolume
when specifying the boot volume OCID.
- boot
Volume StringSize In Gbs - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
- boot
Volume StringVpus Per Gb - 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 List<Property Map>Image Filter Details - These are the criteria for selecting an image. This is required if imageId is not specified.
- is
Preserve BooleanBoot Volume Enabled - kms
Key StringId - The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- source
Id String - The OCID of the boot volume used to boot the instance.
- source
Type String - The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
GetInstanceSourceDetailInstanceSourceImageFilterDetail
- Compartment
Id string - The OCID of the compartment containing images to search
- Dictionary<string, string>
- Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Operating
System string - The image's operating system. Example:
Oracle Linux
- Operating
System stringVersion - The image's operating system version. Example:
7.2
- Compartment
Id string - The OCID of the compartment containing images to search
- map[string]string
- Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Operating
System string - The image's operating system. Example:
Oracle Linux
- Operating
System stringVersion - The image's operating system version. Example:
7.2
- compartment
Id String - The OCID of the compartment containing images to search
- Map<String,String>
- Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- operating
System String - The image's operating system. Example:
Oracle Linux
- operating
System StringVersion - The image's operating system version. Example:
7.2
- compartment
Id string - The OCID of the compartment containing images to search
- {[key: string]: string}
- Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- operating
System string - The image's operating system. Example:
Oracle Linux
- operating
System stringVersion - The image's operating system version. Example:
7.2
- compartment_
id str - The OCID of the compartment containing images to search
- 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_ strversion - The image's operating system version. Example:
7.2
- compartment
Id String - The OCID of the compartment containing images to search
- Map<String>
- Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- operating
System String - The image's operating system. Example:
Oracle Linux
- operating
System StringVersion - 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.