oci_image_actions – Perform actions on an Image resource in Oracle Cloud Infrastructure¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Perform actions on an Image resource in Oracle Cloud Infrastructure
For action=export, exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to. For more information about exporting images, see Image Import/Export. To perform an image export, you need write access to the Object Storage bucket for the image, see Let Users Write Objects to Object Storage Buckets. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.

Requirements ¶

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

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

Parameters ¶

Parameter	Choices/Defaults	Comments
action - / required	Choices: export	The action to perform on the Image.
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_type string	Choices: api_key ← instance_principal instance_obo_user	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.
bucket_name -		The Object Storage bucket to export the image to. Required when destination_type is 'objectStorageTuple'
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`.
destination_type - / required	Choices: objectStorageUri objectStorageTuple	The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL.
destination_uri -		The Object Storage URL to export the image to. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export. Required when destination_type is 'objectStorageUri'
image_id - / required		The OCID of the image. aliases: id
namespace_name -		The Object Storage namespace to export the image to. Required when destination_type is 'objectStorageTuple'
object_name -		The Object Storage object name for the exported image. Required when destination_type is 'objectStorageTuple'
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
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 2000	Time, in seconds, to wait when wait=yes.
wait_until string		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

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 export on image
  oci_image_actions:
    object_name: exported-image.oci
    bucket_name: MyBucket
    namespace_name: MyNamespace
    destination_type: objectStorageTuple
    image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
    action: export

- name: Perform action export on image
  oci_image_actions:
    destination_uri: https://objectstorage.us-phoenix-1.oraclecloud.com/n/MyNamespace/b/MyBucket/o/exported-image.oci
    destination_type: objectStorageUri
    image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
    action: export

Return Values ¶

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

Key			Returned	Description
image complex			on success	Details of the Image resource acted upon by the current operation Sample: {'freeform_tags': {'Department': 'Finance'}, 'launch_options': {'is_pv_encryption_in_transit_enabled': True, 'firmware': 'BIOS', 'remote_data_volume_type': 'ISCSI', 'boot_volume_type': 'ISCSI', 'is_consistent_volume_naming_enabled': True, 'network_type': 'E1000'}, 'lifecycle_state': 'PROVISIONING', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'operating_system': 'Oracle Linux', 'create_image_allowed': True, 'size_in_mbs': 47694, 'launch_mode': 'NATIVE', 'base_image_id': 'ocid1.baseimage.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'My custom Oracle Linux image', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'agent_features': {'is_monitoring_supported': True}, 'operating_system_version': '7.2', 'time_created': '2016-08-25T21:10:29.600Z'}
	agent_features complex		on success
		is_monitoring_supported boolean	on success	Whether the agent running on the instance can gather performance metrics and monitor the instance. Sample: True
	base_image_id string		on success	The OCID of the image originally used to launch the instance. Sample: ocid1.baseimage.oc1..xxxxxxEXAMPLExxxxxx
	compartment_id string		on success	The OCID of the compartment containing the instance you want to use as the basis for the image. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	create_image_allowed boolean		on success	Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: `true` Sample: True
	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 for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. You cannot use an Oracle-provided image name as a custom image name. Example: `My custom Oracle Linux image` Sample: My custom Oracle Linux image
	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 image. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	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 Oracle-provided 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 volume. * `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated IDE disk. * `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images. * `PARAVIRTUALIZED` - Paravirtualized disk. 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 Oracle provided 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	Whether to enable in-transit encryption for the boot volume's paravirtualized attachment. The default value is false. 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. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated IDE disk. * `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images. * `PARAVIRTUALIZED` - Paravirtualized disk. Sample: ISCSI
	lifecycle_state string		on success	Sample: PROVISIONING
	operating_system string		on success	The image's operating system. Example: `Oracle Linux` Sample: Oracle Linux
	operating_system_version string		on success	The image's operating system version. Example: `7.2` Sample: 7.2
	size_in_mbs integer		on success	The boot volume size for an instance launched from this image, (1 MB = 1048576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: `47694` Sample: 47694
	time_created string		on success	The date and time the image was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2016-08-25 21:10:29.600000+00:00

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Manoj Meda (@manojmeda)
Mike Ross (@mross22)
Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

oci_image_actions – Perform actions on an Image resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶