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

Inherits:
Base show all
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 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

#acpi ⇒ :yes, ...

Returns Specify if ACPI should be enabled/disabled.

Returns:

  • (:yes, :no, nil) —

    Specify if ACPI should be enabled/disabled.



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

attribute :acpi

#agent ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :agent

#api_host ⇒ String

Returns Specify the target host of the Proxmox VE cluster.

Returns:

  • (String) —

    Specify the target host of the Proxmox VE cluster.



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

attribute :api_host

#api_password ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :api_password

#api_user ⇒ String

Returns Specify the user to authenticate with.

Returns:

  • (String) —

    Specify the user to authenticate with.



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

attribute :api_user

#args ⇒ Array<String>, ...

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

Returns:

  • (Array<String>, String, nil) —

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



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

attribute :args

#autostart ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :autostart

#balloon ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :balloon

#bios ⇒ :seabios, ...

Returns Specify the BIOS implementation.

Returns:

  • (:seabios, :ovmf, nil) —

    Specify the BIOS implementation.



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

attribute :bios

#boot ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :boot

#bootdisk ⇒ Object?

Returns Enable booting from specified disk. C((ide|sata|scsi|virtio)d+).

Returns:

  • (Object, nil) —

    Enable booting from specified disk. C((ide|sata|scsi|virtio)d+)



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

attribute :bootdisk

#clone ⇒ String?

Returns Name of VM to be cloned. If C(vmid) is setted, C(clone) can take arbitrary value but required for intiating the clone.

Returns:

  • (String, nil) —

    Name of VM to be cloned. If C(vmid) is setted, C(clone) can take arbitrary value but required for intiating the clone.



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

attribute :clone

#cores ⇒ Integer?

Returns Specify number of cores per socket.

Returns:

  • (Integer, nil) —

    Specify number of cores per socket.



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

attribute :cores

#cpu ⇒ String?

Returns Specify emulated CPU type.

Returns:

  • (String, nil) —

    Specify emulated CPU type.



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

attribute :cpu

#cpulimit ⇒ Object?

Returns Specify if CPU usage will be limited. Value 0 indicates no CPU limit.,If the computer has 2 CPUs, it has total of ‘2’ CPU time.

Returns:

  • (Object, nil) —

    Specify if CPU usage will be limited. Value 0 indicates no CPU limit.,If the computer has 2 CPUs, it has total of ‘2’ CPU time



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

attribute :cpulimit

#cpuunits ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :cpuunits

#delete ⇒ Array<String>, ...

Returns Specify a list of settings you want to delete.

Returns:

  • (Array<String>, String, nil) —

    Specify a list of settings you want to delete.



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

attribute :delete

#description ⇒ Object?

Returns Specify the description for the VM. Only used on the configuration web interface.,This is saved as comment inside the configuration file.

Returns:

  • (Object, nil) —

    Specify the description for the VM. Only used on the configuration web interface.,This is saved as comment inside the configuration file.



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

attribute :description

#digest ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :digest

#force ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :force

#format ⇒ :cloop, ...

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

Returns:

  • (:cloop, :cow, :qcow, :qcow2, :qed, :raw, :vmdk, nil) —

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



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

attribute :format

#freeze ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :freeze

#full ⇒ :yes, ...

Returns Create a full copy of all disk. This is always done when you clone a normal VM.,For VM templates, we try to create a linked clone by default.,Used only with clone.

Returns:

  • (:yes, :no, nil) —

    Create a full copy of all disk. This is always done when you clone a normal VM.,For VM templates, we try to create a linked clone by default.,Used only with clone



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

attribute :full

#hostpci ⇒ Object?

Returns Specify a hash/dictionary of map host pci devices into guest. C(hostpci=‘“key”:“value”’).,Keys allowed are - C(hostpci) where 0 ≤ n ≤ N.,Values allowed are - C(“host=”HOSTPCIID“,pcie=”1|0“,rombar=”1|0“,x-vga=”1|0“”).,The C(host) parameter is Host PCI device pass through. HOSTPCIID syntax is C(bus:dev.func) (hexadecimal numbers).,C(pcie=boolean) I(default=0) Choose the PCI-express bus (needs the q35 machine model).,C(rombar=boolean) I(default=1) Specify whether or not the device’s ROM will be visible in the guest’s memory map.,C(x-vga=boolean) I(default=0) Enable vfio-vga device support.,/!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.

Returns:

  • (Object, nil) —

    Specify a hash/dictionary of map host pci devices into guest. C(hostpci=‘“key”:“value”’).,Keys allowed are - C(hostpci) where 0 ≤ n ≤ N.,Values allowed are - C(“host=”HOSTPCIID“,pcie=”1|0“,rombar=”1|0“,x-vga=”1|0“”).,The C(host) parameter is Host PCI device pass through. HOSTPCIID syntax is C(bus:dev.func) (hexadecimal numbers).,C(pcie=boolean) I(default=0) Choose the PCI-express bus (needs the q35 machine model).,C(rombar=boolean) I(default=1) Specify whether or not the device’s ROM will be visible in the guest’s memory map.,C(x-vga=boolean) I(default=0) Enable vfio-vga device support.,/!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.



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

attribute :hostpci

#hotplug ⇒ Object?

Returns 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’).

Returns:

  • (Object, nil) —

    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’).



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

attribute :hotplug

#hugepages ⇒ :any, ...

Returns Enable/disable hugepages memory.

Returns:

  • (:any, 2, 1024, nil) —

    Enable/disable hugepages memory.



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

attribute :hugepages

#ide ⇒ Object?

Returns A hash/dictionary of volume used as IDE hard disk or CD-ROM. C(ide=‘“key”:“value”’).,Keys allowed are - C(ide) where 0 ≤ n ≤ 3.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).

Returns:

  • (Object, nil) —

    A hash/dictionary of volume used as IDE hard disk or CD-ROM. C(ide=‘“key”:“value”’).,Keys allowed are - C(ide) where 0 ≤ n ≤ 3.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).



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

attribute :ide

#keyboard ⇒ Object?

Returns Sets the keyboard layout for VNC server.

Returns:

  • (Object, nil) —

    Sets the keyboard layout for VNC server.



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

attribute :keyboard

#kvm ⇒ :yes, ...

Returns Enable/disable KVM hardware virtualization.

Returns:

  • (:yes, :no, nil) —

    Enable/disable KVM hardware virtualization.



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

attribute :kvm

#localtime ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :localtime

#lock ⇒ :migrate, ...

Returns Lock/unlock the VM.

Returns:

  • (:migrate, :backup, :snapshot, :rollback, nil) —

    Lock/unlock the VM.



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

attribute :lock

#machine ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :machine

#memory ⇒ Integer?

Returns Memory size in MB for instance.

Returns:

  • (Integer, nil) —

    Memory size in MB for instance.



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

attribute :memory

#migrate_downtime ⇒ Object?

Returns Sets maximum tolerated downtime (in seconds) for migrations.

Returns:

  • (Object, nil) —

    Sets maximum tolerated downtime (in seconds) for migrations.



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

attribute :migrate_downtime

#migrate_speed ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :migrate_speed

#name ⇒ String?

Returns Specifies the VM name. Only used on the configuration web interface.,Required only for C(state=present).

Returns:

  • (String, nil) —

    Specifies the VM name. Only used on the configuration web interface.,Required only for C(state=present).



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

attribute :name

#net ⇒ Hash?

Returns A hash/dictionary of network interfaces for the VM. C(net=‘“key”:“value”’).,Keys allowed are - C(net) where 0 ≤ n ≤ N.,Values allowed are - C(“model=”XX:XX:XX:XX:XX:XX“,brigde=”value“,rate=”value“,tag=”value“,firewall=”1|0“,trunks=”vlanid“”).,Model is one of C(e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3).,C(XX:XX:XX:XX:XX:XX) should be an unique MAC address. This is automatically generated if not specified.,The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called ‘vmbr0’.,Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is ‘Megabytes per second’.,If you specify no bridge, we create a kvm ‘user’ (NATed) network device, which provides DHCP and DNS services.

Returns:

  • (Hash, nil) —

    A hash/dictionary of network interfaces for the VM. C(net=‘“key”:“value”’).,Keys allowed are - C(net) where 0 ≤ n ≤ N.,Values allowed are - C(“model=”XX:XX:XX:XX:XX:XX“,brigde=”value“,rate=”value“,tag=”value“,firewall=”1|0“,trunks=”vlanid“”).,Model is one of C(e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3).,C(XX:XX:XX:XX:XX:XX) should be an unique MAC address. This is automatically generated if not specified.,The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called ‘vmbr0’.,Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is ‘Megabytes per second’.,If you specify no bridge, we create a kvm ‘user’ (NATed) network device, which provides DHCP and DNS services.



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

attribute :net

#newid ⇒ Integer?

Returns VMID for the clone. Used only with clone.,If newid is not set, the next available VM ID will be fetched from ProxmoxAPI.

Returns:

  • (Integer, nil) —

    VMID for the clone. Used only with clone.,If newid is not set, the next available VM ID will be fetched from ProxmoxAPI.



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

attribute :newid

#node ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :node

#numa ⇒ Object?

Returns A hash/dictionaries of NUMA topology. C(numa=‘“key”:“value”’).,Keys allowed are - C(numa) where 0 ≤ n ≤ N.,Values allowed are - C(“cpu=”<id;…>“,hostnodes=”<id;…>“,memory=”number“,policy=”(bind|interleave|preferred)“”).,C(cpus) CPUs accessing this NUMA node.,C(hostnodes) Host NUMA nodes to use.,C(memory) Amount of memory this NUMA node provides.,C(policy) NUMA allocation policy.

Returns:

  • (Object, nil) —

    A hash/dictionaries of NUMA topology. C(numa=‘“key”:“value”’).,Keys allowed are - C(numa) where 0 ≤ n ≤ N.,Values allowed are - C(“cpu=”<id;…>“,hostnodes=”<id;…>“,memory=”number“,policy=”(bind|interleave|preferred)“”).,C(cpus) CPUs accessing this NUMA node.,C(hostnodes) Host NUMA nodes to use.,C(memory) Amount of memory this NUMA node provides.,C(policy) NUMA allocation policy.



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

attribute :numa

#onboot ⇒ :yes, ...

Returns Specifies whether a VM will be started during system bootup.

Returns:

  • (:yes, :no, nil) —

    Specifies whether a VM will be started during system bootup.



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

attribute :onboot

#ostype ⇒ :other, ...

Returns Specifies guest operating system. This is used to enable special optimization/features for specific operating systems.,The l26 is Linux 2.6/3.X Kernel.

Returns:

  • (:other, :wxp, :w2k, :w2k3, :w2k8, :wvista, :win7, :win8, :l24, :l26, :solaris, nil) —

    Specifies guest operating system. This is used to enable special optimization/features for specific operating systems.,The l26 is Linux 2.6/3.X Kernel.



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

attribute :ostype

#parallel ⇒ Object?

Returns A hash/dictionary of map host parallel devices. C(parallel=‘“key”:“value”’).,Keys allowed are - (parallel) where 0 ≤ n ≤ 2.,Values allowed are - C(“/dev/parportd+|/dev/usb/lpd+”).

Returns:

  • (Object, nil) —

    A hash/dictionary of map host parallel devices. C(parallel=‘“key”:“value”’).,Keys allowed are - (parallel) where 0 ≤ n ≤ 2.,Values allowed are - C(“/dev/parportd+|/dev/usb/lpd+”).



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

attribute :parallel

#pool ⇒ Object?

Returns Add the new VM to the specified pool.

Returns:

  • (Object, nil) —

    Add the new VM to the specified pool.



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

attribute :pool

#protection ⇒ Symbol?

Returns Enable/disable the protection flag of the VM. This will enable/disable the remove VM and remove disk operations.

Returns:

  • (Symbol, nil) —

    Enable/disable the protection flag of the VM. This will enable/disable the remove VM and remove disk operations.



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

attribute :protection

#reboot ⇒ Symbol?

Returns Allow reboot. If set to C(yes), the VM exit on reboot.

Returns:

  • (Symbol, nil) —

    Allow reboot. If set to C(yes), the VM exit on reboot.



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

attribute :reboot

#revert ⇒ Array<String>, ...

Returns Revert a pending change.

Returns:

  • (Array<String>, String, nil) —

    Revert a pending change.



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

attribute :revert

#sata ⇒ Object?

Returns A hash/dictionary of volume used as sata hard disk or CD-ROM. C(sata=‘“key”:“value”’).,Keys allowed are - C(sata) where 0 ≤ n ≤ 5.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).

Returns:

  • (Object, nil) —

    A hash/dictionary of volume used as sata hard disk or CD-ROM. C(sata=‘“key”:“value”’).,Keys allowed are - C(sata) where 0 ≤ n ≤ 5.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).



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

attribute :sata

#scsi ⇒ Object?

Returns A hash/dictionary of volume used as SCSI hard disk or CD-ROM. C(scsi=‘“key”:“value”’).,Keys allowed are - C(sata) where 0 ≤ n ≤ 13.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).

Returns:

  • (Object, nil) —

    A hash/dictionary of volume used as SCSI hard disk or CD-ROM. C(scsi=‘“key”:“value”’).,Keys allowed are - C(sata) where 0 ≤ n ≤ 13.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).



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

attribute :scsi

#scsihw ⇒ :lsi, ...

Returns Specifies the SCSI controller model.

Returns:

  • (:lsi, :lsi53c810, :"virtio-scsi-pci", :"virtio-scsi-single", :megasas, :pvscsi, nil) —

    Specifies the SCSI controller model.



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

attribute :scsihw

#serial ⇒ Object?

Returns A hash/dictionary of serial device to create inside the VM. C(‘“key”:“value”’).,Keys allowed are - serial(str; required) where 0 ≤ n ≤ 3.,Values allowed are - C((/dev/.+|socket)).,/!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.

Returns:

  • (Object, nil) —

    A hash/dictionary of serial device to create inside the VM. C(‘“key”:“value”’).,Keys allowed are - serial(str; required) where 0 ≤ n ≤ 3.,Values allowed are - C((/dev/.+|socket)).,/!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.



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

attribute :serial

#shares ⇒ Object?

Returns Rets amount of memory shares for auto-ballooning. (0 - 50000).,The larger the number is, the more memory this VM gets.,The number is relative to weights of all other running VMs.,Using 0 disables auto-ballooning, this means no limit.

Returns:

  • (Object, nil) —

    Rets amount of memory shares for auto-ballooning. (0 - 50000).,The larger the number is, the more memory this VM gets.,The number is relative to weights of all other running VMs.,Using 0 disables auto-ballooning, this means no limit.



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

attribute :shares

#skiplock ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :skiplock

#smbios ⇒ Object?

Returns Specifies SMBIOS type 1 fields.

Returns:

  • (Object, nil) —

    Specifies SMBIOS type 1 fields.



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

attribute :smbios

#snapname ⇒ Object?

Returns The name of the snapshot. Used only with clone.

Returns:

  • (Object, nil) —

    The name of the snapshot. Used only with clone.



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

attribute :snapname

#sockets ⇒ Integer?

Returns Sets the number of CPU sockets. (1 - N).

Returns:

  • (Integer, nil) —

    Sets the number of CPU sockets. (1 - N).



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

attribute :sockets

#startdate ⇒ Object?

Returns 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’).

Returns:

  • (Object, nil) —

    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’).



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

attribute :startdate

#startup ⇒ Object?

Returns Startup and shutdown behavior. C([d+] [,up=d+] [,down=d+]).,Order is a non-negative number defining the general startup order.,Shutdown in done with reverse ordering.

Returns:

  • (Object, nil) —

    Startup and shutdown behavior. C([d+] [,up=d+] [,down=d+]).,Order is a non-negative number defining the general startup order.,Shutdown in done with reverse ordering.



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

attribute :startup

#state ⇒ :present, ...

Returns Indicates desired state of the instance.,If C(current), the current state of the VM will be fecthed. You can access it with C(results.status).

Returns:

  • (:present, :started, :absent, :stopped, :restarted, :current, nil) —

    Indicates desired state of the instance.,If C(current), the current state of the VM will be fecthed. You can access it with C(results.status)



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

attribute :state

#storage ⇒ String?

Returns Target storage for full clone.

Returns:

  • (String, nil) —

    Target storage for full clone.



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

attribute :storage

#tablet ⇒ :yes, ...

Returns Enables/disables the USB tablet device.

Returns:

  • (:yes, :no, nil) —

    Enables/disables the USB tablet device.



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

attribute :tablet

#target ⇒ Object?

Returns Target node. Only allowed if the original VM is on shared storage.,Used only with clone.

Returns:

  • (Object, nil) —

    Target node. Only allowed if the original VM is on shared storage.,Used only with clone



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

attribute :target

#tdf ⇒ Symbol?

Returns Enables/disables time drift fix.

Returns:

  • (Symbol, nil) —

    Enables/disables time drift fix.



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

attribute :tdf

#template ⇒ :yes, ...

Returns Enables/disables the template.

Returns:

  • (:yes, :no, nil) —

    Enables/disables the template.



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

attribute :template

#timeout ⇒ Integer?

Returns Timeout for operations.

Returns:

  • (Integer, nil) —

    Timeout for operations.



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

attribute :timeout

#update ⇒ :yes, ...

Returns 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). Per example updating C(net) update the MAC address and C(virtio) create always new disk…

Returns:

  • (:yes, :no, nil) —

    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). Per example updating C(net) update the MAC address and C(virtio) create always new disk…



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

attribute :update

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



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

attribute :validate_certs

#vcpus ⇒ Integer?

Returns Sets number of hotplugged vcpus.

Returns:

  • (Integer, nil) —

    Sets number of hotplugged vcpus.



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

attribute :vcpus

#vga ⇒ :std, ...

Returns Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option ‘std’ or ‘vmware’.

Returns:

  • (:std, :cirrus, :vmware, :qxl, :serial0, :serial1, :serial2, :serial3, :qxl2, :qxl3, :qxl4, nil) —

    Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option ‘std’ or ‘vmware’.



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

attribute :vga

#virtio ⇒ Hash?

Returns A hash/dictionary of volume used as VIRTIO hard disk. C(virtio=‘“key”:“value”’).,Keys allowed are - C(virto) where 0 ≤ n ≤ 15.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).

Returns:

  • (Hash, nil) —

    A hash/dictionary of volume used as VIRTIO hard disk. C(virtio=‘“key”:“value”’).,Keys allowed are - C(virto) where 0 ≤ n ≤ 15.,Values allowed are - C(“storage:size,format=value”).,C(storage) is the storage identifier where to create the disk.,C(size) is the size of the disk in GB.,C(format) is the drive’s backing file’s data format. C(qcow2|raw|subvol).



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

attribute :virtio

#vmid ⇒ Integer?

Returns Specifies the VM ID. Instead use I(name) parameter.,If vmid is not set, the next available VM ID will be fetched from ProxmoxAPI.

Returns:

  • (Integer, nil) —

    Specifies the VM ID. Instead use I(name) parameter.,If vmid is not set, the next available VM ID will be fetched from ProxmoxAPI.



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

attribute :vmid

#watchdog ⇒ Object?

Returns Creates a virtual hardware watchdog device.

Returns:

  • (Object, nil) —

    Creates a virtual hardware watchdog device.



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

attribute :watchdog