Class: Ansible::Ruby::Modules::Proxmox_kvm

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb

Overview

Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster.

Instance Method Summary

• #acpi ⇒ :yes, ...

  Specify if ACPI should be enabled/disabled.

• #agent ⇒ Symbol^?

  Specify if the QEMU Guest Agent should be enabled/disabled.

• #api_host ⇒ String

  Specify the target host of the Proxmox VE cluster.

• #api_password ⇒ String^?

  Specify the password to authenticate with.,You can use C(PROXMOX_PASSWORD) environment variable.

• #api_user ⇒ String

  Specify the user to authenticate with.

• #args ⇒ Array<String>, ...

  Pass arbitrary arguments to kvm.,This option is for experts only!.

• #autostart ⇒ :yes, ...

  Specify if the VM should be automatically restarted after crash (currently ignored in PVE API).

• #balloon ⇒ Integer^?

  Specify the amount of RAM for the VM in MB.,Using zero disables the balloon driver.

• #bios ⇒ :seabios, ...

  Specify the BIOS implementation.

• #boot ⇒ String^?

  Specify the boot order -> boot on floppy C(a), hard disk C©, CD-ROM C(d), or network C(n).,You can combine to set order.

• #bootdisk ⇒ Object^?

  Enable booting from specified disk.

• #clone ⇒ String^?

  Name of VM to be cloned.

• #cores ⇒ Integer^?

  Specify number of cores per socket.

• #cpu ⇒ String^?

  Specify emulated CPU type.

• #cpulimit ⇒ Object^?

  Specify if CPU usage will be limited.

• #cpuunits ⇒ Integer^?

  Specify CPU weight for a VM.,You can disable fair-scheduler configuration by setting this to 0.

• #delete ⇒ Array<String>, ...

  Specify a list of settings you want to delete.

• #description ⇒ Object^?

  Specify the description for the VM.

• #digest ⇒ Object^?

  Specify if to prevent changes if current configuration file has different SHA1 digest.,This can be used to prevent concurrent modifications.

• #force ⇒ Symbol^?

  Allow to force stop VM.,Can be used only with states C(stopped), C(restarted).

• #format ⇒ :cloop, ...

  Target drive’s backing file’s data format.,Used only with clone.

• #freeze ⇒ Symbol^?

  Specify if PVE should freeze CPU at startup (use ‘c’ monitor command to start execution).

• #full ⇒ :yes, ...

  Create a full copy of all disk.

• #hostpci ⇒ Object^?

  Specify a hash/dictionary of map host pci devices into guest.

• #hotplug ⇒ Object^?

  Selectively enable hotplug features.,This is a comma separated list of hotplug features C(‘network’, ‘disk’, ‘cpu’, ‘memory’ and ‘usb’).,Value 0 disables hotplug completely and value 1 is an alias for the default C(‘network,disk,usb’).

• #hugepages ⇒ :any, ...

  Enable/disable hugepages memory.

• #ide ⇒ Object^?

  A hash/dictionary of volume used as IDE hard disk or CD-ROM.

• #keyboard ⇒ Object^?

  Sets the keyboard layout for VNC server.

• #kvm ⇒ :yes, ...

  Enable/disable KVM hardware virtualization.

• #localtime ⇒ Symbol^?

  Sets the real time clock to local time.,This is enabled by default if ostype indicates a Microsoft OS.

• #lock ⇒ :migrate, ...

  Lock/unlock the VM.

• #machine ⇒ Object^?

  Specifies the Qemu machine type.,type => C((pc|pc(-i440fx)?-d+.d+(.pxe)?|q35|pc-q35-d+.d+(.pxe)?)).

• #memory ⇒ Integer^?

  Memory size in MB for instance.

• #migrate_downtime ⇒ Object^?

  Sets maximum tolerated downtime (in seconds) for migrations.

• #migrate_speed ⇒ Object^?

  Sets maximum speed (in MB/s) for migrations.,A value of 0 is no limit.

• #name ⇒ String^?

  Specifies the VM name.

• #net ⇒ Hash^?

  A hash/dictionary of network interfaces for the VM.

• #newid ⇒ Integer^?

  VMID for the clone.

• #node ⇒ String^?

  Proxmox VE node, where the new VM will be created.,Only required for C(state=present).,For other states, it will be autodiscovered.

• #numa ⇒ Object^?

  A hash/dictionaries of NUMA topology.

• #onboot ⇒ :yes, ...

  Specifies whether a VM will be started during system bootup.

• #ostype ⇒ :other, ...

  Specifies guest operating system.

• #parallel ⇒ Object^?

  A hash/dictionary of map host parallel devices.

• #pool ⇒ Object^?

  Add the new VM to the specified pool.

• #protection ⇒ Symbol^?

  Enable/disable the protection flag of the VM.

• #reboot ⇒ Symbol^?

  Allow reboot.

• #revert ⇒ Array<String>, ...

  Revert a pending change.

• #sata ⇒ Object^?

  A hash/dictionary of volume used as sata hard disk or CD-ROM.

• #scsi ⇒ Object^?

  A hash/dictionary of volume used as SCSI hard disk or CD-ROM.

• #scsihw ⇒ :lsi, ...

  Specifies the SCSI controller model.

• #serial ⇒ Object^?

  A hash/dictionary of serial device to create inside the VM.

• #shares ⇒ Object^?

  Rets amount of memory shares for auto-ballooning.

• #skiplock ⇒ Object^?

  Ignore locks,Only root is allowed to use this option.

• #smbios ⇒ Object^?

  Specifies SMBIOS type 1 fields.

• #snapname ⇒ Object^?

  The name of the snapshot.

• #sockets ⇒ Integer^?

  Sets the number of CPU sockets.

• #startdate ⇒ Object^?

  Sets the initial date of the real time clock.,Valid format for date are C(‘now’) or C(‘2016-09-25T16:01:21’) or C(‘2016-09-25’).

• #startup ⇒ Object^?

  Startup and shutdown behavior.

• #state ⇒ :present, ...

  Indicates desired state of the instance.,If C(current), the current state of the VM will be fecthed.

• #storage ⇒ String^?

  Target storage for full clone.

• #tablet ⇒ :yes, ...

  Enables/disables the USB tablet device.

• #target ⇒ Object^?

  Target node.

• #tdf ⇒ Symbol^?

  Enables/disables time drift fix.

• #template ⇒ :yes, ...

  Enables/disables the template.

• #timeout ⇒ Integer^?

  Timeout for operations.

• #update ⇒ :yes, ...

  If C(yes), the VM will be update with new value.,Cause of the operations of the API and security reasons, I have disabled the update of the following parameters,C(net, virtio, ide, sata, scsi).

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

• #vcpus ⇒ Integer^?

  Sets number of hotplugged vcpus.

• #vga ⇒ :std, ...

  Select VGA type.

• #virtio ⇒ Hash^?

  A hash/dictionary of volume used as VIRTIO hard disk.

• #vmid ⇒ Integer^?

  Specifies the VM ID.

• #watchdog ⇒ Object^?

  Creates a virtual hardware watchdog device.

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

#acpi ⇒ :yes, ...

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

attribute :acpi

#agent ⇒ Symbol^?

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

attribute :agent

#api_host ⇒ String

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

attribute :api_host

#api_password ⇒ String^?

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

attribute :api_password

#api_user ⇒ String

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

attribute :api_user

#args ⇒ Array<String>, ...

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

attribute :args

#autostart ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 36

attribute :autostart

#balloon ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 40

attribute :balloon

#bios ⇒ :seabios, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 44

attribute :bios

#boot ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 48

attribute :boot

#bootdisk ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 52

attribute :bootdisk

#clone ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 55

attribute :clone

#cores ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 59

attribute :cores

#cpu ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 63

attribute :cpu

#cpulimit ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 67

attribute :cpulimit

#cpuunits ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 70

attribute :cpuunits

#delete ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 74

attribute :delete

#description ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 78

attribute :description

#digest ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 81

attribute :digest

#force ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 84

attribute :force

#format ⇒ :cloop, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 88

attribute :format

#freeze ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 92

attribute :freeze

#full ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 96

attribute :full

#hostpci ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 100

attribute :hostpci

#hotplug ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 103

attribute :hotplug

#hugepages ⇒ :any, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 106

attribute :hugepages

#ide ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 110

attribute :ide

#keyboard ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 113

attribute :keyboard

#kvm ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 116

attribute :kvm

#localtime ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 120

attribute :localtime

#lock ⇒ :migrate, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 124

attribute :lock

#machine ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 128

attribute :machine

#memory ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 131

attribute :memory

#migrate_downtime ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 135

attribute :migrate_downtime

#migrate_speed ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 138

attribute :migrate_speed

#name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 141

attribute :name

#net ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 145

attribute :net

#newid ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 149

attribute :newid

#node ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 153

attribute :node

#numa ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 157

attribute :numa

#onboot ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 160

attribute :onboot

#ostype ⇒ :other, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 164

attribute :ostype

#parallel ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 168

attribute :parallel

#pool ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 171

attribute :pool

#protection ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 174

attribute :protection

#reboot ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 178

attribute :reboot

#revert ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 182

attribute :revert

#sata ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 186

attribute :sata

#scsi ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 189

attribute :scsi

#scsihw ⇒ :lsi, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 192

attribute :scsihw

#serial ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 196

attribute :serial

#shares ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 199

attribute :shares

#skiplock ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 202

attribute :skiplock

#smbios ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 205

attribute :smbios

#snapname ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 208

attribute :snapname

#sockets ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 211

attribute :sockets

#startdate ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 215

attribute :startdate

#startup ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 218

attribute :startup

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 221

attribute :state

#storage ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 225

attribute :storage

#tablet ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 229

attribute :tablet

#target ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 233

attribute :target

#tdf ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 236

attribute :tdf

#template ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 240

attribute :template

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 244

attribute :timeout

#update ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 248

attribute :update

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 252

attribute :validate_certs

#vcpus ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 256

attribute :vcpus

#vga ⇒ :std, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 260

attribute :vga

#virtio ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 264

attribute :virtio

#vmid ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 268

attribute :vmid

#watchdog ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/proxmox_kvm.rb', line 272

attribute :watchdog