Class: Ansible::Ruby::Modules::Virt

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

Overview

Manages virtual machines supported by I(libvirt).

Instance Method Summary collapse

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

#autostart ⇒ Symbol?

Returns start VM at host startup.

Returns:

  • (Symbol, nil) —

    start VM at host startup.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 24

attribute :autostart

#command ⇒ :create, ...

Returns In addition to state management, various non-idempotent commands are available.

Returns:

  • (:create, :define, :destroy, :freemem, :get_xml, :info, :list_vms, :nodeinfo, :pause, :shutdown, :start, :status, :stop, :undefine, :unpause, :virttype, nil) —

    In addition to state management, various non-idempotent commands are available.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 20

attribute :command

#name ⇒ String?

Returns name of the guest VM being managed. Note that VM must be previously defined with xml.,This option is required unless I(command) is C(list_vms).

Returns:

  • (String, nil) —

    name of the guest VM being managed. Note that VM must be previously defined with xml.,This option is required unless I(command) is C(list_vms).



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 12

attribute :name

#state ⇒ :destroyed, ...

Returns Note that there may be some lag for state requests like C(shutdown) since these refer only to VM states. After starting a guest, it may not be immediately accessible.

Returns:

  • (:destroyed, :paused, :running, :shutdown, nil) —

    Note that there may be some lag for state requests like C(shutdown) since these refer only to VM states. After starting a guest, it may not be immediately accessible.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 16

attribute :state

#uri ⇒ String?

Returns libvirt connection uri.

Returns:

  • (String, nil) —

    libvirt connection uri.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 28

attribute :uri

#xml ⇒ Object?

Returns XML document used with the define command.,Must be raw XML content using C(lookup). XML cannot be reference to a file.

Returns:

  • (Object, nil) —

    XML document used with the define command.,Must be raw XML content using C(lookup). XML cannot be reference to a file.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/misc/virt.rb', line 32

attribute :xml