oci_image_facts – Fetches details about one or multiple Image resources in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • Fetches details about one or multiple Image resources in Oracle Cloud Infrastructure
  • Lists the available images in the specified compartment, including both Oracle-provided images and custom images that have been created. The list of images returned is ordered to first show all Oracle-provided images, then all custom images.
  • The order of images returned may change when new images are released.
  • If image_id is specified, the details of a single Image will be returned.

Requirements

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

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_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
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
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.
Required to list multiple images.
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.
display_name
-
A filter to return only resources that match the given display name exactly.

aliases: name
image_id
-
The OCID of the image.
Required to get a specific image.

aliases: id
lifecycle_state
-
    Choices:
  • PROVISIONING
  • IMPORTING
  • AVAILABLE
  • EXPORTING
  • DISABLED
  • DELETED
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
operating_system
-
The image's operating system.
Example: `Oracle Linux`
operating_system_version
-
The image's operating system version.
Example: `7.2`
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.
shape
-
Shape name.
sort_by
-
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sort_order
-
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
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

Examples

- name: List images
  oci_image_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx

- name: Get a specific image
  oci_image_facts:
    image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx

Return Values

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

Key Returned Description
images
complex
on success
List of Image resources

Sample:
[{'lifecycle_state': 'PROVISIONING', 'operating_system_version': '7.2', 'operating_system': 'Oracle Linux', 'display_name': 'My custom Oracle Linux image', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'base_image_id': 'ocid1.baseimage.oc1..xxxxxxEXAMPLExxxxxx', 'launch_options': {'remote_data_volume_type': 'ISCSI', 'boot_volume_type': 'ISCSI', 'is_consistent_volume_naming_enabled': True, 'firmware': 'BIOS', 'network_type': 'E1000', 'is_pv_encryption_in_transit_enabled': True}, 'agent_features': {'is_monitoring_supported': True}, 'time_created': '2016-08-25T21:10:29.600Z', 'launch_mode': 'NATIVE', 'size_in_mbs': 47694, 'create_image_allowed': True, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]
  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 NIC. * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * `VFIO` - Direct attached Virtual Function network controller. Default for Oracle provided images. * `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
Image size (1 MB = 1048576 bytes)
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


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.