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

• #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

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#driver ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 17

attribute :driver

#driver_options ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 21

attribute :driver_options

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 28

attribute :force

#labels ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 25

attribute :labels

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 13

attribute :name

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_volume.rb', line 32

attribute :state