oci_image_facts - Retrieve details about one or more Compute images in OCI Compute Service

New in version 2.5.

Synopsis

  • This module retrieves details about a specific image, or all images in a specified Compartment in OCI Compute Service.

Requirements

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

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 (either the tenancy or another compartment in the tenancy). Required for retrieving information about all images in a Compartment/Tenancy.
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.
display_name
Use display_name along with the other options to return only resources that match the given display name exactly.
image_id
The OCID of the image. Required for retrieving information about a specific image

aliases: id
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.
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

Examples

- name: Get details of all the images of a specified compartment
  oci_image_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq'

- name: Get details of a specific image
  oci_image_facts:
    id:"ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq"

Return Values

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

Key Returned Description
images
complex
 on success
Information about one or more images

Sample:
{'time-created': '2017-11-16T01:16:41.409000+00:00', 'lifecycle-state': 'AVAILABLE', 'operating-system-version': '7.4', 'base-image-id': None, 'create-image-allowed': True, 'compartment-id': None, 'operating-system': 'Oracle Linux', 'display-name': 'Oracle-Linux-7.4-2017.11.15-0', 'id': 'ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...cmnzlbv2v4q'}
  lifecycle_state
string
 always
The current state of the image.

Sample:
DELETED
  operating_system_version
string
 always
The image's operating system version.

Sample:
7.2
  operating_system
string
 always
The image's operating system.

Sample:
Oracle Linux
  display_name
string
 always
A user-friendly name for the image. It does not have to be unique, and it's changeable.

Sample:
my_custom_image_1
  compartment_id
string
 always
The OCID of the compartment containing the instance that was used as the basis for the image.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx....62xq
  base_image_id
string
 always
The OCID of the image originally used to create the image.

Sample:
ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx....yw2wxfa
  time_created
string
 always
The date and time the image was created, in the format defined by RFC3339

Sample:
2017-11-20 04:52:54.541000
  create_image_allowed
boolean
 always
Whether instances launched with this image can be used to create new images. For example, an image of an Oracle Database instance cannot be created

Sample:
True
  id
string
 always
The OCID of the image.

Sample:
ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx...e4mehv6bv3qca


Status

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

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.