ansible / ansible.builtin / v2.9.24 / module / docker_volume Manage Docker volumes | "added in version" 2.4 of ansible.builtin" Authors: Alex Grönholm (@agronholm) preview | supported by communityansible.builtin.docker_volume (v2.9.24) — module
pip
Install with pip install ansible==2.9.24
Create/remove Docker volumes.
Performs largely the same function as the "docker volume" CLI subcommand.
- 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
tls: default: false description: - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if I(validate_certs) is set to C(yes) as well, it will take precedence. - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS) will be used instead. If the environment variable is not set, the default value will be used. type: bool debug: default: false description: - Debug mode type: bool force: default: false description: - With state C(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. - Deprecated. Will be removed in Ansible 2.12. Set I(recreate) to C(options-changed) instead for the same behavior of setting I(force) to C(yes). type: bool state: choices: - absent - present default: present description: - C(absent) deletes the volume. - C(present) creates the volume, if it does not already exist. type: str driver: default: local description: - Specify the type of volume. Docker provides the C(local) driver, but 3rd party drivers can also be used. type: str labels: description: - Dictionary of label key/values to set for the volume type: dict ca_cert: aliases: - tls_ca_cert - cacert_path description: - Use a CA certificate when performing server verification by providing the path to a CA certificate file. - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, the file C(ca.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. type: path timeout: default: 60 description: - The maximum amount of time in seconds to wait on a response from the API. - If the value is not specified in the task, the value of environment variable C(DOCKER_TIMEOUT) will be used instead. If the environment variable is not set, the default value will be used. type: int recreate: choices: - always - never - options-changed default: never description: - Controls when a volume will be recreated when I(state) is C(present). Please note that recreating an existing volume will cause **any data in the existing volume to be lost!** The volume will be deleted and a new volume with the same name will be created. - The value C(always) forces the volume to be always recreated. - The value C(never) makes sure the volume will not be recreated. - The value C(options-changed) makes sure the volume will be recreated if the volume already exist and the driver, driver options or labels differ. type: str version_added: '2.8' version_added_collection: ansible.builtin client_key: aliases: - tls_client_key - key_path description: - Path to the client's TLS key file. - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, the file C(key.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. type: path api_version: aliases: - docker_api_version default: auto description: - The version of the Docker API running on the Docker Host. - Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon. - If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION) will be used instead. If the environment variable is not set, the default value will be used. type: str client_cert: aliases: - tls_client_cert - cert_path description: - Path to the client's TLS certificate file. - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, the file C(cert.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. type: path docker_host: aliases: - docker_url default: unix://var/run/docker.sock description: - 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, C(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, the module will automatically replace C(tcp) in the connection URL with C(https). - If the value is not specified in the task, the value of environment variable C(DOCKER_HOST) will be used instead. If the environment variable is not set, the default value will be used. type: str ssl_version: description: - Provide a valid SSL version number. Default value determined by ssl.py module. - If the value is not specified in the task, the value of environment variable C(DOCKER_SSL_VERSION) will be used instead. type: str volume_name: aliases: - name description: - Name of the volume to operate on. required: true type: str tls_hostname: default: localhost description: - When verifying the authenticity of the Docker Host server, provide the expected name of the server. - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_HOSTNAME) will be used instead. If the environment variable is not set, the default value will be used. type: str driver_options: description: - 'Dictionary of volume settings. Consult docker docs for valid options and values: U(https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options)' type: dict use_ssh_client: default: false description: - For SSH transports, use the C(ssh) CLI tool instead of paramiko. - Requires Docker SDK for Python 4.4.0 or newer. type: bool version_added: 1.5.0 version_added_collection: community.docker validate_certs: aliases: - tls_verify default: false description: - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_VERIFY) will be used instead. If the environment variable is not set, the default value will be used. type: bool
volume: description: - Volume inspection results for the affected volume. - Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as C(docker_volume). Note that the returned fact will be removed in Ansible 2.12. returned: success sample: {} type: dict