oracle.oci.oci_compute_instance_actions – Perform actions on an Instance resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_compute_instance_actions.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Perform actions on an Instance resource in Oracle Cloud Infrastructure
For action=change_compartment, moves an instance into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.
For action=instance_action, performs one of the following power actions on the specified instance:
- START - Powers on the instance.
- STOP - Powers off the instance.
- RESET - Powers off the instance and then powers it back on.
- SOFTSTOP - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.
- SOFTRESET - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.
- SENDDIAGNOSTICINTERRUPT - For advanced users. Caution: Sending a diagnostic interrupt to a live system can cause data corruption or system failure. Sends a diagnostic interrupt that causes the instance’s OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see Sending a Diagnostic Interrupt.
- DIAGNOSTICREBOOT - Powers off the instance, rebuilds it, and then powers it back on. Before you send a diagnostic reboot, restart the instance’s OS, confirm that the instance and networking settings are configured correctly, and try other troubleshooting steps. Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. For more information, see Performing a Diagnostic Reboot.
- REBOOTMIGRATE - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see Infrastructure Maintenance.
For more information about managing instance lifecycle states, see Stopping and Starting an Instance.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
action string / required	Choices: change_compartment stop start softreset reset softstop senddiagnosticinterrupt diagnosticreboot rebootmigrate	The action to perform on the Instance.
action_type string	Choices: reset rebootMigrate softreset	The type of power action to perform. Required for action=instance_action.
allow_dense_reboot_migration boolean	Choices: no yes	For instances that use a DenseIO shape, the flag denoting whether reboot migration is performed for the instance. The default value is `false`. If the instance has a date in the Maintenance reboot field and you do nothing (or set this flag to `false`), the instance will be rebuilt at the scheduled maintenance time. The instance will experience 2-6 hours of downtime during the maintenance process. The local NVMe-based SSD will be preserved. If you want to minimize downtime and can delete the SSD, you can set this flag to `true` and proactively reboot the instance before the scheduled maintenance time. The instance will be reboot migrated to a healthy host and the SSD will be deleted. A short downtime occurs during the migration. Caution: When `true`, the SSD is permanently deleted. We recommend that you create a backup of the SSD before proceeding. Applicable only for action=instance_action. Applicable when action_type is one of ['softreset', 'reset']
api_user string		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_purpose string	Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string	Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle string		The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id string		The OCID of the compartment to move the instance to. Required for action=change_compartment.
config_file_location string		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string		The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
delete_local_storage boolean	Choices: no yes	For bare metal instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect. Applicable only for action=instance_action. Applicable when action_type is 'rebootMigrate'
instance_id string / required		The OCID of the instance. aliases: id
realm_specific_endpoint_template_enabled boolean	Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region string		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy string		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
time_scheduled string		If present, this parameter will set (or reset) the scheduled time that the instance will be reboot migrated in the format defined by RFC3339. This will also change the `timeMaintenanceRebootDue` field on the instance. If not present, the reboot migration will be triggered immediately. Applicable only for action=instance_action. Applicable when action_type is 'rebootMigrate'
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer		Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Perform action change_compartment on instance
  oci_compute_instance_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action stop on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action stop on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action stop on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action start on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action start on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action start on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action softreset on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action softreset on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action softreset on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action reset on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action reset on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action reset on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action softstop on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action softstop on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action softstop on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action senddiagnosticinterrupt on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action senddiagnosticinterrupt on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action senddiagnosticinterrupt on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action diagnosticreboot on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action diagnosticreboot on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action diagnosticreboot on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action rebootmigrate on instance with action_type = reset
  oci_compute_instance_actions:
    # required
    action_type: reset

    # optional
    allow_dense_reboot_migration: true

- name: Perform action rebootmigrate on instance with action_type = rebootMigrate
  oci_compute_instance_actions:
    # required
    action_type: rebootMigrate

    # optional
    delete_local_storage: true
    time_scheduled: time_scheduled_example

- name: Perform action rebootmigrate on instance with action_type = softreset
  oci_compute_instance_actions:
    # required
    action_type: softreset

    # optional
    allow_dense_reboot_migration: true

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key				Returned	Description
instance complex				on success	Details of the Instance resource acted upon by the current operation Sample: {'agent_config': {'are_all_plugins_disabled': True, 'is_management_disabled': True, 'is_monitoring_disabled': True, 'plugins_config': [{'desired_state': 'ENABLED', 'name': 'name_example'}]}, 'availability_config': {'is_live_migration_preferred': True, 'recovery_action': 'RESTORE_INSTANCE'}, 'availability_domain': 'Uocm:PHX-AD-1', 'capacity_reservation_id': 'ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'dedicated_vm_host_id': 'ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'extended_metadata': {}, 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'instance_configuration_id': 'ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx', 'instance_options': {'are_legacy_imds_endpoints_disabled': True}, 'ipxe_script': 'ipxe_script_example', 'is_cross_numa_node': True, 'launch_mode': 'NATIVE', 'launch_options': {'boot_volume_type': 'ISCSI', 'firmware': 'BIOS', 'is_consistent_volume_naming_enabled': True, 'is_pv_encryption_in_transit_enabled': True, 'network_type': 'E1000', 'remote_data_volume_type': 'ISCSI'}, 'lifecycle_state': 'MOVING', 'metadata': {}, 'platform_config': {'are_virtual_instructions_enabled': True, 'is_access_control_service_enabled': True, 'is_input_output_memory_management_unit_enabled': True, 'is_measured_boot_enabled': True, 'is_memory_encryption_enabled': True, 'is_secure_boot_enabled': True, 'is_symmetric_multi_threading_enabled': True, 'is_trusted_platform_module_enabled': True, 'numa_nodes_per_socket': 'NPS0', 'percentage_of_cores_enabled': 56, 'type': 'AMD_MILAN_BM'}, 'preemptible_instance_config': {'preemption_action': {'preserve_boot_volume': True, 'type': 'TERMINATE'}}, 'region': 'us-phoenix-1', 'shape': 'shape_example', 'shape_config': {'baseline_ocpu_utilization': 'BASELINE_1_8', 'gpu_description': 'gpu_description_example', 'gpus': 56, 'local_disk_description': 'local_disk_description_example', 'local_disks': 56, 'local_disks_total_size_in_gbs': 3.4, 'max_vnic_attachments': 56, 'memory_in_gbs': 3.4, 'networking_bandwidth_in_gbps': 3.4, 'ocpus': 3.4, 'processor_description': 'processor_description_example', 'vcpus': 56}, 'source_details': {'boot_volume_id': 'ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx', 'boot_volume_size_in_gbs': 56, 'boot_volume_vpus_per_gb': 56, 'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'instance_source_image_filter_details': {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags_filter': {}, 'operating_system': 'operating_system_example', 'operating_system_version': 'operating_system_version_example'}, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'bootVolume'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_maintenance_reboot_due': '2013-10-20T19:20:30+01:00'}
	agent_config complex			on success
		are_all_plugins_disabled boolean		on success	Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent. Sample: True
		is_management_disabled boolean		on success	Whether Oracle Cloud Agent can run all the available management plugins. These are the management plugins: OS Management Service Agent and Compute Instance Run Command. The management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. - If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of the per-plugin configuration. - If `isManagementDisabled` is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object. Sample: True
		is_monitoring_disabled boolean		on success	Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring. The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. - If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration. - If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object. Sample: True
		plugins_config complex		on success	The configuration of plugins associated with this instance.
			desired_state string	on success	Whether the plugin should be enabled or disabled. To enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false. Sample: ENABLED
			name string	on success	The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent. Sample: name_example
	availability_config complex			on success
		is_live_migration_preferred boolean		on success	Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events. Sample: True
		recovery_action string		on success	The lifecycle state for an instance when it is recovered after infrastructure maintenance. * `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set. * `STOP_INSTANCE` - The instance is recovered in the stopped state. Sample: RESTORE_INSTANCE
	availability_domain string			on success	The availability domain the instance is running in. Example: `Uocm:PHX-AD-1` Sample: Uocm:PHX-AD-1
	capacity_reservation_id string			on success	The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations. Sample: ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
	compartment_id string			on success	The OCID of the compartment that contains the instance. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	dedicated_vm_host_id string			on success	The OCID of the dedicated virtual machine host that the instance is placed on. Sample: ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
	defined_tags dictionary			on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	display_name string			on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: display_name_example
	extended_metadata dictionary			on success	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).
	fault_domain string			on success	The name of the fault domain the instance is running in. 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. Example: `FAULT-DOMAIN-1` Sample: FAULT-DOMAIN-1
	freeform_tags dictionary			on success	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"}` Sample: {'Department': 'Finance'}
	id string			on success	The OCID of the instance. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	image_id string			on success	Deprecated. Use `sourceDetails` instead. Sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
	instance_configuration_id string			on success	The OCID of the Instance Configuration used to source launch details for this instance. Any other fields supplied in the instance launch request override the details stored in the Instance Configuration for this instance launch. Sample: ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx
	instance_options complex			on success
		are_legacy_imds_endpoints_disabled boolean		on success	Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false. Sample: True
	ipxe_script string			on success	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. Sample: ipxe_script_example
	is_cross_numa_node boolean			on success	Whether the instance's OCPUs and memory are distributed across multiple NUMA nodes. Sample: True
	launch_mode string			on success	Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. Sample: NATIVE
	launch_options complex			on success
		boot_volume_type string		on success	Emulation type for the boot volume. * `ISCSI` - ISCSI attached block storage device. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated IDE disk. * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. Sample: ISCSI
		firmware string		on success	Firmware used to boot VM. Select the option that matches your operating system. * `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders. * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. Sample: BIOS
		is_consistent_volume_naming_enabled boolean		on success	Whether to enable consistent volume naming feature. Defaults to false. Sample: True
		is_pv_encryption_in_transit_enabled boolean		on success	Deprecated. Instead use `isPvEncryptionInTransitEnabled` in LaunchInstanceDetails. Sample: True
		network_type string		on success	Emulation type for the physical network interface card (NIC). * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. Sample: E1000
		remote_data_volume_type string		on success	Emulation type for volume. * `ISCSI` - ISCSI attached block storage device. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated IDE disk. * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. Sample: ISCSI
	lifecycle_state string			on success	The current state of the instance. Sample: MOVING
	metadata dictionary			on success	Custom metadata that you provide.
	platform_config complex			on success
		are_virtual_instructions_enabled boolean		on success	Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. Sample: True
		is_access_control_service_enabled boolean		on success	Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through. Sample: True
		is_input_output_memory_management_unit_enabled boolean		on success	Whether the input-output memory management unit is enabled. Sample: True
		is_measured_boot_enabled boolean		on success	Whether the Measured Boot feature is enabled on the instance. Sample: True
		is_memory_encryption_enabled boolean		on success	Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. Sample: True
		is_secure_boot_enabled boolean		on success	Whether Secure Boot is enabled on the instance. Sample: True
		is_symmetric_multi_threading_enabled boolean		on success	Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads. Sample: True
		is_trusted_platform_module_enabled boolean		on success	Whether the Trusted Platform Module (TPM) is enabled on the instance. Sample: True
		numa_nodes_per_socket string		on success	The number of NUMA nodes per socket (NPS). Sample: NPS0
		percentage_of_cores_enabled integer		on success	The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores. If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled. Sample: 56
		type string		on success	The type of platform being configured. Sample: AMD_MILAN_BM
	preemptible_instance_config complex			on success
		preemption_action complex		on success
			preserve_boot_volume boolean	on success	Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified. Sample: True
			type string	on success	The type of action to run when the instance is interrupted for eviction. Sample: TERMINATE
	region string			on success	The region that contains the availability domain the instance is running in. For the us-phoenix-1 and us-ashburn-1 regions, `phx` and `iad` are returned, respectively. For all other regions, the full region name is returned. Examples: `phx`, `eu-frankfurt-1` Sample: us-phoenix-1
	shape string			on success	The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes. Sample: shape_example
	shape_config complex			on success
		baseline_ocpu_utilization string		on success	The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. The following values are supported: - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. - `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance. Sample: BASELINE_1_8
		gpu_description string		on success	A short description of the instance's graphics processing unit (GPU). If the instance does not have any GPUs, this field is `null`. Sample: gpu_description_example
		gpus integer		on success	The number of GPUs available to the instance. Sample: 56
		local_disk_description string		on success	A short description of the local disks available to this instance. If the instance does not have any local disks, this field is `null`. Sample: local_disk_description_example
		local_disks integer		on success	The number of local disks available to the instance. Sample: 56
		local_disks_total_size_in_gbs float		on success	The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is `null`. Sample: 3.4
		max_vnic_attachments integer		on success	The maximum number of VNIC attachments for the instance. Sample: 56
		memory_in_gbs float		on success	The total amount of memory available to the instance, in gigabytes. Sample: 3.4
		networking_bandwidth_in_gbps float		on success	The networking bandwidth available to the instance, in gigabits per second. Sample: 3.4
		ocpus float		on success	The total number of OCPUs available to the instance. Sample: 3.4
		processor_description string		on success	A short description of the instance's processor (CPU). Sample: processor_description_example
		vcpus integer		on success	The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2. Sample: 56
	source_details complex			on success
		boot_volume_id string		on success	The OCID of the boot volume used to boot the instance. Sample: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
		boot_volume_size_in_gbs integer		on success	The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB). Sample: 56
		boot_volume_vpus_per_gb integer		on success	The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information. Allowed values: * `10`: Represents Balanced option. * `20`: Represents Higher Performance option. * `30`-`120`: Represents the Ultra High Performance option. For volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB. Sample: 56
		image_id string		on success	The OCID of the image used to boot the instance. Sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
		instance_source_image_filter_details complex		on success
			compartment_id string	on success	The OCID of the compartment containing images to search Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
			defined_tags_filter dictionary	on success	Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
			operating_system string	on success	The image's operating system. Example: `Oracle Linux` Sample: operating_system_example
			operating_system_version string	on success	The image's operating system version. Example: `7.2` Sample: operating_system_version_example
		kms_key_id string		on success	The OCID of the Vault service key to assign as the master encryption key for the boot volume. Sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
		source_type string		on success	The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. Sample: bootVolume
	system_tags dictionary			on success	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
	time_created string			on success	The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_maintenance_reboot_due string			on success	The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: `2018-05-25T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_compute_instance_actions – Perform actions on an Instance resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶