Oracle Cloud Infrastructure
getInstances
This data source provides the list of Instances in Oracle Cloud Infrastructure Core service.
Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testInstances = Output.Create(Oci.Core.GetInstances.InvokeAsync(new Oci.Core.GetInstancesArgs
{
CompartmentId = @var.Compartment_id,
AvailabilityDomain = @var.Instance_availability_domain,
CapacityReservationId = oci_core_capacity_reservation.Test_capacity_reservation.Id,
DisplayName = @var.Instance_display_name,
State = @var.Instance_state,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Core.GetInstances(ctx, &core.GetInstancesArgs{
CompartmentId: _var.Compartment_id,
AvailabilityDomain: pulumi.StringRef(_var.Instance_availability_domain),
CapacityReservationId: pulumi.StringRef(oci_core_capacity_reservation.Test_capacity_reservation.Id),
DisplayName: pulumi.StringRef(_var.Instance_display_name),
State: pulumi.StringRef(_var.Instance_state),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_instances = oci.Core.get_instances(compartment_id=var["compartment_id"],
availability_domain=var["instance_availability_domain"],
capacity_reservation_id=oci_core_capacity_reservation["test_capacity_reservation"]["id"],
display_name=var["instance_display_name"],
state=var["instance_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testInstances = oci.Core.getInstances({
compartmentId: _var.compartment_id,
availabilityDomain: _var.instance_availability_domain,
capacityReservationId: oci_core_capacity_reservation.test_capacity_reservation.id,
displayName: _var.instance_display_name,
state: _var.instance_state,
});
Coming soon!
Using getInstances
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 getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
def get_instances(availability_domain: Optional[str] = None,
capacity_reservation_id: Optional[str] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_core.GetInstancesFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(availability_domain: Optional[pulumi.Input[str]] = None,
capacity_reservation_id: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetInstancesFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput
> Note: This function is named GetInstances
in the Go SDK.
public static class GetInstances
{
public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:Core/getInstances:getInstances
Arguments:
# Arguments dictionary
The following arguments are supported:
- Compartment
Id string The OCID of the compartment.
- Availability
Domain string The name of the availability domain. Example:
Uocm:PHX-AD-1
- Capacity
Reservation stringId The OCID of the compute capacity reservation.
- Display
Name string A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Instances Filter> - State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Compartment
Id string The OCID of the compartment.
- Availability
Domain string The name of the availability domain. Example:
Uocm:PHX-AD-1
- Capacity
Reservation stringId The OCID of the compute capacity reservation.
- Display
Name string A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Instances Filter - State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String The OCID of the compartment.
- availability
Domain String The name of the availability domain. Example:
Uocm:PHX-AD-1
- capacity
Reservation StringId The OCID of the compute capacity reservation.
- display
Name String A filter to return only resources that match the given display name exactly.
- filters
List<Get
Instances Filter> - state String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id string The OCID of the compartment.
- availability
Domain string The name of the availability domain. Example:
Uocm:PHX-AD-1
- capacity
Reservation stringId The OCID of the compute capacity reservation.
- display
Name string A filter to return only resources that match the given display name exactly.
- filters
Get
Instances Filter[] - state string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment_
id str The OCID of the compartment.
- availability_
domain str The name of the availability domain. Example:
Uocm:PHX-AD-1
- capacity_
reservation_ strid The OCID of the compute capacity reservation.
- display_
name str A filter to return only resources that match the given display name exactly.
- filters
Get
Instances Filter] - state str
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String The OCID of the compartment.
- availability
Domain String The name of the availability domain. Example:
Uocm:PHX-AD-1
- capacity
Reservation StringId The OCID of the compute capacity reservation.
- display
Name String A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
- state String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
getInstances Result
The following output properties are available:
- Compartment
Id string The OCID of the compartment that contains the instance.
- Id string
The provider-assigned unique ID for this managed resource.
- Instances
List<Get
Instances Instance> The list of instances.
- Availability
Domain string The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Instances Filter> - State string
The current state of the instance.
- Compartment
Id string The OCID of the compartment that contains the instance.
- Id string
The provider-assigned unique ID for this managed resource.
- Instances
[]Get
Instances Instance The list of instances.
- Availability
Domain string The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Instances Filter - State string
The current state of the instance.
- compartment
Id String The OCID of the compartment that contains the instance.
- id String
The provider-assigned unique ID for this managed resource.
- instances
List<Get
Instances Instance> The list of instances.
- availability
Domain String The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Instances Filter> - state String
The current state of the instance.
- compartment
Id string The OCID of the compartment that contains the instance.
- id string
The provider-assigned unique ID for this managed resource.
- instances
Get
Instances Instance[] The list of instances.
- availability
Domain string The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Instances Filter[] - state string
The current state of the instance.
- compartment_
id str The OCID of the compartment that contains the instance.
- id str
The provider-assigned unique ID for this managed resource.
- instances
Get
Instances Instance] The list of instances.
- availability_
domain str The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- display_
name str A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Instances Filter] - state str
The current state of the instance.
- compartment
Id String The OCID of the compartment that contains the instance.
- id String
The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
The list of instances.
- availability
Domain String The availability domain the instance is running in. Example:
Uocm:PHX-AD-1
- 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.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- state String
The current state of the instance.
Supporting Types
GetInstancesFilter
- 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.
- Values List<string>
- Regex bool
- 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.
- Values []string
- Regex bool
- 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.
- values List<String>
- regex Boolean
- 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.
- values string[]
- regex boolean
- 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.
- values Sequence[str]
- regex bool
- 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.
- values List<String>
- regex Boolean
GetInstancesInstance
- Agent
Configs List<GetInstances Instance Agent Config> Configuration options for the Oracle Cloud Agent software running on the instance.
- Async bool
- Availability
Configs List<GetInstances Instance Availability Config> Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- Availability
Domain string The name of the availability domain. 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.
- Compartment
Id string The OCID of the compartment.
- Create
Vnic List<GetDetails Instances Instance Create Vnic Detail> - Dedicated
Vm stringHost Id The OCID of dedicated VM host.
- Dictionary<string, object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- Extended
Metadata Dictionary<string, object> 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, object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname
Label string The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- Id string
The OCID of the instance.
- Image string
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- Instance
Options List<GetInstances Instance 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
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:
- Launch
Options List<GetInstances Instance Launch Option> Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- Metadata Dictionary<string, object>
Custom metadata that you provide.
- Platform
Configs List<GetInstances Instance Platform Config> The platform configuration for the instance.
- Preemptible
Instance List<GetConfigs Instances 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.
- Private
Ip string - Public
Ip string - Region string
The region that contains the availability domain the instance is running in.
- 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<GetInstances Instance Shape Config> The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- Source
Details List<GetInstances Instance Source Detail> - State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Subnet
Id string The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- Dictionary<string, object>
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
- Agent
Configs []GetInstances Instance Agent Config Configuration options for the Oracle Cloud Agent software running on the instance.
- Async bool
- Availability
Configs []GetInstances Instance Availability Config Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- Availability
Domain string The name of the availability domain. 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.
- Compartment
Id string The OCID of the compartment.
- Create
Vnic []GetDetails Instances Instance Create Vnic Detail - Dedicated
Vm stringHost Id The OCID of dedicated VM host.
- map[string]interface{}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- Extended
Metadata map[string]interface{} 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]interface{}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname
Label string The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- Id string
The OCID of the instance.
- Image string
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- Instance
Options []GetInstances Instance 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
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:
- Launch
Options []GetInstances Instance Launch Option Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- Metadata map[string]interface{}
Custom metadata that you provide.
- Platform
Configs []GetInstances Instance Platform Config The platform configuration for the instance.
- Preemptible
Instance []GetConfigs Instances 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.
- Private
Ip string - Public
Ip string - Region string
The region that contains the availability domain the instance is running in.
- 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 []GetInstances Instance Shape Config The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- Source
Details []GetInstances Instance Source Detail - State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Subnet
Id string The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- map[string]interface{}
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
- agent
Configs List<GetInstances Instance Agent Config> Configuration options for the Oracle Cloud Agent software running on the instance.
- async Boolean
- availability
Configs List<GetInstances Instance Availability Config> Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- availability
Domain String The name of the availability domain. 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.
- compartment
Id String The OCID of the compartment.
- create
Vnic List<GetDetails Instances Instance Create Vnic Detail> - dedicated
Vm StringHost Id The OCID of dedicated VM host.
- Map<String,Object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String A filter to return only resources that match the given display name exactly.
- extended
Metadata Map<String,Object> 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,Object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label String The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- id String
The OCID of the instance.
- image String
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- instance
Options List<GetInstances Instance 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
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:
- launch
Options List<GetInstances Instance Launch Option> Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- metadata Map<String,Object>
Custom metadata that you provide.
- platform
Configs List<GetInstances Instance Platform Config> The platform configuration for the instance.
- preemptible
Instance List<GetConfigs Instances 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.
- private
Ip String - public
Ip String - region String
The region that contains the availability domain the instance is running in.
- 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<GetInstances Instance Shape Config> The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source
Details List<GetInstances Instance Source Detail> - state String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- subnet
Id String The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- Map<String,Object>
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
- agent
Configs GetInstances Instance Agent Config[] Configuration options for the Oracle Cloud Agent software running on the instance.
- async boolean
- availability
Configs GetInstances Instance Availability Config[] Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
- availability
Domain string The name of the availability domain. 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.
- compartment
Id string The OCID of the compartment.
- create
Vnic GetDetails Instances Instance Create Vnic Detail[] - dedicated
Vm stringHost Id The OCID of dedicated VM host.
- {[key: string]: any}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string A filter to return only resources that match the given display name exactly.
- extended
Metadata {[key: string]: any} 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]: any}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label string The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- id string
The OCID of the instance.
- image string
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- instance
Options GetInstances Instance 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
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:
- launch
Options GetInstances Instance Launch Option[] Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- metadata {[key: string]: any}
Custom metadata that you provide.
- platform
Configs GetInstances Instance Platform Config[] The platform configuration for the instance.
- preemptible
Instance GetConfigs Instances 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.
- private
Ip string - public
Ip string - region string
The region that contains the availability domain the instance is running in.
- 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 GetInstances Instance Shape Config[] The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source
Details GetInstances Instance Source Detail[] - state string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- subnet
Id string The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- {[key: string]: any}
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
- agent_
configs GetInstances Instance Agent Config] Configuration options for the Oracle Cloud Agent software running on the instance.
- async_ bool
- availability_
configs GetInstances 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 name of the availability domain. 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.
- compartment_
id str The OCID of the compartment.
- create_
vnic_ Getdetails Instances Instance Create Vnic Detail] - dedicated_
vm_ strhost_ id The OCID of dedicated VM host.
- Mapping[str, Any]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name str A filter to return only resources that match the given display name exactly.
- extended_
metadata Mapping[str, Any] 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, Any]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname_
label str The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- id str
The OCID of the instance.
- image str
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- instance_
options GetInstances 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_
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:
- launch_
options GetInstances Instance Launch Option] Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- metadata Mapping[str, Any]
Custom metadata that you provide.
- platform_
configs GetInstances Instance Platform Config] The platform configuration for the instance.
- preemptible_
instance_ Getconfigs Instances 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.
- private_
ip str - public_
ip str - region str
The region that contains the availability domain the instance is running in.
- 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 GetInstances Instance Shape Config] The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
- source_
details GetInstances Instance Source Detail] - state str
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- subnet_
id str The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- Mapping[str, Any]
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
- 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 name of the availability domain. 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.
- compartment
Id String The OCID of the compartment.
- create
Vnic List<Property Map>Details - dedicated
Vm StringHost Id The OCID of dedicated VM host.
- Map<Any>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String A filter to return only resources that match the given display name exactly.
- extended
Metadata Map<Any> 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<Any>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label String The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.
- id String
The OCID of the instance.
- image String
Deprecated. Use
sourceDetails
instead.The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.
- 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
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:
- launch
Options List<Property Map> Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- metadata Map<Any>
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.
- private
Ip String - public
Ip String - region String
The region that contains the availability domain the instance is running in.
- 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
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- subnet
Id String The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.
- Map<Any>
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
GetInstancesInstanceAgentConfig
- 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<GetInstances Instance 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 []GetInstances 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<GetInstances 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 GetInstances Instance 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 GetInstances 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.
GetInstancesInstanceAgentConfigPluginsConfig
- 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.
GetInstancesInstanceAvailabilityConfig
- Is
Live boolMigration Preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- Recovery
Action string The lifecycle state for an instance when it is recovered after infrastructure maintenance.
- Is
Live boolMigration Preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- Recovery
Action string The lifecycle state for an instance when it is recovered after infrastructure maintenance.
- is
Live BooleanMigration Preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- recovery
Action String The lifecycle state for an instance when it is recovered after infrastructure maintenance.
- is
Live booleanMigration Preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- recovery
Action string The lifecycle state for an instance when it is recovered after infrastructure maintenance.
- is_
live_ boolmigration_ preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- recovery_
action str The lifecycle state for an instance when it is recovered after infrastructure maintenance.
- is
Live BooleanMigration Preferred Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.
- recovery
Action String The lifecycle state for an instance when it is recovered after infrastructure maintenance.
GetInstancesInstanceCreateVnicDetail
- Assign
Private boolDns Record - Assign
Public stringIp - Dictionary<string, object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- Dictionary<string, object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname
Label string - Nsg
Ids List<string> - Private
Ip string - Skip
Source boolDest Check - Subnet
Id string - Vlan
Id string
- Assign
Private boolDns Record - Assign
Public stringIp - map[string]interface{}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- map[string]interface{}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Hostname
Label string - Nsg
Ids []string - Private
Ip string - Skip
Source boolDest Check - Subnet
Id string - Vlan
Id string
- assign
Private BooleanDns Record - assign
Public StringIp - Map<String,Object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String A filter to return only resources that match the given display name exactly.
- Map<String,Object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label String - nsg
Ids List<String> - private
Ip String - skip
Source BooleanDest Check - subnet
Id String - vlan
Id String
- assign
Private booleanDns Record - assign
Public stringIp - {[key: string]: any}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string A filter to return only resources that match the given display name exactly.
- {[key: string]: any}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label string - nsg
Ids string[] - private
Ip string - skip
Source booleanDest Check - subnet
Id string - vlan
Id string
- assign_
private_ booldns_ record - assign_
public_ strip - Mapping[str, Any]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name str A filter to return only resources that match the given display name exactly.
- Mapping[str, Any]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname_
label str - nsg_
ids Sequence[str] - private_
ip str - skip_
source_ booldest_ check - subnet_
id str - vlan_
id str
- assign
Private BooleanDns Record - assign
Public StringIp - Map<Any>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String A filter to return only resources that match the given display name exactly.
- Map<Any>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- hostname
Label String - nsg
Ids List<String> - private
Ip String - skip
Source BooleanDest Check - subnet
Id String - vlan
Id String
GetInstancesInstanceInstanceOption
- 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.
GetInstancesInstanceLaunchOption
- Boot
Volume stringType Emulation type for the boot volume.
- Firmware string
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- Remote
Data stringVolume Type Emulation type for volume.
- Boot
Volume stringType Emulation type for the boot volume.
- Firmware string
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- Remote
Data stringVolume Type Emulation type for volume.
- boot
Volume StringType Emulation type for the boot volume.
- firmware String
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- remote
Data StringVolume Type Emulation type for volume.
- boot
Volume stringType Emulation type for the boot volume.
- firmware string
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- remote
Data stringVolume Type Emulation type for volume.
- boot_
volume_ strtype Emulation type for the boot volume.
- firmware str
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- remote_
data_ strvolume_ type Emulation type for volume.
- boot
Volume StringType Emulation type for the boot volume.
- firmware String
Firmware used to boot VM. Select the option that matches your operating system.
- 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).
- remote
Data StringVolume Type Emulation type for volume.
GetInstancesInstancePlatformConfig
- Is
Measured boolBoot Enabled Whether the Measured Boot is to be enabled on the instance
- Is
Secure boolBoot Enabled Whether the Secure Boot is to be 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).
- Type string
(Required) The type of action to run when the instance is interrupted for eviction.
- Is
Measured boolBoot Enabled Whether the Measured Boot is to be enabled on the instance
- Is
Secure boolBoot Enabled Whether the Secure Boot is to be 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).
- Type string
(Required) The type of action to run when the instance is interrupted for eviction.
- is
Measured BooleanBoot Enabled Whether the Measured Boot is to be enabled on the instance
- is
Secure BooleanBoot Enabled Whether the Secure Boot is to be 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).
- type String
(Required) The type of action to run when the instance is interrupted for eviction.
- is
Measured booleanBoot Enabled Whether the Measured Boot is to be enabled on the instance
- is
Secure booleanBoot Enabled Whether the Secure Boot is to be 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).
- type string
(Required) The type of action to run when the instance is interrupted for eviction.
- is_
measured_ boolboot_ enabled Whether the Measured Boot is to be enabled on the instance
- is_
secure_ boolboot_ enabled Whether the Secure Boot is to be 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).
- type str
(Required) The type of action to run when the instance is interrupted for eviction.
- is
Measured BooleanBoot Enabled Whether the Measured Boot is to be enabled on the instance
- is
Secure BooleanBoot Enabled Whether the Secure Boot is to be 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).
- type String
(Required) The type of action to run when the instance is interrupted for eviction.
GetInstancesInstancePreemptibleInstanceConfig
- Preemption
Actions List<GetInstances Instance Preemptible Instance Config Preemption Action> (Required) The action to run when the preemptible instance is interrupted for eviction.
- Preemption
Actions []GetInstances Instance Preemptible Instance Config Preemption Action (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption
Actions List<GetInstances Instance Preemptible Instance Config Preemption Action> (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption
Actions GetInstances Instance Preemptible Instance Config Preemption Action[] (Required) The action to run when the preemptible instance is interrupted for eviction.
- preemption_
actions GetInstances 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.
GetInstancesInstancePreemptibleInstanceConfigPreemptionAction
- 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.
GetInstancesInstanceShapeConfig
- 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.
- Ocpus double
The total number of OCPUs available to the instance.
- Processor
Description string A short description of the instance's processor (CPU).
- 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.
- Ocpus float64
The total number of OCPUs available to the instance.
- Processor
Description string A short description of the instance's processor (CPU).
- 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.
- ocpus Double
The total number of OCPUs available to the instance.
- processor
Description String A short description of the instance's processor (CPU).
- 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.
- ocpus number
The total number of OCPUs available to the instance.
- processor
Description string A short description of the instance's processor (CPU).
- 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.
- ocpus float
The total number of OCPUs available to the instance.
- processor_
description str A short description of the instance's processor (CPU).
- 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.
- ocpus Number
The total number of OCPUs available to the instance.
- processor
Description String A short description of the instance's processor (CPU).
GetInstancesInstanceSourceDetail
- 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).
- Kms
Key stringId The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- Source
Id string The OCID of an image or a boot volume to use, depending on the value of
source_type
.- 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).
- Kms
Key stringId The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- Source
Id string The OCID of an image or a boot volume to use, depending on the value of
source_type
.- 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).
- kms
Key StringId The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- source
Id String The OCID of an image or a boot volume to use, depending on the value of
source_type
.- 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).
- kms
Key stringId The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- source
Id string The OCID of an image or a boot volume to use, depending on the value of
source_type
.- 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).
- kms_
key_ strid The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- source_
id str The OCID of an image or a boot volume to use, depending on the value of
source_type
.- 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).
- kms
Key StringId The OCID of the Key Management key to assign as the master encryption key for the boot volume.
- source
Id String The OCID of an image or a boot volume to use, depending on the value of
source_type
.- source
Type String The source type for the instance. Use
image
when specifying the image OCID. UsebootVolume
when specifying the boot volume OCID.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.