openstack.cloud.object_container module – Manage a Swift container.
Note
This module is part of the openstack.cloud collection (version 2.2.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 openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.object_container
.
Synopsis
Create, update and delete a Swift container.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
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, user_domain_name or 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. |
|
Keys from metadata to be deleted. metadata has precedence over delete_metadata_keys: If any key is present in both options, then it will be created or updated, not deleted. Metadata keys are case-insensitive. |
|
Whether the container should be deleted recursively, i.e. including all of its objects. If delete_with_all_objects is set to Choices:
|
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Key value pairs to be set as metadata on the container. Both custom and system metadata can be set. Custom metadata are keys and values defined by the user. metadata is the same as setting properties in openstackclient with Metadata keys are case-insensitive. |
|
Name (and ID) of a Swift container. |
|
The ACL that grants read access. For example, use |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Whether the object should be Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
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:
|
|
The ACL that grants write access. |
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/
Examples
- name: Create empty container with public access
openstack.cloud.object_container:
name: "new-container"
state: present
read_ACL: ".r:*,.rlistings"
- name: Set metadata for container
openstack.cloud.object_container:
name: "new-container"
metadata:
'Cache-Control': 'no-cache'
'foo': 'bar'
- name: Delete metadata keys of a container
openstack.cloud.object_container:
name: "new-container"
delete_metadata_keys:
- foo
- name: Delete container
openstack.cloud.object_container:
name: "new-container"
state: absent
- name: Delete container and all its objects
openstack.cloud.object_container:
name: "new-container"
delete_with_all_objects: true
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the Swift container. Returned: On success when state is |
|
The total number of bytes that are stored in Object Storage for the container. Returned: success Sample: |
|
The count of bytes used in total. Returned: success Sample: |
|
The MIME type of the list of names. Returned: success |
|
The number of objects in the container. Returned: success Sample: |
|
Enables versioning on the container. Returned: success |
|
The ID of the container. Equals name. Returned: success Sample: |
|
In combination with Returned: success |
|
If set to Returned: success |
|
If set to True, Object Storage queries all replicas to return the most recent one. If you omit this header, Object Storage responds faster after it finds one valid replica. Because setting this header to True is more expensive for the back end, use it only when it is absolutely needed. Returned: success |
|
The secret key value for temporary URLs. If not set, this header is not returned by this operation. Returned: success |
|
A second secret key value for temporary URLs. If not set, this header is not returned by this operation. Returned: success |
|
The name of the container. Returned: success Sample: |
|
The number of objects. Returned: success Sample: |
|
The ACL that grants read access. If not set, this header is not returned by this operation. Returned: success |
|
Storage policy used by the container. It is not possible to change policy of an existing container. Returned: success |
|
The secret key for container synchronization. If not set, this header is not returned by this operation. Returned: success |
|
The destination for container synchronization. If not set, this header is not returned by this operation. Returned: success |
|
The timestamp of the transaction. Returned: success |
|
Enables versioning on this container. The value is the name of another container. You must UTF-8-encode and then URL-encode the name before you include it in the header. To disable versioning, set the header to an empty string. Returned: success |
|
The ACL that grants write access. If not set, this header is not returned by this operation. Returned: success |