summaryrefslogtreecommitdiff
path: root/docker/models/volumes.py
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2017-01-25 15:46:58 -0800
committerJoffrey F <joffrey@docker.com>2017-01-26 14:24:52 -0800
commita24b114af3aec0430fd27f8bbf460cfa396ae274 (patch)
treefeb26803c76cce50d04292804a65aea2fd26f0b8 /docker/models/volumes.py
parent39deace7c62e3ebfd1a69beb9ac78e6aa7038b57 (diff)
downloaddocker-py-force_remove_volume.tar.gz
Add 'force' parameter in remove_volumeforce_remove_volume
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/models/volumes.py')
-rw-r--r--docker/models/volumes.py15
1 files changed, 12 insertions, 3 deletions
diff --git a/docker/models/volumes.py b/docker/models/volumes.py
index 5a31541..5fb0d1c 100644
--- a/docker/models/volumes.py
+++ b/docker/models/volumes.py
@@ -10,9 +10,18 @@ class Volume(Model):
"""The name of the volume."""
return self.attrs['Name']
- def remove(self):
- """Remove this volume."""
- return self.client.api.remove_volume(self.id)
+ def remove(self, force=False):
+ """
+ Remove this volume.
+
+ Args:
+ force (bool): Force removal of volumes that were already removed
+ out of band by the volume driver plugin.
+ Raises:
+ :py:class:`docker.errors.APIError`
+ If volume failed to remove.
+ """
+ return self.client.api.remove_volume(self.id, force=force)
class VolumeCollection(Collection):