oracle.oci.oci_compute_image – Manage an Image 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_image
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an Image resource in Oracle Cloud Infrastructure
For state=present, creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see Managing Custom Images.
When importing an exported image from Object Storage, you specify the source information in ImageSourceDetails.
When importing an image based on the namespace, bucket name, and object name, use ImageSourceViaObjectStorageTupleDetails.
When importing an image based on the Object Storage URL, use ImageSourceViaObjectStorageUriDetails. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
For more information about importing exported images, see Image Import/Export.
You may optionally specify a display name for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See UpdateImage. Avoid entering confidential information.
This resource has the following action operations in the oracle.oci.oci_compute_image_actions module: change_compartment, export.
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 | |
---|---|---|---|
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
|
|
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
|
|
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 you want the image to be created in.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
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 . |
||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
||
display_name
string
|
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 a platform image name as a custom image name.
Example: `My Oracle Linux image`
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
force_create
boolean
|
|
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
dictionary
|
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"}`
This parameter is updatable.
|
||
image_id
string
|
The OCID of the image.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
image_source_details
dictionary
|
|||
bucket_name
string
|
The Object Storage bucket for the image.
Required when source_type is 'objectStorageTuple'
|
||
namespace_name
string
|
The Object Storage namespace for the image.
Required when source_type is 'objectStorageTuple'
|
||
object_name
string
|
The Object Storage name for the image.
Required when source_type is 'objectStorageTuple'
|
||
operating_system
string
|
|||
operating_system_version
string
|
|||
source_image_type
string
|
|
The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the OCI image format.
|
|
source_type
string
/ required
|
|
The source type for the image. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL.
|
|
source_uri
string
|
The Object Storage URL for the image.
Required when source_type is 'objectStorageUri'
|
||
instance_id
string
|
The OCID of the instance you want to use as the basis for the image.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
launch_mode
string
|
|
Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * `NATIVE` - VM instances launch with paravirtualized 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.
|
|
operating_system
string
|
Operating system
Example: `Oracle Linux`
This parameter is updatable.
|
||
operating_system_version
string
|
Operating system version
Example: `7.4`
This parameter is updatable.
|
||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
||
state
string
|
|
The state of the Image.
Use state=present to create or update an Image.
Use state=absent to delete an Image.
|
|
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
|
|
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: Create image
oci_compute_image:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
image_source_details:
# required
bucket_name: bucket_name_example
namespace_name: namespace_name_example
object_name: object_name_example
source_type: objectStorageTuple
# optional
operating_system: operating_system_example
operating_system_version: operating_system_version_example
source_image_type: QCOW2
instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
launch_mode: NATIVE
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
- name: Update image
oci_compute_image:
# required
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
operating_system: operating_system_example
operating_system_version: operating_system_version_example
- name: Update image using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_compute_image:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
operating_system: operating_system_example
operating_system_version: operating_system_version_example
- name: Delete image
oci_compute_image:
# required
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete image using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_compute_image:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
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:
{'agent_features': {'is_management_supported': True, 'is_monitoring_supported': True}, 'base_image_id': 'ocid1.baseimage.oc1..xxxxxxEXAMPLExxxxxx', 'billable_size_in_gbs': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'create_image_allowed': True, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', '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': 'PROVISIONING', 'listing_type': 'COMMUNITY', 'operating_system': 'operating_system_example', 'operating_system_version': 'operating_system_version_example', 'size_in_mbs': 56, 'time_created': '2013-10-20T19:20:30+01:00'}
|
||
agent_features
complex
|
on success |
|
||
is_management_supported
boolean
|
on success |
This attribute is not used.
Sample:
True
|
||
is_monitoring_supported
boolean
|
on success |
This attribute is not used.
Sample:
True
|
||
base_image_id
string
|
on success |
The OCID of the image originally used to launch the instance.
Sample:
ocid1.baseimage.oc1..xxxxxxEXAMPLExxxxxx
|
||
billable_size_in_gbs
integer
|
on success |
The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes).
Example: `100`
Sample:
56
|
||
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 a platform image name as a custom image name.
Example: `My custom Oracle Linux image`
Sample:
display_name_example
|
||
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 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 |
Sample:
PROVISIONING
|
||
listing_type
string
|
on success |
The listing type of the image. The default value is "NONE".
Sample:
COMMUNITY
|
||
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
|
||
size_in_mbs
integer
|
on success |
The boot volume size for an instance launched from this image (1 MB = 1,048,576 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:
56
|
||
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:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)