W3cubDocs

/Ansible

docker_volume - Manage Docker volumes

New in version 2.4.

Synopsis

  • Create/remove Docker volumes.
  • Performs largely the same function as the “docker volume” CLI subcommand.

Requirements (on host that executes module)

  • python >= 2.6
  • docker-py >= 1.10.0
  • The docker server >= 1.9.0

Options

parameter required default choices comments
api_version
 no default provided by docker-py
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by docker-py.
aliases: docker_api_version
cacert_path
 no
Use a CA certificate when performing server verification by providing the path to a CA certificate file.
aliases: tls_ca_cert
cert_path
 no
Path to the client's TLS certificate file.
aliases: tls_client_cert
docker_host
 no unix://var/run/docker.sock
The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection, the module will automatically replace 'tcp' in the connection URL with 'https'.
aliases: docker_url
driver
 no local
Specify the type of volume. Docker provides the local driver, but 3rd party drivers can also be used.
driver_options
 no
Dictionary of volume settings. Consult docker docs for valid options and values: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options
force
 no no
  • yes
  • no
With state present causes the volume to be deleted and recreated if the volume already exist and the driver, driver options or labels differ. This will cause any data in the existing volume to be lost.
key_path
 no
Path to the client's TLS key file.
aliases: tls_client_key
labels
 no
List of labels to set for the volume
name
 yes
Name of the volume to operate on.
aliases: volume_name
ssl_version
 no 1.0
Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
state
 no present
  • absent
  • present
absent deletes the volume.
present creates the volume, if it does not already exist.
timeout
 no 60
The maximum amount of time in seconds to wait on a response from the API.
tls
 no
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server.
tls_hostname
 no localhost
When verifying the authenticity of the Docker Host server, provide the expected name of the server.
tls_verify
 no
Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.

Examples

- name: Create a volume
  docker_volume:
    name: volume_one

- name: Remove a volume
  docker_volume:
    name: volume_one
    state: absent

- name: Create a volume with options
  docker_volume:
    name: volume_two
    driver_options:
      type: btrfs
      device: /dev/sda2

Return Values

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

name description returned type sample
facts
Volume inspection results for the affected volume.
 success dict {}

Notes

Note

  • Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docker-py.readthedocs.org/en/stable/machine/ for more details.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/docker_volume_module.html