VhtddlmZmZmZeZdZdZdZddl Z ddl Z ddl m Z ddl mZddlmZmZdd lmZdd lmZd Zd ZGd deZdZedk(reyy))absolute_importdivisionprint_functionu+Y module: proxmox_kvm short_description: Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster description: - Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster. author: "Abdoul Bah (@helldorado) " attributes: check_mode: support: none diff_mode: support: none options: archive: description: - Specify a path to an archive to restore (instead of creating or cloning a VM). type: str acpi: description: - Specify if ACPI should be enabled/disabled. type: bool agent: description: - Specify if the QEMU Guest Agent should be enabled/disabled. type: str args: description: - Pass arbitrary arguments to kvm. - This option is for experts only! type: str audio: description: - A hash/dictionary of audio devices for the VM. O(audio={"key":"value", "key":"value"}). - Keys allowed are - C(audio[n]) where 0 ≤ n ≤ N. - Values allowed are - C(device="ich9-intel-hda|intel-hda|AC97",driver="none|spice"). - C(device) is either V(ich9-intel-hda) or V(intel-hda) or V(AC97). - Option C(driver) is V(none) or V(spice). type: dict autostart: description: - Specify if the VM should be automatically restarted after crash (currently ignored in PVE API). type: bool balloon: description: - Specify the amount of RAM for the VM in MB. - Using zero disables the balloon driver. type: int bios: description: - Specify the BIOS implementation. type: str choices: ['seabios', 'ovmf'] boot: description: - Specify the boot order -> boot on floppy V(a), hard disk V(c), CD-ROM V(d), or network V(n). - For newer versions of Proxmox VE, use a boot order like V(order=scsi0;net0;hostpci0). - You can combine to set order. - Network boot requires setting V(rng0) since PVE 8.3.5. type: str bootdisk: description: - Enable booting from specified disk. Format V((ide|sata|scsi|virtio\)\\d+). type: str cicustom: description: - 'Cloud-init: Specify custom files to replace the automatically generated ones at start.' type: str cipassword: description: - 'Cloud-init: password of default user to create.' type: str citype: description: - 'Cloud-init: Specifies the cloud-init configuration format.' - The default depends on the configured operating system type (V(ostype)). - We use the V(nocloud) format for Linux, and V(configdrive2) for Windows. type: str choices: ['nocloud', 'configdrive2'] ciupgrade: description: - 'Cloud-init: do an automatic package upgrade after the first boot.' type: bool ciuser: description: - 'Cloud-init: username of default user to create.' type: str clone: description: - Name of VM to be cloned. If O(vmid) is set, O(clone) can take an arbitrary value but is required for initiating the clone. type: str cores: description: - Specify number of cores per socket. type: int cpu: description: - Specify emulated CPU type. type: str cpulimit: description: - Specify if CPU usage will be limited. Value V(0) indicates no CPU limit. - If the computer has 2 CPUs, it has total of '2' CPU time. type: int cpuunits: description: - Specify CPU weight for a VM. - You can disable fair-scheduler configuration by setting this to V(0). type: int delete: description: - Specify a list of settings you want to delete. type: str description: description: - Specify the description for the VM. Only used on the configuration web interface. - This is saved as comment inside the configuration file. type: str digest: description: - Specify if to prevent changes if current configuration file has different SHA1 digest. - This can be used to prevent concurrent modifications. type: str efidisk0: description: - Specify a hash/dictionary of EFI disk options. - Requires O(bios=ovmf) to be set to be able to use it. type: dict suboptions: storage: description: - V(storage) is the storage identifier where to create the disk. type: str format: description: - V(format) is the drive's backing file's data format. Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. type: str efitype: description: - V(efitype) indicates the size of the EFI disk. - V(2m) will allow for a 2MB EFI disk, which will be enough to persist boot order and new boot entries. - V(4m) will allow for a 4MB EFI disk, which will additionally allow to store EFI keys in order to enable Secure Boot. type: str choices: - 2m - 4m pre_enrolled_keys: description: - V(pre_enrolled_keys) indicates whether EFI keys for Secure Boot should be enrolled V(1) in the VM firmware upon creation or not (0). - If set to V(1), Secure Boot will also be enabled by default when the VM is created. type: bool force: description: - Allow to force stop VM. - Can be used with states V(stopped), V(restarted), and V(absent). - Requires parameter O(archive). type: bool format: description: - Target drive's backing file's data format. - Used only with clone. - Use O(format=unspecified) and O(full=false) for a linked clone. - Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. - Not specifying this option is equivalent to setting it to V(unspecified). type: str choices: ["cloop", "cow", "qcow", "qcow2", "qed", "raw", "vmdk", "unspecified"] freeze: description: - Specify if PVE should freeze CPU at startup (use 'c' monitor command to start execution). type: bool full: description: - 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. type: bool default: true hookscript: description: - Script that will be executed during various steps in the containers lifetime. type: str hostpci: description: - Specify a hash/dictionary of map host pci devices into guest. O(hostpci='{"key":"value", "key":"value"}'). - Keys allowed are - C(hostpci[n]) where 0 ≤ n ≤ N. - Values allowed are - V("host="HOSTPCIID[;HOSTPCIID2...]",pcie="1|0",rombar="1|0",x-vga="1|0""). - The C(host) parameter is Host PCI device pass through. HOSTPCIID syntax is V(bus:dev.func) (hexadecimal numbers). - V(pcie=boolean) V(default=0) Choose the PCI-express bus (needs the q35 machine model). - V(rombar=boolean) V(default=1) Specify whether or not the device's ROM will be visible in the guest's memory map. - V(x-vga=boolean) V(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. type: dict hotplug: description: - Selectively enable hotplug features. - This is a comma separated list of hotplug features V(network), V(disk), V(cpu), V(memory), and V(usb). - Value 0 disables hotplug completely and value 1 is an alias for the default V(network,disk,usb). type: str hugepages: description: - Enable/disable hugepages memory. type: str choices: ['any', '2', '1024'] ide: description: - A hash/dictionary of volume used as IDE hard disk or CD-ROM. O(ide='{"key":"value", "key":"value"}'). - Keys allowed are - V(ide[n]) where 0 ≤ n ≤ 3. - Values allowed are - V("storage:size,format=value"). - V(storage) is the storage identifier where to create the disk. - V(size) is the size of the disk in GB. - V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. type: dict ipconfig: description: - 'Cloud-init: Set the IP configuration.' - A hash/dictionary of network IP configurations. O(ipconfig='{"key":"value", "key":"value"}'). - Keys allowed are - V(ipconfig[n]) where 0 ≤ n ≤ network interfaces. - Values allowed are - V("[gw=] [,gw6=] [,ip=] [,ip6=]"). - 'Cloud-init: Specify IP addresses and gateways for the corresponding interface.' - IP addresses use CIDR notation, gateways are optional but they should be in the same subnet of specified IP address. - The special string V(dhcp) can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. - For IPv6 the special string V(auto) can be used to use stateless autoconfiguration. - If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. type: dict keyboard: description: - Sets the keyboard layout for VNC server. type: str kvm: description: - Enable/disable KVM hardware virtualization. type: bool localtime: description: - Sets the real time clock to local time. - This is enabled by default if ostype indicates a Microsoft OS. type: bool lock: description: - Lock/unlock the VM. type: str choices: ['migrate', 'backup', 'snapshot', 'rollback'] machine: description: - Specifies the Qemu machine type. - Type => V((pc|pc(-i440fx\)?-\\d+\\.\\d+(\\.pxe\)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe\)?\)). type: str memory: description: - Memory size in MB for instance. type: int migrate: description: - Migrate the VM to O(node) if it is on another node. type: bool default: false migrate_downtime: description: - Sets maximum tolerated downtime (in seconds) for migrations. type: int migrate_speed: description: - Sets maximum speed (in MB/s) for migrations. - A value of 0 is no limit. type: int name: description: - Specifies the VM name. Name could be non-unique across the cluster. - Required only for O(state=present). - With O(state=present) if O(vmid) not provided and VM with name exists in the cluster then no changes will be made. type: str nameservers: description: - 'Cloud-init: DNS server IP address(es).' - If unset, PVE host settings are used. type: list elements: str net: description: - A hash/dictionary of network interfaces for the VM. O(net='{"key":"value", "key":"value"}'). - Keys allowed are - C(net[n]) where 0 ≤ n ≤ N. - Values allowed are - C("model="XX:XX:XX:XX:XX:XX",bridge="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. type: dict newid: description: - VMID for the clone. Used only with clone. - If newid is not set, the next available VM ID will be fetched from ProxmoxAPI. type: int numa: description: - A hash/dictionaries of NUMA topology. O(numa='{"key":"value", "key":"value"}'). - Keys allowed are - V(numa[n]) where 0 ≤ n ≤ N. - Values allowed are - V("cpu="",hostnodes="",memory="number",policy="(bind|interleave|preferred)""). - V(cpus) CPUs accessing this NUMA node. - V(hostnodes) Host NUMA nodes to use. - V(memory) Amount of memory this NUMA node provides. - V(policy) NUMA allocation policy. type: dict numa_enabled: description: - Enables NUMA. type: bool onboot: description: - Specifies whether a VM will be started during system bootup. type: bool ostype: description: - 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. type: str choices: ['other', 'wxp', 'w2k', 'w2k3', 'w2k8', 'wvista', 'win7', 'win8', 'win10', 'win11', 'l24', 'l26', 'solaris'] parallel: description: - A hash/dictionary of map host parallel devices. O(parallel='{"key":"value", "key":"value"}'). - Keys allowed are - (parallel[n]) where 0 ≤ n ≤ 2. - Values allowed are - C("/dev/parport\d+|/dev/usb/lp\d+"). type: dict protection: description: - Enable/disable the protection flag of the VM. This will enable/disable the remove VM and remove disk operations. type: bool reboot: description: - Allow reboot. If set to V(true), the VM exit on reboot. type: bool revert: description: - Revert a pending change. type: str rng0: description: Randomness source for RNG device, for example V(/dev/urandom). type: str version_added: 1.0.0 sata: description: - A hash/dictionary of volume used as sata hard disk or CD-ROM. O(sata='{"key":"value", "key":"value"}'). - Keys allowed are - C(sata[n]) 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). Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. type: dict scsi: description: - A hash/dictionary of volume used as SCSI hard disk or CD-ROM. O(scsi='{"key":"value", "key":"value"}'). - Keys allowed are - C(scsi[n]) 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). Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. type: dict scsihw: description: - Specifies the SCSI controller model. type: str choices: ['lsi', 'lsi53c810', 'virtio-scsi-pci', 'virtio-scsi-single', 'megasas', 'pvscsi'] searchdomains: description: - 'Cloud-init: Sets DNS search domain(s).' - If unset, PVE host settings are used. type: list elements: str serial: description: - A hash/dictionary of serial device to create inside the VM. V('{"key":"value", "key":"value"}'). - Keys allowed are - serial[n](str; required) where 0 ≤ n ≤ 3. - Values allowed are - V((/dev/.+|socket\)). - /!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care. type: dict shares: description: - 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. type: int skiplock: description: - Ignore locks. - Only root is allowed to use this option. type: bool smbios: description: - Specifies SMBIOS type 1 fields. - Comma separated, Base64 encoded (optional) SMBIOS properties:. - V([base64=<1|0>] [,family=]). - V([,manufacturer=]). - V([,product=]). - V([,serial=]). - V([,sku=]). - V([,uuid=]). - V([,version=]). type: str snapname: description: - The name of the snapshot. Used only with clone. type: str sockets: description: - Sets the number of CPU sockets. (1 - N). type: int sshkeys: description: - 'Cloud-init: SSH key to assign to the default user. NOT TESTED with multiple keys but a multi-line value should work.' type: str startdate: description: - Sets the initial date of the real time clock. - Valid format for date are V('now') or V('2016-09-25T16:01:21') or V('2016-09-25'). type: str startup: description: - Startup and shutdown behavior. V([[order=]\\d+] [,up=\\d+] [,down=\\d+]). - Order is a non-negative number defining the general startup order. - Shutdown in done with reverse ordering. type: str state: description: - Indicates desired state of the instance. - If V(current), the current state of the VM will be fetched. You can access it with C(results.status). type: str choices: ['present', 'started', 'absent', 'stopped', 'restarted', 'current', 'template', 'paused', 'hibernated'] default: present storage: description: - Target storage for full clone. type: str tablet: description: - Enables/disables the USB tablet device. type: bool tags: description: - List of tags to apply to the VM instance. - Tags must start with V([a-z0-9_]) followed by zero or more of the following characters V([a-z0-9_-+.]). - Tags are only available in Proxmox 6+. type: list elements: str target: description: - Target node. Only allowed if the original VM is on shared storage. - Used only with clone. type: str tdf: description: - Enables/disables time drift fix. type: bool template: description: - Enables/disables the template. type: bool timeout: description: - Timeout for operations. - When used with O(state=stopped) the option sets a graceful timeout for VM stop after which a VM will be forcefully stopped. type: int default: 30 tpmstate0: description: - A hash/dictionary of options for the Trusted Platform Module disk. - A TPM state disk is required for Windows 11 installations. suboptions: storage: description: - O(tpmstate0.storage) is the storage identifier where to create the disk. type: str required: true version: description: - The TPM version to use. type: str choices: ['1.2', '2.0'] default: '2.0' type: dict usb: description: - A hash/dictionary of USB devices for the VM. O(usb='{"key":"value", "key":"value"}'). - Keys allowed are - C(usb[n]) where 0 ≤ n ≤ N. - Values allowed are - C(host="value|spice",mapping="value",usb3="1|0"). - Host is either C(spice) or the USB id/port. - Option C(mapping) is the mapped USB device name. - Option C(usb3) enables USB 3 support. type: dict update: description: - If V(true), the VM will be updated with new value. - Because of the operations of the API and security reasons, I have disabled the update of the following parameters O(net), O(virtio), O(ide), O(sata), O(scsi). Per example updating O(net) update the MAC address and O(virtio) create always new disk... This security feature can be disabled by setting the O(update_unsafe) to V(true). - Update of O(pool) is disabled. It needs an additional API endpoint not covered by this module. type: bool default: false update_unsafe: description: - If V(true), do not enforce limitations on parameters O(net), O(virtio), O(ide), O(sata), O(scsi), O(efidisk0), and O(tpmstate0). Use this option with caution because an improper configuration might result in a permanent loss of data (for example disk recreated). type: bool default: false vcpus: description: - Sets number of hotplugged vcpus. type: int vga: description: - Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option V(std) or V(vmware). type: str choices: ['std', 'cirrus', 'vmware', 'qxl', 'serial0', 'serial1', 'serial2', 'serial3', 'qxl2', 'qxl3', 'qxl4'] virtio: description: - A hash/dictionary of volume used as VIRTIO hard disk. O(virtio='{"key":"value", "key":"value"}'). - Keys allowed are - V(virtio[n]) where 0 ≤ n ≤ 15. - Values allowed are - V(storage:size,format=value). - V(storage) is the storage identifier where to create the disk. - V(size) is the size of the disk in GB. - V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by the provided storage backend. type: dict watchdog: description: - Creates a virtual hardware watchdog device. type: str seealso: - module: community.proxmox.proxmox_vm_info extends_documentation_fragment: - community.proxmox.proxmox.actiongroup_proxmox - community.proxmox.proxmox.documentation - community.proxmox.proxmox.selection - community.proxmox.attributes a - name: Create new VM with minimal options community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf - name: Create a VM from archive (backup) community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado archive: backup-storage:backup/vm/140/2023-03-08T06:41:23Z name: spynal - name: Create new VM with minimal options and given vmid community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf vmid: 100 - name: Create new VM with two network interface options community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf net: net0: 'virtio,bridge=vmbr1,rate=200' net1: 'e1000,bridge=vmbr2' - name: Create new VM with one network interface, three virto hard disk, 4 cores, and 2 vcpus community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf net: net0: 'virtio,bridge=vmbr1,rate=200' virtio: virtio0: 'VMs_LVM:10' virtio1: 'VMs:2,format=qcow2' virtio2: 'VMs:5,format=raw' cores: 4 vcpus: 2 - name: Create VM with 1 10GB SATA disk and an EFI disk, with Secure Boot disabled by default community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf sata: sata0: 'VMs_LVM:10,format=raw' bios: ovmf efidisk0: storage: VMs_LVM_thin format: raw efitype: 4m pre_enrolled_keys: false - name: Create VM with 1 10GB SATA disk and an EFI disk, with Secure Boot enabled by default community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf sata: sata0: 'VMs_LVM:10,format=raw' bios: ovmf efidisk0: storage: VMs_LVM format: raw efitype: 4m pre_enrolled_keys: 1 - name: > Clone VM with only source VM name. The VM source is spynal. The target VM name is zavala community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado clone: spynal name: zavala node: sabrewulf storage: VMs format: qcow2 timeout: 500 - name: > Create linked clone VM with only source VM name. The VM source is spynal. The target VM name is zavala community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado clone: spynal name: zavala node: sabrewulf storage: VMs full: false format: unspecified timeout: 500 - name: Clone VM with source vmid and target newid and raw format community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado clone: arbitrary_name vmid: 108 newid: 152 name: zavala node: sabrewulf storage: LVM_STO format: raw timeout: 300 - name: Create new VM and lock it for snapshot community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf lock: snapshot - name: Create new VM and set protection to disable the remove VM and remove disk operations community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf protection: true - name: Create new VM using cloud-init with a username and password community.proxmox.proxmox_kvm: node: sabrewulf api_user: root@pam api_password: secret api_host: helldorado name: spynal ide: ide2: 'local:cloudinit,format=qcow2' ciuser: mylinuxuser cipassword: supersecret searchdomains: 'mydomain.internal' nameservers: 1.1.1.1 net: net0: 'virtio,bridge=vmbr1,tag=77' ipconfig: ipconfig0: 'ip=192.168.1.1/24,gw=192.168.1.1' - name: Create new VM using Cloud-Init with an ssh key community.proxmox.proxmox_kvm: node: sabrewulf api_user: root@pam api_password: secret api_host: helldorado name: spynal ide: ide2: 'local:cloudinit,format=qcow2' sshkeys: 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILJkVm98B71lD5XHfihwcYHE9TVpsJmK1vR1JcaU82L+' searchdomains: 'mydomain.internal' nameservers: - '1.1.1.1' - '8.8.8.8' net: net0: 'virtio,bridge=vmbr1,tag=77' ipconfig: ipconfig0: 'ip=192.168.1.1/24' - name: Start VM community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: started - name: Stop VM community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: stopped - name: Stop VM with force community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: stopped force: true - name: Restart VM community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: restarted - name: Convert VM to template community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: template - name: Convert VM to template (stop VM if running) community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: template force: true - name: Remove VM community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: absent - name: Get VM current state community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf state: current - name: Update VM configuration community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf cores: 8 memory: 16384 update: true - name: Update VM configuration (incl. unsafe options) community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf cores: 8 memory: 16384 net: net0: virtio,bridge=vmbr1 update: true update_unsafe: true - name: Delete QEMU parameters community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf delete: 'args,template,cpulimit' - name: Revert a pending change community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf revert: 'template,cpulimit' - name: Migrate VM on second node community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado name: spynal node: sabrewulf-2 migrate: true - name: Add hookscript to existing VM community.proxmox.proxmox_kvm: api_user: root@pam api_password: secret api_host: helldorado vmid: 999 node: sabrewulf hookscript: local:snippets/hookscript.pl update: true aV vmid: description: The VM vmid. returned: success type: int sample: 115 status: description: The current virtual machine status. returned: success, not clone, not absent, not update type: str sample: running msg: description: A short message. returned: always type: str sample: "VM kropta with vmid = 110 is running" N)quote) LooseVersion)proxmox_auth_argument_specProxmoxAnsible) AnsibleModule)booleancLtjd|jdS)Nz=(.*?),researchgroup)netstrs q/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/proxmox/plugins/modules/proxmox_kvm.py parse_macrs 99Y ' - -a 00cLtjd|jdS)Nz (.*?)(,|$)r r)devstrs r parse_devrs 99\6 * 0 0 33rcHeZdZdZdZdZdZdZdZdZ dZ d Z d Z y ) ProxmoxKvmAnsiblec Diai}i} |jj|j|jj }|jD cic] \}} |  ||  }}} t|jD]-}t||ts|j||||=/tj d} tj d} |jD]H}| j#|rt%|||<&| j#|s8t'|||<J|td<|td<t)|td<y#t $r-}|jjd|d|Yd}~Jd}~wwxYwcc} }w) Nz'Getting information for VM with vmid =  failed with exception: msgznet[0-9]z#(virtio|ide|scsi|sata|efidisk)[0-9]macdevicesvmid)results proxmox_apinodesqemuconfigget Exceptionmodule fail_jsonitemslistkeys isinstancedictupdatercompilematchrrint) selfnoder!kwargsrr vmekvre_netre_devs r get_vminfozProxmoxKvmAnsible.get_vminfosw y!!''-2248??CCEB $*<<>C41aQ]!Q$CCfkkm$ A&)T* fQi(1I  K(BC .A||A"2a5)Aa&r!u-  . $ d)1 y KK ! !osuv&w ! x x yDs$AE# F(F# F,"FFc |jj|}|jDcic] \}}| || }}}|j|jj di|duScc}}w)N)r#r$r+r%r&set)r4r!r5r6 proxmox_noder9r:s rsettingszProxmoxKvmAnsible.settingssq''--d3 $*<<>C41aQ]!Q$CC1|  &--11;F;tCCDs A/A/c|jjd}|jjddk(r|dz }|rL|j||rtjdy|dz }|dk(r ytjd|rLy) Ntimeoutstatestopped r TrF)r)params api_task_oktimesleep)r4r5taskidrDs r wait_for_taskzProxmoxKvmAnsible.wait_for_tasks++$$Y/ ;;  g &) 3 rMGf- 1 kG!| JJqMrc gd} gd} dg}gd}i}dj|}|jj|}| jDcic] \}}| || } }}| j | jDcic]"\}}t |t s|t|$c}}|j}|tdkrdn|jd}|d kr| D] }|| vs| |= |d kr| D] }|| vs| |= |d kr|D] }|| vs| |= d | vrt| d d }t|| d <| rC| dur1d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr| d=d| vr(d| vsd| dk7r|jjdd| vrd }tjd}d| dvr.|| dj!ddzz }| dj#d|d j%| djDcgc]+\}}d|k7r!|j'd!|d"zt|z-c}}z }|| d<d| vr:d#j| dj!d| dj!d$%| d<t)| j+D]-}t | |t,s| j | || |=/d&| vr tt/| d&d'(| d&<d)| vr | d)| d*<| d)=d+|jj2vr;|jj2j#d+}|rd,j%|| d-<d.|jj2vr;|jj2j#d.}|rd,j%|| d/<d0| vrgtjd1}| d0D]3}|j5|r|jjd2|z5d j%| d0| d0<|jj2d3d4k(r6|jj2d5|jj2d5| d5<nQ|jj2d3d4k7r5|jj2d5|jjd6|jj2d3d4k7r5|jj2d7|jjd8| r3|j7|j8j:d?|||||d9| y'y|jj2d:|D]8}|jj2||jj2|||<:|j |jDcic]"\}}t |t s|t|$c}}|j7|j<j>d?||d;|} n#|j6j@d?||||||d<| } |jC|| sJ|jjd=|jE| jFj!dd>zyy'cc}}wcc}}wcc}}w#t0$rYwxYwcc}}w)@N)force protectionskiplock)ciuser cipasswordsshkeysipconfigtags ciupgrade)formatfullpoolsnapnamestoragetargetz:-serial unix:/var/run/qemu-server/{0}.serial,server,nowaitz4.0rrT)safeFvirtiosatascsiideefidisk0 tpmstate0netrOrZbiosovmfz4efidisk0 cannot be used if bios is not set to ovmf. r_r\z:1,,-=z{storage}:1,version=v{version}versionr\rqagentT)strict numa_enablednuma nameservers nameserver searchdomains searchdomainrVz!^[a-zA-Z0-9_][a-zA-Z0-9_\-\+\.]*$z%s is not a valid tagapi_userzroot@pamargsz&args parameter require root@pam user. rQz*skiplock parameter require root@pam user. )namememorycpucoressocketsclone)newidr~)r!r~rrrrzSReached timeout while waiting for creating VM. Last line in task before timeout: %sr r?)$rXr#r$r+r0r.boolr3rqrrstrr)r*rr1r'popjoinsubr,r-r/r TypeErrorrHr2r%r&r@rpostcreaterMtaskslog)!r4r!rr5r~rrrrr0 update_unsafer6only_v4only_v6only_v8valid_clone_params clone_paramsvm_argsrAr9r:rqpve_major_versionpurlencoded_ssh_keys efidisk0_str hyphen_rerwrzre_tagtagparamrLs! r create_vmzProxmoxKvmAnsible.create_vmsG5I-Y NUUVZ[''--d3 $*<<>C41aQ]!Q$CC V\\^STQz!T?Rq#a&yST,,.!(<+>!>AGOOTUDV q  ";q  " q  ";q  " q  ";q  "  "'y(9"C  #$7 8F9  %v%x(V#vV#vF?u 'z*&({+F?u & 7O6N  f$&F6N*B %%*`%a  L 4(IF:..z 2 6 6y AE II z"&&y1 CHHW]^hWiWoWoWq&9tqRS)2a'0mmC&;c&ACF&J&9: :L!-F:  & "B"I"I{+// :{+// :#J#F; fkkm$ A&)T* fQi(1I  f  "%gfWod&K"Lw V ##N3F6N~& DKK.. .++,,00?K'*xx '<|$ dkk00 0 KK..22?CM),-)@~& V ZZ DEFf~ M||C(KK)).E.K)L M!XXfVn5F6N ;;  j )Z 7DKKP>PQW>X>d KK ! !&N ! O ;;  j )Z 7DKK>@|O`O`aeOfOmOmOtOtOyOyO{F%%bj&9 %%+A*6*<*tdd?/d@td dAtd dBtddCtdDdEdFtd dGtd dHtdItd dJtddKtddLtgdMdNtd dOtddPtddQtddRtddStddTtd dUtd dVtgdWdXtd dYtdDdEdZtd d[tdd\tdd]tdd^td d_tdd?d`tddatdbtdcgddedftddgtddhtdDdEditddjtddktddltd dm/dntd ttddotddpdqgdprs)dttd dutdd?/dvtdd?/dwtd dxtgdydztd d{td d|t}|j|t|gd}d~gddgdbdcdHgfg}|jd}|jd}|jd}|jd"}|jd>}|jd=}|jdB} |jdG} |jdH} |jdR} |jd^} |jdb}t |jdu}t |jdv}|jd{}|jd}|jd+dk(rd|jd+<t |}|sR|dck(r4|s2|s0|s.| s,|s*|j| d}|r|}n+ |j}n|xs| }|j|d}|i| s |j} |s|jd|z|j||j| dr|jd?|d| d| d|9 |j|| ||jd|dj| || 9 |j|| | |jd|dj| ||rx |j|}|dH}| |k7r8|j!|| |jd|dj||| n$|jd?|dj|| |dck(r|s-|s+|j|dr|jd?|d|zn|s>|s<|s:|j| dr'|jd?|j| d| zn]| s|jdnH|r t#|| gs|jdn&|j%| s|jd| z |j&|| | | |||| ||f id|jdd|jdd|jdd|jdd |jd d |jd d |jd d|jdd|jdd|jdd|jdd|jdd|jdd|jdd |jd d!|jd!d#|jd#d$|jd$d%|jd%d*|jd*d-|jd-d0|jd0d1|jd1d2|jd2d3|jd3d5|jd5d6|jd6d7|jd7d8|jd8d9|jd9d:|jd:d<|jd<d@|jd@dA|jdAdF|jdFdI|jdIdJ|jdJdK|jdKdL|jdLdN|jdNdO|jdOdP|jdPdQ|jdQdS|jdSdT|jdTdU|jdUdV|jdVdX|jdXdZ|jdZd[|jd[d|jd\d]|jd]d_|jd_d`|jd`da|jdadg|jdgdh|jdhdi|jdidj|jdjdk|jdkdn|jdndt|jdtdw|jdwdx|jdxdz|jdzd||jd||sY|j)| ||jd5|jdF|jdT|jdU|jdz|r|jd|d| d|dy||jd| d| d| d|y|jddd| d|ddt*y|dk(r|s|jd| zi} |j|}|j,j/|dHj1|j2j4j7d}||d<|dk(r|jdd?|d|zd||j9|r|jdd|d|zd|yy|dk(r|s|jd| zi} |j|}|j,j/|dHj1|j2j4j7d}||d<|dk(r|jdd?|d|zd||j;||jd*|jdl|jdd|d|zd|y|dkk(r|s|jd| zi} |j|}|dkdk(r|jdd?|d|zd||j=||jd*|jdlr|jdd|d|zd|yy|dk(r|s|jd| zi}|j|}|j,j/|dHj1|j2j4j7d}||d<|dk(r|jdd?|d|zd||j?||jd*r|jdd|d|zd|yy|dk(rri}|s|jd?d| z |j|d}|s|jd?||j,j/|dH}|j1|j2j4j7d}||d<|dk(rH|jd*r"|j;|d|jdln|jd?|d|z|j0jA|}|jC|dH|s@|jd|jE|jFj7ddzn|jd|d|zyy|dk(ri}|s|jd| z|j|}| s|j7dBdƫ} |j,j/|dHj1|j2j4j7d}||d<|r |jdd?|d| d|d|d|yy|dvr|s|jd| zi} |j|}|j,j/|dHj1|j2j4j7d}||d<|dk7r|jdd?|d|zd||jI||jd*|jdl|dk(˫|jdd|d|zd|yy#t$r%|jdj| Y wxYw#t$r%|jdj| Y wxYw#t$r:}|j|dj| |t|zYd}~ yd}~wwxYw#t$r:}|j|dj| |t|zYd}~ d}~wwxYw#t$r0}|j|dj|| |Yd}~ Fd}~wwxYw#t$r}|r0|j|dj| |t|znN|0|j|dj| |t|zn|j|d| d|d|Yd}~ud}~wwxYw#t$r%}|jd|d|d|d|Yd}~yd}~wwxYw#t$r%}|jd|d|d|d|Yd}~yd}~wwxYw#t$r%}|jd|d|d|d|Yd}~yd}~wwxYw#t$r"}|jd|d|Yd}~yd}~wwxYw#t$r%}|jd|d|d|d|Yd}~yd}~wwxYw)Narchiver)typeacpirrsr}audior/ autostartballoonr3rkseabiosrl)choicesbootbootdiskcicustomrST)rno_logcitypenocloud configdrive2)rrrWrRrrrcpulimitcpuunitsdelete descriptiondigestrh2m4m)r\rXefitypepre_enrolled_keys)roptionsrOrX)cloopcowqcowqcow2qedrawvmdk unspecifiedfreezerY)rdefault hookscripthostpcihotplug hugepages)any21024rgrUkeyboardkvm localtimelock)rbackupsnapshotrollbackmachinerrFmigrate_downtime migrate_speedr~rwr,)relementsrjrr5rvruonbootostype) otherwxpw2kw2k3w2k8wvistawin7win8win10win11l24l26solarisparallelrZrPrrevertrng0rerfscsihw)lsi lsi53c810zvirtio-scsi-pcizvirtio-scsi-singlemegasaspvscsiserialrzsharesrQsmbiosr[rrT startdatestartuprEpresent) rabsentrFstarted restartedrrpaused hibernated)rrr\tabletrVr]tdfrrDri)rrequiredz2.0z1.2)rrrrrusbr0rvcpusvga) stdcirrusvmwareqxlserial0serial1serial2serial3qxl2qxl3qxl4rdr!watchdog))rr)rr0)rr0)rr0)rr)rr) api_token_idapi_token_secret)r~r!) api_passwordr+) argument_specmutually_exclusiverequired_togetherrequired_one_of required_ifvalidate_certsr)ignore_missingzSCan't get the next vmid for VM {0} automatically. Ensure your cluster state is goodrz+VM with name = %s does not exist in clusterzvmid z with VM name z already exists)changedr!r)rz,Settings has deleted on VM {0} with vmid {1}z3Unable to delete settings on VM {0} with vmid {1}: r)rz-Settings has reverted on VM {0} with vmid {1}zTUnable to revert settings on VM {0} with vmid {1}: Maybe is not a pending task... z(VM {0} has been migrated from {1} to {2}zVM {0} is already on {1}z-Unable to migrate VM {0} from {1} to {2}: {3}z VM with vmid <%s> already existsz VM with name <%s> already existsz*node is mandatory for creating/updating VMz)vmid or name is mandatory for updating VMz#node '%s' does not exist in clustersmbios1)rgrjrerfrdz&Unable to update vm {0} with vmid {1}=z%Unable to clone vm {0} from vmid {1}=zcreation of qemu VM z with vmid z failed with exception=zVM z updatedz with newid z cloned from vm with vmid z deployed)r5rrrrzVM %s is already runningz VM %s startedzstarting of VM rrFzVM %s is already stopped)rOrDzVM %s is shutting downzstopping of VM r zVM %s is already a templatezVM %s is converting to templaterrrzVM %s is not running)rOzVM %s is restartedrz#VM with name = %s is already absent)r5r!)rDz?c@(noAcB CcDvt ,EcFU#GcH&!IcJ% KcL34McN f OcP6"QcR5!ScT f UcVF#WcXG HYcZ% [c\]c^&%0_c`5)acb&ccdu ecffu5gch f icjkclVmcnv ocpv&qcr sctIJucv6"wcxu yczV${c| }c~c@u AcBv CcDv EcFnoGcH IcJ7KcLMcN6"OcPQcR5!ScT% UcV%.WcXE"YcZ[c\9/VW]c^% _c` acbv .ccdecf f gch6"icj%,kclF##'UT#B#'UUENTY#Z mcv f wcx/ycz6{c|}c~  Ac@ AcBu CcDEcHHx !]?@)+KLy6(34 F MM' "E -- C MM' "E ]]8 $FmmI&G ]]8 $F == D MM' "E == D ]]8 $FmmI&G MM' "E &--) *F78M == D]]#34N }}X-/"& h'G  I fU6RXah#,,T$,GM$M"//1D!=DL##L#FD  I,,.    !NQV!V  W t >>%> 5   Uglnr;s  t     T4  7   T:h:o:optvz:{  | `   T4  7   T:i:p:pquw{:|  } |%BjGw""2t,  D>h>o>optv}@D?E F  T?Y?`?`aegk?l m %W^^D^%N   U;]`d;d  eETw/?/?UY/?/Z   U1A1A$1GMorvMv  w   !M  N Ct -   !L  M!!$'   !F!M  NR B G  dE4vsE7TZ\iB B&,mmI&>B B#)==#8B B%+MM'$:B B%+MM'$: B B )/ k(B B B '-mmI&> B B$*==#8B B$*==#8B B(.}}Z'@B B(.}}Z'@B B*0|)DB B&,]]8%<B B)/ k(BB B&,]]8%<B B(.}}Z'@B B (.}}Z'@!B B"+1-- *F#B B$&,]]8%<%B B&(.}}Z'@'B B(%+MM'$:)B B*&,]]8%<+B B,*0|)D-B B.'-mmI&>/B B0'-mmI&>1B B2)/ k(B3B B4#)--"65B B6(.}}Z'@7B B8(.}}Z'@9B B:#)--"6;B B<)/ k(B=B B>$*==#8?B B@'-mmI&>AB BB06}}=O/PCB BD-3MM/,JEB BF#)--"6GB BH$*==#8IB BJ,2==+HKB BL&,]]8%kB Bl)/ k(BmB Bn'-mmI&>oB Bp&,]]8%T_X^_$ )    !NQU!U  V q%B))//6 ;@@FMMUUYY[\deG&F8 )#   kT?Y\`?`kdjk OOBfmmG&_bf>fqjpqo +    !NQU!U  V ^^D !%%++BvJ7<  ? F   `T:NQU:U `Y_ ` @ (    U0UX\0\  ] \T:B  T :"..44RZ@L"''-44<<@@B8LG&F8 )#==)OOBfmmI6NOO$$UDBEIDI$J!&&--d3F((FV<  %z!-!3!3F!;!?!?!C!C!Ebq!I&J K  DoPT>T UK )    !NQU!U  V ^^D !66&+.D%%++BvJ7<rNsxA@ h T@ D  $ =[{4=14]]@ `sF  zFr