oci_image - Create, import, update and delete OCI Compute images¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

This module allows the user to create an image, import an exported image, update an image and delete OCI Compute Images.

Requirements ¶

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

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

Parameters ¶

Parameter		Choices/Defaults	Comments
api_user			The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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			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			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			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		Choices: api_key ← instance_principal	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.
compartment_id			The OCID of the compartment containing the instance that needs to be used as the basis for the image. Required when an image needs to be created with state=present.
config_file_location			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		Default: DEFAULT	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`.
defined_tags			Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
display_name			A user-friendly name to be associated with the image. This does not have to be unique, and can be changed later. An Oracle-provided image name cannot be used as the name for a custom image's name. aliases: name
force_create bool		Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags			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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
image_id			The OCID of the image. Required while updating an image using state=present, and deleting an existing image using state=absent. aliases: id
image_source_details			Details for creating an image through import. Either `instance_id` or `image_source_details` needs to be specified while creating an image using state=present.
	source_type		The source type for the image. Use 'objectStorageTuple' to get the image from an object in Object Storage and specify `namespace`, `bucket`, and `object`. Use 'objectStorageUri' when specifying an Object Storage URL to get the image, and specify `source_uri`. aliases: destination_type
	source_uri		The Object Storage URL for the image. See Object Storage URLs at https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs and pre-authenticated requests at https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth for constructing URLs for image import/export. Required when creating an image using state=present and the source_type=objectStorageUri under `image_source_details`.
	bucket_name		The Object Storage bucket for the image. Required when creating an image using state=present and the source_type=objectStorageTuple under `image_source_details`. aliases: bucket
	object_name		The Object Storage name for the image. Required when creating an image using state=present and the source_type=objectStorageTuple under `image_source_details`. aliases: object
	namespace_name		The Object Storage namespace for the image. Required when creating an image using state=present and the source_type=objectStorageTuple under `image_source_details`. aliases: namespace
instance_id			The OCID of the instance that needs to be used as the basis for the image. Either `instance_id` or `image_source_details` needs to be specified while creating an image using state=present.
key_by			The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
region			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.
state		Choices: present ← absent	The state of the image that must be asserted to. When state=present, and the image doesn't exist, the image is created with the specified details. When state=absent, the image is deleted. Creation of an image may take longer than the default value of wait_timeout. So if wait=true, during creation of an image, it is recommended to set a longer timeout value of wait_timeout.
tenancy			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 bool		Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout		Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until			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: Create a new image from a specified instance
  oci_image:
    name: my_custom_image_1
    compartment_id: "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq"
    instance_id: "ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx....dszaitd3da"

- name: Create a new image by importing an exported image, where the image is placed in a bucket in Object Storage
        Service
  oci_image:
        name: my_custom_image_2
        compartment_id: "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq"
        image_source_details:
            source_type: "objectStorageTuple"
            bucket: "my_bucket"
            namespace: "my_namespace"
            object: "image-to-import.qcow2"

- name: Create a new image by importing an exported image, where the image is available through an Object Storage
        Service URL
  oci_image:
        name: my_custom_image_3
        compartment_id: "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq"
        image_source_details:
            source_type: "objectStorageUri"
            source_uri: "https://objectstorage.us-phoenix-1.oraclecloud.com/n/my_namespace/b/my_bucket/o/image-to-impor
                        t.qcow2"

- name: Update an image's display name
  oci_image:
        id: "ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq"
        name: my_new_image_name

- name: Delete an image
  oci_image:
        id: "ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq"
        state: "absent"

Return Values ¶

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

Key	Returned	Description
oci_image dict	On success	Details of the image Sample: {'lifecycle_state': 'AVAILABLE', 'operating_system_version': '16.04', 'operating_system': 'Canonical Ubuntu', 'display_name': 'my-image-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx....lwbvm62xq', 'base_image_id': 'ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx....qcsa7klnoa', 'time_created': '2017-11-24T13:18:31.579000+00:00', 'create_image_allowed': True, 'id': 'ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx.....dgb3pmci2q'}

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Sivakumar Thyagarajan (@sivakumart)

Hint

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