LaunchInstanceDetails¶

class oci.cloud_migrations.models.LaunchInstanceDetails(**kwargs)¶

Bases: object

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

Methods:

__init__(**kwargs)

Initializes a new LaunchInstanceDetails object with values from keyword arguments.

Attributes:

`agent_config`	Gets the agent_config of this LaunchInstanceDetails.
`availability_domain`	Gets the availability_domain of this LaunchInstanceDetails.
`capacity_reservation_id`	Gets the capacity_reservation_id of this LaunchInstanceDetails.
`compartment_id`	Gets the compartment_id of this LaunchInstanceDetails.
`create_vnic_details`	Gets the create_vnic_details of this LaunchInstanceDetails.
`dedicated_vm_host_id`	Gets the dedicated_vm_host_id of this LaunchInstanceDetails.
`defined_tags`	Gets the defined_tags of this LaunchInstanceDetails.
`display_name`	Gets the display_name of this LaunchInstanceDetails.
`fault_domain`	Gets the fault_domain of this LaunchInstanceDetails.
`freeform_tags`	Gets the freeform_tags of this LaunchInstanceDetails.
`hostname_label`	Gets the hostname_label of this LaunchInstanceDetails.
`instance_options`	Gets the instance_options of this LaunchInstanceDetails.
`ipxe_script`	Gets the ipxe_script of this LaunchInstanceDetails.
`is_pv_encryption_in_transit_enabled`	Gets the is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
`preemptible_instance_config`	Gets the preemptible_instance_config of this LaunchInstanceDetails.
`shape`	Gets the shape of this LaunchInstanceDetails.
`shape_config`	Gets the shape_config of this LaunchInstanceDetails.
`source_details`	Gets the source_details of this LaunchInstanceDetails.

__init__(**kwargs)¶

Initializes a new LaunchInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

availability_domain (str) – The value to assign to the availability_domain property of this LaunchInstanceDetails.
capacity_reservation_id (str) – The value to assign to the capacity_reservation_id property of this LaunchInstanceDetails.
compartment_id (str) – The value to assign to the compartment_id property of this LaunchInstanceDetails.
create_vnic_details (oci.cloud_migrations.models.CreateVnicDetails) – The value to assign to the create_vnic_details property of this LaunchInstanceDetails.
dedicated_vm_host_id (str) – The value to assign to the dedicated_vm_host_id property of this LaunchInstanceDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LaunchInstanceDetails.
display_name (str) – The value to assign to the display_name property of this LaunchInstanceDetails.
fault_domain (str) – The value to assign to the fault_domain property of this LaunchInstanceDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LaunchInstanceDetails.
hostname_label (str) – The value to assign to the hostname_label property of this LaunchInstanceDetails.
ipxe_script (str) – The value to assign to the ipxe_script property of this LaunchInstanceDetails.
instance_options (oci.cloud_migrations.models.InstanceOptions) – The value to assign to the instance_options property of this LaunchInstanceDetails.
preemptible_instance_config (oci.cloud_migrations.models.PreemptibleInstanceConfigDetails) – The value to assign to the preemptible_instance_config property of this LaunchInstanceDetails.
agent_config (oci.cloud_migrations.models.LaunchInstanceAgentConfigDetails) – The value to assign to the agent_config property of this LaunchInstanceDetails.
shape (str) – The value to assign to the shape property of this LaunchInstanceDetails.
shape_config (oci.cloud_migrations.models.LaunchInstanceShapeConfigDetails) – The value to assign to the shape_config property of this LaunchInstanceDetails.
source_details (oci.cloud_migrations.models.InstanceSourceDetails) – The value to assign to the source_details property of this LaunchInstanceDetails.
is_pv_encryption_in_transit_enabled (bool) – The value to assign to the is_pv_encryption_in_transit_enabled property of this LaunchInstanceDetails.

property agent_config¶

Gets the agent_config of this LaunchInstanceDetails.

Returns: The agent_config of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.LaunchInstanceAgentConfigDetails

property availability_domain¶

Gets the availability_domain of this LaunchInstanceDetails. The availability domain of the instance.

Example: Uocm:PHX-AD-1

Returns: The availability_domain of this LaunchInstanceDetails.
Return type: str

property capacity_reservation_id¶

Gets the capacity_reservation_id of this LaunchInstanceDetails. 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.

Returns: The capacity_reservation_id of this LaunchInstanceDetails.
Return type: str

property compartment_id¶

Gets the compartment_id of this LaunchInstanceDetails. The OCID of the compartment.

Returns: The compartment_id of this LaunchInstanceDetails.
Return type: str

property create_vnic_details¶

Gets the create_vnic_details of this LaunchInstanceDetails.

Returns: The create_vnic_details of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.CreateVnicDetails

property dedicated_vm_host_id¶

Gets the dedicated_vm_host_id of this LaunchInstanceDetails. The OCID of the dedicated VM host.

Returns: The dedicated_vm_host_id of this LaunchInstanceDetails.
Return type: str

property defined_tags¶

Gets the defined_tags of this LaunchInstanceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns: The defined_tags of this LaunchInstanceDetails.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this LaunchInstanceDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns: The display_name of this LaunchInstanceDetails.
Return type: str

property fault_domain¶

Gets the fault_domain of this LaunchInstanceDetails. 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 list_fault_domains() operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns: The fault_domain of this LaunchInstanceDetails.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this LaunchInstanceDetails. Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {“bar-key”: “value”}

Returns: The freeform_tags of this LaunchInstanceDetails.
Return type: dict(str, str)

property hostname_label¶

Gets the hostname_label of this LaunchInstanceDetails. Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

Returns: The hostname_label of this LaunchInstanceDetails.
Return type: str

property instance_options¶

Gets the instance_options of this LaunchInstanceDetails.

Returns: The instance_options of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.InstanceOptions

property ipxe_script¶

Gets the ipxe_script of this LaunchInstanceDetails. 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.

Returns: The ipxe_script of this LaunchInstanceDetails.
Return type: str

property is_pv_encryption_in_transit_enabled¶

Gets the is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails. 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.

Returns: The is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
Return type: bool

property preemptible_instance_config¶

Gets the preemptible_instance_config of this LaunchInstanceDetails.

Returns: The preemptible_instance_config of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.PreemptibleInstanceConfigDetails

property shape¶

Gets the shape of this LaunchInstanceDetails. 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 list_shapes().

Returns: The shape of this LaunchInstanceDetails.
Return type: str

property shape_config¶

Gets the shape_config of this LaunchInstanceDetails.

Returns: The shape_config of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.LaunchInstanceShapeConfigDetails

property source_details¶

Gets the source_details of this LaunchInstanceDetails.

Returns: The source_details of this LaunchInstanceDetails.
Return type: oci.cloud_migrations.models.InstanceSourceDetails