Class LaunchInstanceDetails

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

Inheritance

object

LaunchInstanceDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class LaunchInstanceDetails

Properties

AgentConfig

Declaration

[JsonProperty(PropertyName = "agentConfig")]
public LaunchInstanceAgentConfigDetails AgentConfig { get; set; }

Property Value

Type	Description
LaunchInstanceAgentConfigDetails

AvailabilityConfig

Declaration

[JsonProperty(PropertyName = "availabilityConfig")]
public LaunchInstanceAvailabilityConfigDetails AvailabilityConfig { get; set; }

Property Value

Type	Description
LaunchInstanceAvailabilityConfigDetails

AvailabilityDomain

Declaration

[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The availability domain of the instance. Example: Uocm:PHX-AD-1

Remarks

Required

CapacityReservationId

Declaration

[JsonProperty(PropertyName = "capacityReservationId")]
public string CapacityReservationId { get; set; }

Property Value

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

ClusterPlacementGroupId

Declaration

[JsonProperty(PropertyName = "clusterPlacementGroupId")]
public string ClusterPlacementGroupId { get; set; }

Property Value

Type	Description
string	The OCID of the cluster placement group of the instance.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

ComputeClusterId

Declaration

[JsonProperty(PropertyName = "computeClusterId")]
public string ComputeClusterId { get; set; }

Property Value

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

ComputeHostGroupId

Declaration

[JsonProperty(PropertyName = "computeHostGroupId")]
public string ComputeHostGroupId { get; set; }

Property Value

Type	Description
string	The OCID of the compute host group attached to the host where the bare metal instance will be launched.

CreateVnicDetails

Declaration

[JsonProperty(PropertyName = "createVnicDetails")]
public CreateVnicDetails CreateVnicDetails { get; set; }

Property Value

Type	Description
CreateVnicDetails

DedicatedVmHostId

Declaration

[JsonProperty(PropertyName = "dedicatedVmHostId")]
public string DedicatedVmHostId { get; set; }

Property Value

Type	Description
string	The OCID of the dedicated virtual machine host to place the instance on.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

ExtendedMetadata

Declaration

[JsonProperty(PropertyName = "extendedMetadata")]
public Dictionary<string, object> ExtendedMetadata { get; set; }

Property Value

Type	Description
Dictionary<string, object>	Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only). The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes.

FaultDomain

Declaration

[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }

Property Value

Type	Description
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: FAULT-DOMAIN-1

Type

Description

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: FAULT-DOMAIN-1

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, 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. Example: {"Department": "Finance"}

HostnameLabel

Declaration

[JsonProperty(PropertyName = "hostnameLabel")]
public string HostnameLabel { get; set; }

Property Value

Type	Description
string	Deprecated. Instead use `hostnameLabel` in {@link CreateVnicDetails}. If you provide both, the values must match.

ImageId

Declaration

[JsonProperty(PropertyName = "imageId")]
public string ImageId { get; set; }

Property Value

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

InstanceConfigurationId

Declaration

[JsonProperty(PropertyName = "instanceConfigurationId")]
public string InstanceConfigurationId { get; set; }

Property Value

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

InstanceOptions

Declaration

[JsonProperty(PropertyName = "instanceOptions")]
public InstanceOptions InstanceOptions { get; set; }

Property Value

Type	Description
InstanceOptions

IpxeScript

Declaration

[JsonProperty(PropertyName = "ipxeScript")]
public string IpxeScript { get; set; }

Property Value

Type	Description
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. For more information about iPXE, see http://ipxe.org.

Type

Description

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.
For more information about iPXE, see http://ipxe.org.

IsPvEncryptionInTransitEnabled

Declaration

[JsonProperty(PropertyName = "isPvEncryptionInTransitEnabled")]
public bool? IsPvEncryptionInTransitEnabled { get; set; }

Property Value

Type	Description
bool?	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.

LaunchOptions

Declaration

[JsonProperty(PropertyName = "launchOptions")]
public LaunchOptions LaunchOptions { get; set; }

Property Value

Type	Description
LaunchOptions

LaunchVolumeAttachments

Declaration

[JsonProperty(PropertyName = "launchVolumeAttachments")]
public List<LaunchAttachVolumeDetails> LaunchVolumeAttachments { get; set; }

Property Value

Type	Description
List<LaunchAttachVolumeDetails>	Volume attachments to create as part of the launch instance operation.

LicensingConfigs

Declaration

[JsonProperty(PropertyName = "licensingConfigs")]
public List<LaunchInstanceLicensingConfig> LicensingConfigs { get; set; }

Property Value

Type	Description
List<LaunchInstanceLicensingConfig>	List of licensing configurations associated with target launch values.

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public Dictionary<string, string> Metadata { get; set; }

Property Value

Type	Description
Dictionary<string, string>

PlacementConstraintDetails

Declaration

[JsonProperty(PropertyName = "placementConstraintDetails")]
public PlacementConstraintDetails PlacementConstraintDetails { get; set; }

Property Value

Type	Description
PlacementConstraintDetails

PlatformConfig

Declaration

[JsonProperty(PropertyName = "platformConfig")]
public LaunchInstancePlatformConfig PlatformConfig { get; set; }

Property Value

Type	Description
LaunchInstancePlatformConfig

PreemptibleInstanceConfig

Declaration

[JsonProperty(PropertyName = "preemptibleInstanceConfig")]
public PreemptibleInstanceConfigDetails PreemptibleInstanceConfig { get; set; }

Property Value

Type	Description
PreemptibleInstanceConfigDetails

SecurityAttributes

Declaration

[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}

Shape

Declaration

[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }

Property Value

Type	Description
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}.

ShapeConfig

Declaration

[JsonProperty(PropertyName = "shapeConfig")]
public LaunchInstanceShapeConfigDetails ShapeConfig { get; set; }

Property Value

Type	Description
LaunchInstanceShapeConfigDetails

SourceDetails

Declaration

[JsonProperty(PropertyName = "sourceDetails")]
public InstanceSourceDetails SourceDetails { get; set; }

Property Value

Type	Description
InstanceSourceDetails

SubnetId

Declaration

[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

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