Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LaunchInstanceDetails

Instance launch details. Use the {@code sourceDetails} parameter to specify whether a boot volume or an image should be used to launch a new instance.

Properties

Optional agentConfig

agentConfig: model.LaunchInstanceAgentConfigDetails

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain of the instance.

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

Optional capacityReservationId

capacityReservationId: undefined | string

The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment.

Optional createVnicDetails

createVnicDetails: model.CreateVnicDetails

Optional dedicatedVmHostId

dedicatedVmHostId: undefined | string

The OCID of the dedicated VM host.

Optional definedTags

definedTags: undefined | object

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

Optional displayName

displayName: undefined | string

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

Optional faultDomain

faultDomain: undefined | string

A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets 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.

To get a list of fault domains, use the {@link #listFaultDomains(ListFaultDomainsRequest) listFaultDomains} operation in the Identity and Access Management Service API.

Example: {@code FAULT-DOMAIN-1}

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {@code {"bar-key": "value"}}

Optional hostnameLabel

hostnameLabel: undefined | string

Deprecated. Instead use {@code hostnameLabel} in CreateVnicDetails. If you provide both, the values must match.

Optional instanceOptions

instanceOptions: model.InstanceOptions

Optional ipxeScript

ipxeScript: undefined | string

This is an advanced option.

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.

By default, the 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 in 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 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 type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the 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 isPvEncryptionInTransitEnabled

isPvEncryptionInTransitEnabled: undefined | false | true

Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.

Optional preemptibleInstanceConfig

preemptibleInstanceConfig: model.PreemptibleInstanceConfigDetails

Optional shape

shape: undefined | string

The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.

You can enumerate all available shapes by calling {@link #listShapes(ListShapesRequest) listShapes}.

Optional shapeConfig

shapeConfig: model.LaunchInstanceShapeConfigDetails

Optional sourceDetails

Functions

getDeserializedJsonObj

getJsonObj