oci_object – Manage objects in OCI Object Storage Service¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Create, read, update or delete an object in OCI. This module allows the user to store a file as an object in OCI or download an object from OCI to a local file.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
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_type string	Choices: api_key ← instance_principal instance_obo_user	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 in which the object exists. 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`.
content_encoding -		The content encoding of the object to be uploaded.
content_language -		The content language of the object to be uploaded.
content_length -		The content length of the object body to be uploaded.
content_md5 -		The base-64 encoded MD5 hash of the body to be uploaded.
content_type -	Default: "application/octet-stream"	The content type of the object to be uploaded.
dest -		The destination file path when downloading an object. Use with state=present to download an object. This option is mutually exclusive with src.
force boolean	Choices: no yes ←	Force overwriting existing local file when downloading or existing remote object when uploading. aliases: overwrite
multipart_upload -	Default: "yes"	Use multipart_upload=True to use multipart upload feature to upload an large object. Disable multipart upload feature with multipart_upload=False
namespace_name - / required		Name of the namespace in which the object exists. aliases: namespace
object_name - / required		Name of the object. For naming convention, refer https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingobjects.htm#namerequirements. aliases: name, object
opc_client_request_id -		The client request ID for tracing.
opc_meta -		User-defined metadata dict(str,str) for the object to be uploaded. aliases: metadata
parallel_uploads -	Default: "yes"	Use parallel_uploads=True to use parallel upload feature to upload an object. Disable parallel upload feature with parallel_uploads=False. Parallel upload feature works only when multipart_upload=True.
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.
src -		The source file path when uploading an object. Use with state=present to upload an object. This option is mutually exclusive with dest.
state -	Choices: present ← absent abort_multipart_upload	The final state of the object after the task. Use state=absent with object to delete a specific object. Use state=present with dest to download an object. Use state=present with src to upload an object. Use state=abort_multipart_upload with object and upload_id to abort a specific multipart object upload.
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. Use with state=abort_multipart_upload to abort an in-progress multipart upload, and delete all the parts that have been uploaded.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create/upload an object (with multipart and parallel upload)
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: mydata.txt
    src: /usr/local/myfile.txt
    opc_meta: {language: english}

- name: Create/upload an object without multipart and parallel upload
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: mydata.txt
    src: /usr/local/myfile.txt
    opc_meta: {language: english}
    multipart_upload: False
    parallel_uploads: False

- name: Get/download an object to a file
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: key.txt
    dest: /usr/local/new_file.txt

- name: Avoid overwriting an existing file when downloading an object. The task would fail if the local file pointed
        to by I(dest) already exists
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: key.txt
    dest: /usr/local/myfile.txt
    force: false

- name: Abort multipart upload
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: mydata.txt
    upload_id: 951f4759-f910-50b4-udf99gf
    state: 'abort_multipart_upload'

- name: Delete an object
  oci_object:
    namespace: mynamespace
    bucket: mybucket
    object: key.txt
    state: 'absent'

Return Values ¶

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

Key	Returned	Description
object dictionary	On successful operation	OCI object details Sample: {'Date': 'Tue, 10 Oct 2017 13:58:02 GMT', 'Access-Control-Expose-Headers': 'Access-Control-Allow-Credentials,Access-Control-Allow-Methods, Access-Control-Allow-Origin,Content-Length,Content-MD5,Content-Type,ETag,Last-Modified,opc-client-info, opc-meta-author,opc-meta-doc-genre,opc-request-id', 'Access-Control-Allow-Methods': 'POST,PUT,GET,HEAD,DELETE,OPTIONS', 'Connection': 'keep-alive', 'Content-Length': '165661', 'opc-meta-author': 'RC', 'Access-Control-Allow-Origin': '*', 'Access-Control-Allow-Credentials': 'true', 'opc-request-id': '79bcd894-8a9d-fbfe-3717-fd92d518d0a1', 'Last-Modified': 'Tue, 10 Oct 2017 13:57:20 GMT', 'Content-MD5': '3zBENq6MBnedDrpl2+SttQ==', 'ETag': '5B3287C054A51CB6E053824310AC257B', 'Content-Type': 'image/png', 'opc-multipart-md5': 'eoYNSi2Jkc2gMKksGkXOrQ'}

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.

oci_object – Manage objects in OCI Object Storage Service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶