Class: Ansible::Ruby::Modules::Vsphere_guest

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Vsphere_guest

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb

Overview

Create/delete/reconfigure a guest VM through VMware vSphere. This module has a dependency on pysphere >= 1.7

Instance Method Summary

• #cluster ⇒ Object^?

  The name of the cluster to create the VM in.

• #esxi ⇒ Hash^?

  Dictionary which includes datacenter and hostname on which the VM should be created.

• #force ⇒ :yes, ...

  Boolean.

• #from_template ⇒ Boolean^?

  Specifies if the VM should be deployed from a template (mutually exclusive with ‘state’ parameter).

• #guest ⇒ String

  The virtual server name you wish to manage.

• #password ⇒ String

  Password of the user to connect to vcenter as.

• #power_on_after_clone ⇒ Boolean^?

  Specifies if the VM should be powered on after the clone.

• #resource_pool ⇒ Object^?

  The name of the resource_pool to create the VM in.

• #snapshot_to_clone ⇒ String^?

  A string that when specified, will create a linked clone copy of the VM.

• #state ⇒ :present, ...

  Indicate desired state of the vm.

• #template_src ⇒ Object^?

  Name of the source template to deploy from.

• #username ⇒ String

  Username to connect to vcenter as.

• #validate_certs ⇒ Boolean^?

  Validate SSL certs.

• #vcenter_hostname ⇒ String

  The hostname of the vcenter server the module will connect to, to create the guest.

• #vm_disk ⇒ Hash^?

  A key, value list of disks and their sizes and which datastore to keep it in.

• #vm_extra_config ⇒ Hash^?

  A key, value pair of any extra values you want set or changed in the vmx file of the VM.

• #vm_hardware ⇒ Hash^?

  A key, value list of VM config settings.

• #vm_hw_version ⇒ Object^?

  Desired hardware version identifier (for example, “vmx-08” for vms that needs to be managed with vSphere Client).

• #vm_nic ⇒ Hash^?

  A key, value list of nics, their types and what network to put them on.

• #vmware_guest_facts ⇒ Object^?

  Gather facts from vCenter on a particular VM.

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

#cluster ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 34

attribute :cluster

#esxi ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 37

attribute :esxi

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 82

attribute :force

#from_template ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 45

attribute :from_template

#guest ⇒ String

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 19

attribute :guest

#password ⇒ String

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 27

attribute :password

#power_on_after_clone ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 56

attribute :power_on_after_clone

#resource_pool ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 31

attribute :resource_pool

#snapshot_to_clone ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 52

attribute :snapshot_to_clone

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 41

attribute :state

#template_src ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 49

attribute :template_src

#username ⇒ String

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 23

attribute :username

#validate_certs ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 15

attribute :validate_certs

#vcenter_hostname ⇒ String

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 11

attribute :vcenter_hostname

#vm_disk ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 60

attribute :vm_disk

#vm_extra_config ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 72

attribute :vm_extra_config

#vm_hardware ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 64

attribute :vm_hardware

#vm_hw_version ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 76

attribute :vm_hw_version

#vm_nic ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 68

attribute :vm_nic

#vmware_guest_facts ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/vmware/vsphere_guest.rb', line 79

attribute :vmware_guest_facts