Class: Ansible::Ruby::Modules::Virt_pool

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb

Overview

Manage I(libvirt) storage pools.

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

#autostart ⇒ :yes, ...

Returns Specify if a given storage pool should be started automatically on system boot.

Returns:

  • (:yes, :no, nil) —

    Specify if a given storage pool should be started automatically on system boot.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 23

attribute :autostart

#command ⇒ :define, ...

Returns in addition to state management, various non-idempotent commands are available. See examples.

Returns:

  • (:define, :build, :create, :start, :stop, :destroy, :delete, :undefine, :get_xml, :list_pools, :facts, :info, :status, nil) —

    in addition to state management, various non-idempotent commands are available. See examples.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 19

attribute :command

#mode ⇒ :new, ...

Returns Pass additional parameters to ‘build’ or ‘delete’ commands.

Returns:

  • (:new, :repair, :resize, :no_overwrite, :overwrite, :normal, :zeroed, nil) —

    Pass additional parameters to ‘build’ or ‘delete’ commands.



35
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 35

attribute :mode

#name ⇒ String?

Returns name of the storage pool being managed. Note that pool must be previously defined with xml.

Returns:

  • (String, nil) —

    name of the storage pool being managed. Note that pool must be previously defined with xml.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 11

attribute :name

#state ⇒ :active, ...

Returns specify which state you want a storage pool to be in. If ‘active’, pool will be started. If ‘present’, ensure that pool is present but do not change its state; if it’s missing, you need to specify xml argument. If ‘inactive’, pool will be stopped. If ‘undefined’ or ‘absent’, pool will be removed from I(libvirt) configuration. If ‘deleted’, pool contents will be deleted and then pool undefined.

Returns:

  • (:active, :inactive, :present, :absent, :undefined, :deleted, nil) —

    specify which state you want a storage pool to be in. If ‘active’, pool will be started. If ‘present’, ensure that pool is present but do not change its state; if it’s missing, you need to specify xml argument. If ‘inactive’, pool will be stopped. If ‘undefined’ or ‘absent’, pool will be removed from I(libvirt) configuration. If ‘deleted’, pool contents will be deleted and then pool undefined.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 15

attribute :state

#uri ⇒ String?

Returns I(libvirt) connection uri.

Returns:

  • (String, nil) —

    I(libvirt) connection uri.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 27

attribute :uri

#xml ⇒ String?

Returns XML document used with the define command.

Returns:

  • (String, nil) —

    XML document used with the define command.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_pool.rb', line 31

attribute :xml