Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Instance

A compute host. The image used to launch the instance determines its operating system and other software. The shape specified during the launch process determines the number of CPUs and memory allocated to the instance.

When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the *primary VNIC*. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

For more information, see [Overview of the Compute Service](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional agentConfig

agentConfig: model.InstanceAgentConfig

Optional availabilityConfig

availabilityConfig: model.InstanceAvailabilityConfig

availabilityDomain

availabilityDomain: string

The availability domain the instance is running in.

Example: {@code Uocm:PHX-AD-1}

Optional capacityReservationId

capacityReservationId: undefined | string

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

compartmentId

compartmentId: string

The OCID of the compartment that contains the instance.

Optional dedicatedVmHostId

dedicatedVmHostId: undefined | string

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

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

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

Optional extendedMetadata

extendedMetadata: undefined | object

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

They are distinguished from {@code metadata} fields in that these can be nested JSON objects (whereas {@code metadata} fields are string/string maps only).

Optional faultDomain

faultDomain: undefined | string

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

A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.

If you do not specify the fault domain, the system selects one for you.

Example: {@code FAULT-DOMAIN-1}

Optional freeformTags

freeformTags: undefined | 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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the instance.

Optional imageId

imageId: undefined | string

Deprecated. Use {@code sourceDetails} instead.

Optional instanceConfigurationId

instanceConfigurationId: undefined | string

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

Optional instanceOptions

instanceOptions: model.InstanceOptions

Optional ipxeScript

ipxeScript: undefined | 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.

If you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.

The default iPXE script connects to the instance's local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance's local boot volume over iSCSI the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.

If your instance boot volume attachment type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume attachment type is paravirtualized and you use custom iPXE to network boot into your instance, the primary boot volume is attached as a data volume through virtio-scsi drive.

For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).

For more information about iPXE, see http://ipxe.org.

Optional isCrossNumaNode

isCrossNumaNode: undefined | false | true

Whether the instance\u2019s OCPUs and memory are distributed across multiple NUMA nodes.

Optional launchMode

launchMode: LaunchMode

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

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

Optional launchOptions

launchOptions: model.LaunchOptions

lifecycleState

lifecycleState: LifecycleState

The current state of the instance.

Optional metadata

metadata: undefined | object

Custom metadata that you provide.

Optional platformConfig

Optional preemptibleInstanceConfig

preemptibleInstanceConfig: model.PreemptibleInstanceConfigDetails

region

region: string

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

For the us-phoenix-1 and us-ashburn-1 regions, {@code phx} and {@code iad} are returned, respectively. For all other regions, the full region name is returned.

Examples: {@code phx}, {@code eu-frankfurt-1}

shape

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 {@link #listShapes(ListShapesRequest) listShapes}.

Optional shapeConfig

shapeConfig: model.InstanceShapeConfig

Optional sourceDetails

Optional systemTags

systemTags: undefined | object

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

timeCreated

timeCreated: Date

The date and time the instance was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeMaintenanceRebootDue

timeMaintenanceRebootDue: Date

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: {@code 2018-05-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Instance): object

getJsonObj