oracle.oci.oci_artifacts_container_repository_facts – Fetches details about one or multiple ContainerRepository resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_repository_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ContainerRepository resources in Oracle Cloud Infrastructure
List container repositories in a compartment.
If repository_id is specified, the details of a single ContainerRepository 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_repositories.
|
|
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 |
|
is_public
boolean
|
|
A filter to return resources that match the isPublic value.
|
lifecycle_state
string
|
A filter to return only resources that match the given lifecycle state name exactly.
|
|
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. |
|
repository_id
string
|
The OCID of the container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
Required to get a specific container_repository.
aliases: id |
|
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 |
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_repository
oci_artifacts_container_repository_facts:
# required
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
- name: List container_repositories
oci_artifacts_container_repository_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
compartment_id_in_subtree: true
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
is_public: true
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_repositories
complex
|
on success |
List of ContainerRepository resources
Sample:
[{'billable_size_in_gbs': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_count': 56, 'is_immutable': True, 'is_public': True, 'layer_count': 56, 'layers_size_in_bytes': 56, 'lifecycle_state': 'AVAILABLE', 'namespace': 'namespace_example', 'readme': {'content': 'content_example', 'format': 'TEXT_MARKDOWN'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_pushed': '2013-10-20T19:20:30+01:00'}]
|
||
billable_size_in_gbs
integer
|
on success |
Total storage size in GBs that will be charged.
Sample:
56
|
||
compartment_id
string
|
on success |
The OCID of the compartment in which the container repository exists.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
created_by
string
|
on success |
The id of the user or principal that created the resource.
Returned for get operation
Sample:
created_by_example
|
||
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 |
The container repository name.
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 container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
image_count
integer
|
on success |
Total number of images.
Sample:
56
|
||
is_immutable
boolean
|
on success |
Whether the repository is immutable. Images cannot be overwritten in an immutable repository.
Returned for get operation
Sample:
True
|
||
is_public
boolean
|
on success |
Whether the repository is public. A public repository allows unauthenticated access.
Sample:
True
|
||
layer_count
integer
|
on success |
Total number of layers.
Sample:
56
|
||
layers_size_in_bytes
integer
|
on success |
Total storage in bytes consumed by layers.
Sample:
56
|
||
lifecycle_state
string
|
on success |
The current state of the container repository.
Sample:
AVAILABLE
|
||
namespace
string
|
on success |
The tenancy namespace used in the container repository path.
Sample:
namespace_example
|
||
readme
complex
|
on success |
Returned for get operation
|
||
content
string
|
on success |
Readme content. Avoid entering confidential information.
Sample:
content_example
|
||
format
string
|
on success |
Readme format. Supported formats are text/plain and text/markdown.
Sample:
TEXT_MARKDOWN
|
||
system_tags
dictionary
|
on success |
The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||
time_created
string
|
on success |
An RFC 3339 timestamp indicating when the repository was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_last_pushed
string
|
on success |
An RFC 3339 timestamp indicating when an image was last pushed to the repository.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)