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

aliases: bucket
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.
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
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 objects in namespace 'mynamespace' and bucket 'mybucket'
  oci_object_facts:
    namespace: mynamespace
    bucket: mybucket

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

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}]
  md5
string
 always
Base64-encoded MD5 hash of the object data

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

Sample:
image2a343.png
  time_created
datetime
 always
Date and time of object creation

Sample:
2017-10-09 08:39:17.411000
  size
int
 always
Size of the object in bytes

Sample:
165661


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

  • Rohit Chaware (@rohitChaware)

Hint

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