.. Document meta

:orphan:

.. Anchors

.. _ansible_collections.opentelekomcloud.cloud.object_info_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

opentelekomcloud.cloud.object_info -- Get Swift info.
+++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This plugin is part of the `opentelekomcloud.cloud collection <https://galaxy.ansible.com/opentelekomcloud/cloud>`_ (version 0.9.0).

    To install it use: :code:`ansible-galaxy collection install opentelekomcloud.cloud`.

    To use it in a playbook, specify: :code:`opentelekomcloud.cloud.object_info`.

.. version_added

.. versionadded:: 0.8.0 of opentelekomcloud.cloud

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Get Swift containers, container object, object metadata info from the OTC.


.. Aliases


.. Requirements

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

- openstacksdk
- openstacksdk >= 0.36.0
- otcextensions
- python >= 3.6


.. Options

Parameters
----------

.. raw:: html

    <table  border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Parameter</th>
            <th>Choices/<font color="blue">Defaults</font></th>
                        <th width="100%">Comments</th>
        </tr>
                    <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-api_timeout"></div>
                    <b>api_timeout</b>
                    <a class="ansibleOptionLink" href="#parameter-api_timeout" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">integer</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-auth"></div>
                    <b>auth</b>
                    <a class="ansibleOptionLink" href="#parameter-auth" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">dictionary</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Dictionary containing auth information as needed by the cloud&#x27;s auth plugin strategy. For the default <em>password</em> plugin, this would contain <em>auth_url</em>, <em>username</em>, <em>password</em>, <em>project_name</em> and any information about domains (for example, <em>os_user_domain_name</em> or <em>os_project_domain_name</em>) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-auth_type"></div>
                    <b>auth_type</b>
                    <a class="ansibleOptionLink" href="#parameter-auth_type" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the <em>auth</em> parameter should be updated accordingly.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-ca_cert"></div>
                    <b>ca_cert</b>
                    <a class="ansibleOptionLink" href="#parameter-ca_cert" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a CA Cert bundle that can be used as part of verifying SSL API requests.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: cacert</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-client_cert"></div>
                    <b>client_cert</b>
                    <a class="ansibleOptionLink" href="#parameter-client_cert" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a client certificate to use as part of the SSL transaction.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: cert</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-client_key"></div>
                    <b>client_key</b>
                    <a class="ansibleOptionLink" href="#parameter-client_key" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a client key to use as part of the SSL transaction.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: key</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-cloud"></div>
                    <b>cloud</b>
                    <a class="ansibleOptionLink" href="#parameter-cloud" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Named cloud or cloud config to operate against. If <em>cloud</em> is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for <em>auth</em> and <em>auth_type</em>. This parameter is not needed if <em>auth</em> is provided or if OpenStack OS_* environment variables are present. If <em>cloud</em> is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-container"></div>
                    <b>container</b>
                    <a class="ansibleOptionLink" href="#parameter-container" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Name of container in Swift.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-interface"></div>
                    <b>interface</b>
                    <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                            <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li>admin</li>
                                                                                                                                                                                                <li>internal</li>
                                                                                                                                                                                                <li><div style="color: blue"><b>public</b>&nbsp;&larr;</div></li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Endpoint URL type to fetch from the service catalog.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: endpoint_type</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-object_name"></div>
                    <b>object_name</b>
                    <a class="ansibleOptionLink" href="#parameter-object_name" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Name of object in Swift.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-region_name"></div>
                    <b>region_name</b>
                    <a class="ansibleOptionLink" href="#parameter-region_name" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Name of the region.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-timeout"></div>
                    <b>timeout</b>
                    <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">integer</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                    <b>Default:</b><br/><div style="color: blue">180</div>
                                    </td>
                                                                <td>
                                            <div>How long should ansible wait for the requested resource.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
                    <b>validate_certs</b>
                    <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">boolean</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                                                                    <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
                                                                                                                                                                                                <li>yes</li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Whether or not SSL API requests should be verified.</div>
                                            <div>Before Ansible 2.3 this defaulted to <code>yes</code>.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: verify</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-wait"></div>
                    <b>wait</b>
                    <a class="ansibleOptionLink" href="#parameter-wait" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">boolean</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                                                                    <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li>no</li>
                                                                                                                                                                                                <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Should ansible wait until the requested resource is complete.</div>
                                                        </td>
            </tr>
                        </table>
    <br/>

.. Notes

Notes
-----

.. note::
   - The standard OpenStack environment variables, such as ``OS_USERNAME`` may be used instead of providing explicit values.
   - Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    # Get swift containers/objects/object content.
    - opentelekomcloud.cloud.object_info:
      register: sw

    - opentelekomcloud.cloud.object_info:
        container: my_container
      register: sw

    - opentelekomcloud.cloud.object_info:
        container: my_container
        object_name: my_object
      register: sw




.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="2">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
                    <tr>
                                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="return-swift"></div>
                    <b>swift</b>
                    <a class="ansibleOptionLink" href="#return-swift" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">complex</span>
                                          </div>
                                    </td>
                <td>On Success.</td>
                <td>
                                            <div>List of dictionaries describing containers, objects and object metadata in container.</div>
                                        <br/>
                                    </td>
            </tr>
                                        <tr>
                                    <td class="elbow-placeholder">&nbsp;</td>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-swift/containers"></div>
                    <b>containers</b>
                    <a class="ansibleOptionLink" href="#return-swift/containers" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                       / <span style="color: purple">elements=string</span>                    </div>
                                    </td>
                <td>success</td>
                <td>
                                            <div>Specifies the list of available containers. Shows when no params passed.</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{&#x27;bytes&#x27;: 5449, &#x27;bytes_used&#x27;: 5449, &#x27;content_type&#x27;: None, &#x27;count&#x27;: 1, &#x27;id&#x27;: &#x27;otc&#x27;, &#x27;if_none_match&#x27;: None, &#x27;is_content_type_detected&#x27;: None, &#x27;is_newest&#x27;: None, &#x27;meta_temp_url_key&#x27;: None, &#x27;meta_temp_url_key_2&#x27;: None, &#x27;name&#x27;: &#x27;otc&#x27;, &#x27;object_count&#x27;: 1, &#x27;read_ACL&#x27;: None, &#x27;sync_key&#x27;: None, &#x27;sync_to&#x27;: None, &#x27;timestamp&#x27;: None, &#x27;versions_location&#x27;: None, &#x27;write_ACL&#x27;: None}]</div>
                                    </td>
            </tr>
                                <tr>
                                    <td class="elbow-placeholder">&nbsp;</td>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-swift/metadata"></div>
                    <b>metadata</b>
                    <a class="ansibleOptionLink" href="#return-swift/metadata" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">dictionary</span>
                                          </div>
                                    </td>
                <td>success</td>
                <td>
                                            <div>Specifies the object metadata. Shows when container and object_name params is not Null</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{&#x27;_bytes&#x27;: None, &#x27;_content_type&#x27;: None, &#x27;_hash&#x27;: None, &#x27;_last_modified&#x27;: None, &#x27;accept_ranges&#x27;: &#x27;bytes&#x27;, &#x27;container&#x27;: &#x27;test&#x27;, &#x27;content_disposition&#x27;: None, &#x27;content_encoding&#x27;: None, &#x27;content_length&#x27;: 5, &#x27;content_type&#x27;: &#x27;text/plain&#x27;, &#x27;copy_from&#x27;: None, &#x27;delete_after&#x27;: None, &#x27;delete_at&#x27;: None, &#x27;etag&#x27;: &#x27;e1cbb0c3879af8347246f12c559a86b5&#x27;, &#x27;expires_at&#x27;: None, &#x27;id&#x27;: &#x27;my2.txt&#x27;, &#x27;if_match&#x27;: None, &#x27;if_modified_since&#x27;: None, &#x27;if_none_match&#x27;: None, &#x27;if_unmodified_since&#x27;: None, &#x27;is_content_type_detected&#x27;: None, &#x27;is_newest&#x27;: None, &#x27;is_static_large_object&#x27;: None, &#x27;last_modified_at&#x27;: &#x27;Thu, 18 Feb 2021 13:40:09 GMT&#x27;, &#x27;multipart_manifest&#x27;: None, &#x27;name&#x27;: None, &#x27;object_manifest&#x27;: None, &#x27;range&#x27;: None, &#x27;signature&#x27;: None, &#x27;timestamp&#x27;: &#x27;1613655609.64076&#x27;, &#x27;transfer_encoding&#x27;: None}</div>
                                    </td>
            </tr>
                                <tr>
                                    <td class="elbow-placeholder">&nbsp;</td>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-swift/objects"></div>
                    <b>objects</b>
                    <a class="ansibleOptionLink" href="#return-swift/objects" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                       / <span style="color: purple">elements=string</span>                    </div>
                                    </td>
                <td>success</td>
                <td>
                                            <div>Specifies the list of objects in container. Shows when container param is not Null</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{&#x27;_bytes&#x27;: 273, &#x27;_content_type&#x27;: &#x27;text/plain&#x27;, &#x27;_hash&#x27;: &#x27;58c6362a0e013dae97594abe7b06d801&#x27;, &#x27;_last_modified&#x27;: &#x27;2021-02-18T14:23:55.259610&#x27;, &#x27;accept_ranges&#x27;: None, &#x27;content_disposition&#x27;: None, &#x27;content_encoding&#x27;: None, &#x27;content_length&#x27;: 273, &#x27;content_type&#x27;: &#x27;text/plain&#x27;, &#x27;copy_from&#x27;: None, &#x27;delete_after&#x27;: None, &#x27;delete_at&#x27;: None, &#x27;etag&#x27;: &#x27;58c6362a0e013dae97594abe7b06d801&#x27;, &#x27;expires_at&#x27;: None, &#x27;id&#x27;: &#x27;my.txt&#x27;, &#x27;last_modified_at&#x27;: &#x27;2021-02-18T14:23:55.259610&#x27;, &#x27;multipart_manifest&#x27;: None, &#x27;name&#x27;: &#x27;my.txt&#x27;, &#x27;object_manifest&#x27;: None, &#x27;range&#x27;: None, &#x27;signature&#x27;: None, &#x27;timestamp&#x27;: None, &#x27;transfer_encoding&#x27;: None}]</div>
                                    </td>
            </tr>
                    
                        </table>
    <br/><br/>

..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Anton Sidelnikov (@anton-sidelnikov)



.. Parsing errors

