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 availabilityConfig

availabilityConfig: model.LaunchInstanceAvailabilityConfigDetails

availabilityDomain

availabilityDomain: 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 this instance is launched under. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional computeClusterId

computeClusterId: undefined | string

The OCID of the compute cluster that the instance will be created in.

Optional createVnicDetails

createVnicDetails: model.CreateVnicDetails

Optional dedicatedVmHostId

dedicatedVmHostId: undefined | string

The OCID of the dedicated virtual machine host to place the instance 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).

The combined size of the {@code metadata} and {@code extendedMetadata} objects can be a maximum of 32,000 bytes.

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

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}

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

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

Optional hostnameLabel

hostnameLabel: undefined | string

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

Optional imageId

imageId: undefined | string

Deprecated. Use {@code sourceDetails} with {@link #instanceSourceViaImageDetails(InstanceSourceViaImageDetailsRequest) instanceSourceViaImageDetails} source type instead. If you specify values for both, the values must match.

Optional instanceConfigurationId

instanceConfigurationId: undefined | string

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

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.

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 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. The default value is false.

Optional launchOptions

launchOptions: model.LaunchOptions

Optional launchVolumeAttachments

launchVolumeAttachments: Array<LaunchAttachVolumeDetails>

Volume attachments to create as part of the launch instance operation.

Optional metadata

metadata: undefined | object

Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.

A metadata service runs on every launched instance. The service is an HTTP endpoint listening on 169.254.169.254. You can use the service to:

Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks.

Get information about the instance, including the custom metadata that you provide when you launch the instance.

*Providing Cloud-Init Metadata**

You can use the following metadata key names to provide information to Cloud-Init:

*\"ssh_authorized_keys\"** - Provide one or more public SSH keys to be included in the {@code ~/.ssh/authorized_keys} file for the default user on the instance. Use a newline character to separate multiple keys. The SSH keys must be in the format necessary for the {@code authorized_keys} file, as shown in the example below.

*\"user_data\"** - Provide your own base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For information about how to take advantage of user data, see the [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).

*Metadata Example**

\"metadata\" : { \"quake_bot_level\" : \"Severe\", \"ssh_authorized_keys\" : \"ssh-rsa == rsa-key-20160227\", \"user_data\" : \"==\" } **Getting Metadata on the Instance**

To get information about your instance, connect to the instance using SSH and issue any of the following GET requests:

curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/ curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/ curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/

You'll get back a response that includes all the instance information; only the metadata information; or the metadata information for the specified key name, respectively.

The combined size of the {@code metadata} and {@code extendedMetadata} objects can be a maximum of 32,000 bytes.

Optional platformConfig

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

Optional subnetId

subnetId: undefined | string

Deprecated. Instead use {@code subnetId} in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

Functions

getDeserializedJsonObj

getJsonObj