Class: Ansible::Ruby::Modules::Gluster_volume

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb

Overview

Create, remove, start, stop and tune GlusterFS volumes

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

#bricksArray<String>, ...

Returns Brick paths on servers. Multiple brick paths can be separated by commas.

Returns:

  • (Array<String>, String, nil)

    Brick paths on servers. Multiple brick paths can be separated by commas



36
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 36

attribute :bricks

#clusterArray<String>, ...

Returns List of hosts to use for probing and brick setup.

Returns:

  • (Array<String>, String, nil)

    List of hosts to use for probing and brick setup



19
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 19

attribute :cluster

#directoryString?

Returns Directory for limit-usage.

Returns:

  • (String, nil)

    Directory for limit-usage



48
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 48

attribute :directory

#forceObject?

Returns If brick is being created in the root partition, module will fail. Set force to true to override this behaviour.

Returns:

  • (Object, nil)

    If brick is being created in the root partition, module will fail. Set force to true to override this behaviour



60
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 60

attribute :force

#hostObject?

Returns Override local hostname (for peer probing purposes).

Returns:

  • (Object, nil)

    Override local hostname (for peer probing purposes)



23
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 23

attribute :host

#nameString

Returns The volume name.

Returns:

  • (String)

    The volume name



11
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 11

attribute :name

#optionsString?

Returns A dictionary/hash with options/settings for the volume.

Returns:

  • (String, nil)

    A dictionary/hash with options/settings for the volume



52
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 52

attribute :options

#quotaString?

Returns Quota value for limit-usage (be sure to use 10.0MB instead of 10MB, see quota list).

Returns:

  • (String, nil)

    Quota value for limit-usage (be sure to use 10.0MB instead of 10MB, see quota list)



56
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 56

attribute :quota

#rebalance:yes, ...

Returns Controls whether the cluster is rebalanced after changes.

Returns:

  • (:yes, :no, nil)

    Controls whether the cluster is rebalanced after changes



44
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 44

attribute :rebalance

#replicasObject?

Returns Replica count for volume.

Returns:

  • (Object, nil)

    Replica count for volume



26
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 26

attribute :replicas

#start_on_create:yes, ...

Returns Controls whether the volume is started after creation or not, defaults to yes.

Returns:

  • (:yes, :no, nil)

    Controls whether the volume is started after creation or not, defaults to yes



40
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 40

attribute :start_on_create

#state:present, ...

Returns Use present/absent ensure if a volume exists or not, use started/stopped to control it’s availability.

Returns:

  • (:present, :absent, :started, :stopped)

    Use present/absent ensure if a volume exists or not, use started/stopped to control it’s availability.



15
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 15

attribute :state

#stripesObject?

Returns Stripe count for volume.

Returns:

  • (Object, nil)

    Stripe count for volume



29
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 29

attribute :stripes

#transport:tcp, ...

Returns Transport type for volume.

Returns:

  • (:tcp, :rdma, :"tcp,rdma", nil)

    Transport type for volume



32
# File 'lib/ansible/ruby/modules/generated/extras/system/gluster_volume.rb', line 32

attribute :transport