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
LaunchInstanceDetails
Assembly: OCI.DotNetSDK.Cloudmigrations.dll
Syntax
public class LaunchInstanceDetails
Properties
AgentConfig
Declaration
[JsonProperty(PropertyName = "agentConfig")]
public LaunchInstanceAgentConfigDetails AgentConfig { get; set; }
Property Value
AvailabilityDomain
Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type |
Description |
string |
The availability domain of the instance.
Example: Uocm:PHX-AD-1
|
CapacityReservationId
Declaration
[JsonProperty(PropertyName = "capacityReservationId")]
public string CapacityReservationId { get; set; }
Property Value
Type |
Description |
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.
|
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the compartment.
|
CreateVnicDetails
Declaration
[JsonProperty(PropertyName = "createVnicDetails")]
public CreateVnicDetails CreateVnicDetails { get; set; }
Property Value
DedicatedVmHostId
Declaration
[JsonProperty(PropertyName = "dedicatedVmHostId")]
public string DedicatedVmHostId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the dedicated VM host.
|
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.
Example: {"foo-namespace": {"bar-key": "value"}}
|
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.
|
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 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: FAULT-DOMAIN-1
|
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type |
Description |
Dictionary<string, string> |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility.
Example: {"bar-key": "value"}
|
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.
|
InstanceOptions
Declaration
[JsonProperty(PropertyName = "instanceOptions")]
public InstanceOptions InstanceOptions { get; set; }
Property Value
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.
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.
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. By default, the value is false.
|
PreemptibleInstanceConfig
Declaration
[JsonProperty(PropertyName = "preemptibleInstanceConfig")]
public PreemptibleInstanceConfigDetails PreemptibleInstanceConfig { get; set; }
Property Value
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
SourceDetails
Declaration
[JsonProperty(PropertyName = "sourceDetails")]
public InstanceSourceDetails SourceDetails { get; set; }
Property Value