opentelekomcloud.cloud.object_info module – Get Swift info.¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.11.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 opentelekomcloud.cloud.
To use it in a playbook, specify: opentelekomcloud.cloud.object_info.
New in version 0.8.0: of opentelekomcloud.cloud
Synopsis¶
Get Swift containers, container object, object metadata info from the OTC.
Requirements¶
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36.0
otcextensions
python >= 3.6
Parameters¶
Parameter |
Comments |
|---|---|
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. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) 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. |
|
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 auth parameter should be updated accordingly. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Name of container in Swift. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name of object in Swift. |
|
Name of the region. |
|
How long should ansible wait for the requested resource. Default: 180 |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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/
Examples¶
# 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of dictionaries describing containers, objects and object metadata in container. Returned: On Success. |
|
Specifies the list of available containers. Shows when no params passed. Returned: success Sample: [{“bytes”: 5449, “bytes_used”: 5449, “content_type”: null, “count”: 1, “id”: “otc”, “if_none_match”: null, “is_content_type_detected”: null, “is_newest”: null, “meta_temp_url_key”: null, “meta_temp_url_key_2”: null, “name”: “otc”, “object_count”: 1, “read_ACL”: null, “sync_key”: null, “sync_to”: null, “timestamp”: null, “versions_location”: null, “write_ACL”: null}] |
|
Specifies the object metadata. Shows when container and object_name params is not Null Returned: success Sample: {”_bytes”: null, “_content_type”: null, “_hash”: null, “_last_modified”: null, “accept_ranges”: “bytes”, “container”: “test”, “content_disposition”: null, “content_encoding”: null, “content_length”: 5, “content_type”: “text/plain”, “copy_from”: null, “delete_after”: null, “delete_at”: null, “etag”: “e1cbb0c3879af8347246f12c559a86b5”, “expires_at”: null, “id”: “my2.txt”, “if_match”: null, “if_modified_since”: null, “if_none_match”: null, “if_unmodified_since”: null, “is_content_type_detected”: null, “is_newest”: null, “is_static_large_object”: null, “last_modified_at”: “Thu, 18 Feb 2021 13:40:09 GMT”, “multipart_manifest”: null, “name”: null, “object_manifest”: null, “range”: null, “signature”: null, “timestamp”: “1613655609.64076”, “transfer_encoding”: null} |
|
Specifies the list of objects in container. Shows when container param is not Null Returned: success Sample: [{”_bytes”: 273, “_content_type”: “text/plain”, “_hash”: “58c6362a0e013dae97594abe7b06d801”, “_last_modified”: “2021-02-18T14:23:55.259610”, “accept_ranges”: null, “content_disposition”: null, “content_encoding”: null, “content_length”: 273, “content_type”: “text/plain”, “copy_from”: null, “delete_after”: null, “delete_at”: null, “etag”: “58c6362a0e013dae97594abe7b06d801”, “expires_at”: null, “id”: “my.txt”, “last_modified_at”: “2021-02-18T14:23:55.259610”, “multipart_manifest”: null, “name”: “my.txt”, “object_manifest”: null, “range”: null, “signature”: null, “timestamp”: null, “transfer_encoding”: null}] |