/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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. * */ export interface LaunchInstanceDetails { /** * The availability domain of the instance. *
Example: {@code Uocm:PHX-AD-1} * */ "availabilityDomain": 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](https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). * */ "capacityReservationId"?: string; /** * The OCID of the compartment. */ "compartmentId": string; "createVnicDetails"?: model.CreateVnicDetails; /** * The OCID of the dedicated virtual machine host to place the instance on. * */ "dedicatedVmHostId"?: string; /** * Defined tags for this resource. Each key is predefined and scoped to a * namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * [Security attributes](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels * for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) * (ZPR) policy to control access to ZPR-supported resources. *
Example: {@code {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}} * */ "securityAttributes"?: { [key: string]: { [key: string]: any; }; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * 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. * */ "extendedMetadata"?: { [key: string]: any; }; /** * 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} * */ "faultDomain"?: string; /** * The OCID of the cluster placement group of the instance. */ "clusterPlacementGroupId"?: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no * predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the * [compute cluster](https://docs.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in. * */ "computeClusterId"?: string; /** * Deprecated. Instead use {@code hostnameLabel} in * {@link CreateVnicDetails}. * If you provide both, the values must match. * */ "hostnameLabel"?: string; /** * Deprecated. Use {@code sourceDetails} with {@link #instanceSourceViaImageDetails(InstanceSourceViaImageDetailsRequest) instanceSourceViaImageDetails} * source type instead. If you specify values for both, the values must match. * */ "imageId"?: 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.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm). *
For more information about iPXE, see http://ipxe.org. * */ "ipxeScript"?: string; "launchOptions"?: model.LaunchOptions; "instanceOptions"?: model.InstanceOptions; "availabilityConfig"?: model.LaunchInstanceAvailabilityConfigDetails; "preemptibleInstanceConfig"?: model.PreemptibleInstanceConfigDetails; /** * 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
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.
*
*/
"metadata"?: {
[key: string]: string;
};
"agentConfig"?: model.LaunchInstanceAgentConfigDetails;
/**
* 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}.
*
*/
"shape"?: string;
"shapeConfig"?: model.LaunchInstanceShapeConfigDetails;
"sourceDetails"?: model.InstanceSourceViaImageDetails | model.InstanceSourceViaBootVolumeDetails;
/**
* Deprecated. Instead use {@code subnetId} in
* {@link CreateVnicDetails}.
* At least one of them is required; if you provide both, the values must match.
*
*/
"subnetId"?: string;
/**
* Volume attachments to create as part of the launch instance operation.
*/
"launchVolumeAttachments"?: Array