oci_object_facts – Retrieve details of an object or all the objects in a specific namespace and bucket in OCI Object Storage Service

New in version 2.5.

Synopsis

  • This module retrieves details of an object or all the objects present in a specified namespace and bucket in OCI Object Storage Service.

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.
bucket_name
- / required
Name of the bucket from which facts of objects need to be fetched.

aliases: bucket
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
-
    Choices:
  • /
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
-
Object names returned by a list query must be strictly less than this parameter.
fields
string
Object summary in list of objects includes the 'name' field. This parameter can also include 'size' (object size in bytes), 'md5', and 'timeCreated' (object creation date and time) fields. Value of this parameter should be a comma-separated, case-insensitive list of those field names. For example 'name,timeCreated,md5'. Allowed values are "name", "size", "timeCreated", "md5"
list_multipart_uploads
-
Default:
"no"
If list_multipart_uploads=True, all in-progress multipart uploads for the given bucket would be listed.
namespace_name
- / required
Name of the namespace from which facts of objects need to be fetched.

aliases: namespace
object_name
-
Name of the object. Required to fetch details of a specific object.

aliases: object, name
prefix
-
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
-
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
upload_id
-
The upload ID for a multipart upload. When upload_id is specified, all the parts of the specified in-progress multipart upload is listed.

Examples

- name: Get details of all the objects in namespace 'mynamespace' and bucket 'mybucket'
  oci_object_facts:
    namespace: mynamespace
    bucket: mybucket

- name: Get details of all the objects in namespace 'mynamespace' and bucket 'mybucket' and only retrieve name and md5
  oci_object_facts:
    namespace: mynamespace
    bucket: mybucket
    fields: "name,md5"

- name: Get details of a specific object
  oci_object_facts:
    name: mynamespace
    bucket: mybucket
    object: myobject

- name: Get details of all in-progress multipart uploads for the given bucket
  oci_object_facts:
    name: mynamespace
    bucket: mybucket
    list_multipart_uploads: True

- name: Get details of all the parts of an in-progress multipart upload for a specific object
  oci_object_facts:
    name: mynamespace
    bucket: mybucket
    object: myobject
    upload_id: 951f4759-f910-50b4-udf99gf

Return Values

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

Key Returned Description
objects
complex
On success
List of object details

Sample:
[{'md5': '3zBENq6MBnedDrpl2+SttQ==', 'name': 'image2a343.png', 'time_created': '2017-10-09T10:27:53.688000+00:00', 'size': 165661}, {'md5': 'LWX13se0YFa6VVlv0R3hqA==', 'name': 'info1.txt', 'time_created': '2017-10-09T08:39:17.411000+00:00', 'size': 1084}, {'namespace': 'ansible_namespace', 'object': 'ansible_object', 'bucket': 'ansible_bucket', 'upload_id': '3f7c3d1f-15cf-97a6-c6d7-f319', 'time_created': '2018-12-26T13:48:18.326000+00:00'}, {'part_number': 2, 'etag': '7DF108FC90D40327E053821BC20AC918', 'md5': 'J0doWIKY7JfZTrS1IPEGvA==', 'size': 28282272}]
  bucket
integer
multipart uploads listing
The bucket in which the in-progress multipart upload is stored.

Sample:
ansible_bucket
  etag
string
multipart upload parts listing
The current entity tag for the part.

Sample:
7DF108FC90D40327E053821BC20
  md5
string
always
Base64-encoded MD5 hash of the object data

Sample:
3zBENq6MBnedDrpl2+SttQ==
  name
string
always
Name of the object

Sample:
image2a343.png
  namespace
integer
multipart uploads listing
The Object Storage namespace in which the in-progress multipart upload is stored.

Sample:
ansible_namespace
  object
integer
multipart uploads listing
The object name of the in-progress multipart upload.

Sample:
ansible_object
  part_size
integer
multipart upload parts listing
The part number for this part.

Sample:
2
  size
integer
always
Size of the object in bytes

Sample:
165661
  time_created
datetime
always
Date and time of object creation

Sample:
2017-10-09 08:39:17.411000
  upload_id
string
multipart uploads listing
The unique identifier for the in-progress multipart upload.

Sample:
3f7c3d1f-15cf-97a6-c6d7-f31


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.