Class: Ansible::Ruby::Modules::Docker_volume
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Docker_volume
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb
Overview
Create/remove Docker volumes. Performs largely the same function as the “docker volume” CLI subcommand.
Instance Method Summary collapse
-
#driver ⇒ String?
Specify the type of volume.
-
#driver_options ⇒ Hash?
Dictionary of volume settings.
-
#force ⇒ :yes, ...
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.
-
#labels ⇒ Object?
List of labels to set for the volume.
-
#name ⇒ String
Name of the volume to operate on.
-
#state ⇒ :absent, ...
C(absent) deletes the volume.,C(present) creates the volume, if it does not already exist.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#driver ⇒ String?
Returns Specify the type of volume. Docker provides the C(local) driver, but 3rd party drivers can also be used.
17 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 17 attribute :driver |
#driver_options ⇒ Hash?
Returns Dictionary of volume settings. Consult docker docs for valid options and values: U(docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options).
21 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 21 attribute :driver_options |
#force ⇒ :yes, ...
Returns 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.
28 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 28 attribute :force |
#labels ⇒ Object?
Returns List of labels to set for the volume.
25 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 25 attribute :labels |
#name ⇒ String
Returns Name of the volume to operate on.
13 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 13 attribute :name |
#state ⇒ :absent, ...
Returns C(absent) deletes the volume.,C(present) creates the volume, if it does not already exist.
32 |
# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 32 attribute :state |