/** * 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 for creating an instance from an instance configuration. Use the {@code sourceDetails} * parameter to specify whether a boot volume or an image should be used to launch a new instance. *

See {@link LaunchInstanceDetails} for more information. * */ export interface InstanceConfigurationLaunchInstanceDetails { /** * 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. */ "capacityReservationId"?: string; /** * Whether to enable AI enterprise on the instance. * */ "isAIEnterpriseEnabled"?: boolean; "placementConstraintDetails"?: model.InstanceConfigurationHostGroupPlacementConstraintDetails; /** * 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; /** * The OCID of the compartment containing the instance. * Instances created from instance configurations are placed in the same compartment * as the instance that was used to create the instance configuration. * */ "compartmentId"?: string; /** * The OCID of the cluster placement group of the instance. */ "clusterPlacementGroupId"?: string; "createVnicDetails"?: model.InstanceConfigurationCreateVnicDetails; /** * 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; }; /** * 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; }; /** * 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; * however, you should 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, you should use the * following iSCSI IP address: 169.254.0.2, and boot volume IQN: * iqn.2015-02.oracle.boot. *

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; /** * 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. * */ "metadata"?: { [key: string]: 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}. * */ "shape"?: string; "shapeConfig"?: model.InstanceConfigurationLaunchInstanceShapeConfigDetails; "platformConfig"?: model.InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig | model.InstanceConfigurationIntelVmLaunchInstancePlatformConfig | model.InstanceConfigurationAmdMilanBmGpuLaunchInstancePlatformConfig | model.InstanceConfigurationIntelIcelakeBmLaunchInstancePlatformConfig | model.InstanceConfigurationGenericBmLaunchInstancePlatformConfig | model.InstanceConfigurationAmdRomeBmLaunchInstancePlatformConfig | model.InstanceConfigurationIntelSkylakeBmLaunchInstancePlatformConfig | model.InstanceConfigurationAmdRomeBmGpuLaunchInstancePlatformConfig | model.InstanceConfigurationAmdVmLaunchInstancePlatformConfig; "sourceDetails"?: model.InstanceConfigurationInstanceSourceViaImageDetails | model.InstanceConfigurationInstanceSourceViaBootVolumeDetails; /** * 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 dedicated virtual machine host to place the instance on. *

Dedicated VM hosts can be used when launching individual instances from an instance configuration. They * cannot be used to launch instance pools. * */ "dedicatedVmHostId"?: string; /** * 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 ACCELERATEDPV} - VM instances launch with accelerated paravirtualized networking type. * * {@code CUSTOM} - VM instances launch with custom configuration settings specified in the {@code LaunchOptions} parameter. * */ "launchMode"?: InstanceConfigurationLaunchInstanceDetails.LaunchMode; "launchOptions"?: model.InstanceConfigurationLaunchOptions; "agentConfig"?: model.InstanceConfigurationLaunchInstanceAgentConfigDetails; /** * Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. */ "isPvEncryptionInTransitEnabled"?: boolean; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * {@code LIVE_MIGRATE} - Run maintenance using a live migration. * * {@code REBOOT} - Run maintenance using a reboot. * */ "preferredMaintenanceAction"?: InstanceConfigurationLaunchInstanceDetails.PreferredMaintenanceAction; "instanceOptions"?: model.InstanceConfigurationInstanceOptions; "availabilityConfig"?: model.InstanceConfigurationAvailabilityConfig; "preemptibleInstanceConfig"?: model.PreemptibleInstanceConfigDetails; /** * List of licensing configurations associated with target launch values. */ "licensingConfigs"?: Array; } export declare namespace InstanceConfigurationLaunchInstanceDetails { enum LaunchMode { Native = "NATIVE", Emulated = "EMULATED", Paravirtualized = "PARAVIRTUALIZED", Acceleratedpv = "ACCELERATEDPV", Custom = "CUSTOM", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum PreferredMaintenanceAction { LiveMigrate = "LIVE_MIGRATE", Reboot = "REBOOT", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: InstanceConfigurationLaunchInstanceDetails): object; function getDeserializedJsonObj(obj: InstanceConfigurationLaunchInstanceDetails): object; }