oracle.oci.oci_object_storage_object_version_facts – Fetches details about one or multiple ObjectVersion resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_object_storage_object_version_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ObjectVersion resources in Oracle Cloud Infrastructure

  • Lists the object versions in a bucket.

  • ListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through more object versions, use the returned opc-next-page value with the page request parameter.

  • To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

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_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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_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.
bucket_name
string / required
The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
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.
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.
delimiter
string
When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end
string
Object names returned by a list query must be strictly less than this parameter.
fields
string
Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
name
string
Use name along with the other options to return only resources that match the given name exactly.
namespace_name
string / required
The Object Storage namespace used for the request.
prefix
string
The string to use for matching against the start of object names in a list query.
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.
start
string
Object names returned by a list query must be greater or equal to this parameter.
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 object_versions
  oci_object_storage_object_version_facts:
    # required
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example

    # optional
    prefix: prefix_example
    start: start_example
    end: end_example
    delimiter: delimiter_example
    fields: fields_example

Return Values

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

Key Returned Description
object_versions
complex
on success
List of ObjectVersion resources

Sample:
[{'archival_state': 'Archived', 'etag': 'etag_example', 'is_delete_marker': True, 'md5': 'md5_example', 'name': 'name_example', 'size': 56, 'storage_tier': 'Standard', 'time_created': '2013-10-20T19:20:30+01:00', 'time_modified': '2013-10-20T19:20:30+01:00', 'version_id': 'ocid1.version.oc1..xxxxxxEXAMPLExxxxxx'}]
 
archival_state
string
on success
Archival state of an object. This field is set only for objects in Archive tier.

Sample:
Archived
 
etag
string
on success
The current entity tag (ETag) for the object.

Sample:
etag_example
 
is_delete_marker
boolean
on success
This flag will indicate if the version is deleted or not.

Sample:
True
 
md5
string
on success
Base64-encoded MD5 hash of the object data.

Sample:
md5_example
 
name
string
on success
The name of the object. Avoid entering confidential information. Example: test/object1.log

Sample:
name_example
 
size
integer
on success
Size of the object in bytes.

Sample:
56
 
storage_tier
string
on success
The storage tier that the object is stored in.

Sample:
Standard
 
time_created
string
on success
The date and time the object was created, as described in RFC 2616.

Sample:
2013-10-20T19:20:30+01:00
 
time_modified
string
on success
The date and time the object was modified, as described in RFC 2616.

Sample:
2013-10-20T19:20:30+01:00
 
version_id
string
on success
VersionId of the object.

Sample:
ocid1.version.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)