oracle.oci.oci_artifacts_container_image_facts – Fetches details about one or multiple ContainerImage resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_artifacts_container_image_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ContainerImage resources in Oracle Cloud Infrastructure
List container images in a compartment.
If image_id is specified, the details of a single ContainerImage will be returned.
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.
Required to list multiple container_images.
|
|
compartment_id_in_subtree
boolean
|
|
When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of `accessLevel`. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).
|
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
string
|
A filter to return only resources that match the given display name exactly.
aliases: name |
|
image_id
string
|
The OCID of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`
Required to get a specific container_image.
aliases: id |
|
is_versioned
boolean
|
|
A filter to return container images based on whether there are any associated versions.
|
lifecycle_state
string
|
A filter to return only resources that match the given lifecycle state name exactly.
|
|
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. |
|
repository_id
string
|
A filter to return container images only for the specified container repository OCID.
|
|
repository_name
string
|
A filter to return container images or container image signatures that match the repository name.
Example: `foo` or `foo*`
|
|
sort_by
string
|
|
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
string
|
|
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 |
|
version
string
|
A filter to return container images that match the version.
Example: `foo` or `foo*`
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific container_image
oci_artifacts_container_image_facts:
# required
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
- name: List container_images
oci_artifacts_container_image_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
compartment_id_in_subtree: true
display_name: display_name_example
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
is_versioned: true
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
repository_name: repository_name_example
version: version_example
lifecycle_state: lifecycle_state_example
sort_by: TIMECREATED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
container_images
complex
|
on success |
List of ContainerImage resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'digest': 'digest_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'layers': [{'digest': 'digest_example', 'size_in_bytes': 56, 'time_created': '2013-10-20T19:20:30+01:00'}], 'layers_size_in_bytes': 56, 'lifecycle_state': 'AVAILABLE', 'manifest_size_in_bytes': 56, 'pull_count': 56, 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'repository_name': 'repository_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_pulled': '2013-10-20T19:20:30+01:00', 'version': 'version_example', 'versions': [{'created_by': 'created_by_example', 'time_created': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]}]
|
||
compartment_id
string
|
on success |
The compartment OCID to which the container image belongs. Inferred from the container repository.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
created_by
string
|
on success |
The OCID of the user or principal that created the resource.
Returned for get operation
Sample:
created_by_example
|
||
digest
string
|
on success |
The container image digest.
Sample:
digest_example
|
||
display_name
string
|
on success |
The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version.
Example: `ubuntu:latest` or `ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`
Sample:
display_name_example
|
||
id
string
|
on success |
The OCID of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
layers
complex
|
on success |
Layers of which the image is composed, ordered by the layer digest.
Returned for get operation
|
||
digest
string
|
on success |
The sha256 digest of the image layer.
Sample:
digest_example
|
||
size_in_bytes
integer
|
on success |
The size of the layer in bytes.
Sample:
56
|
||
time_created
string
|
on success |
An RFC 3339 timestamp indicating when the layer was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
layers_size_in_bytes
integer
|
on success |
The total size of the container image layers in bytes.
Returned for get operation
Sample:
56
|
||
lifecycle_state
string
|
on success |
The current state of the container image.
Sample:
AVAILABLE
|
||
manifest_size_in_bytes
integer
|
on success |
The size of the container image manifest in bytes.
Returned for get operation
Sample:
56
|
||
pull_count
integer
|
on success |
Total number of pulls.
Returned for get operation
Sample:
56
|
||
repository_id
string
|
on success |
The OCID of the container repository.
Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
|
||
repository_name
string
|
on success |
The container repository name.
Sample:
repository_name_example
|
||
time_created
string
|
on success |
An RFC 3339 timestamp indicating when the image was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_last_pulled
string
|
on success |
An RFC 3339 timestamp indicating when the image was last pulled.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
||
version
string
|
on success |
The most recent version associated with this image.
Sample:
version_example
|
||
versions
complex
|
on success |
The versions associated with this image.
Returned for get operation
|
||
created_by
string
|
on success |
The OCID of the user or principal that pushed the version.
Sample:
created_by_example
|
||
time_created
string
|
on success |
The creation time of the version.
Sample:
2013-10-20T19:20:30+01:00
|
||
version
string
|
on success |
The version name.
Sample:
version_example
|
Authors¶
Oracle (@oracle)