VhNddlmZmZmZeZdZdZdZddl m Z ddl m Z ddl mZmZddlmZmZmZd ZGd d eZd Zed k(reyy))absolute_importdivisionprint_functiona+ module: proxmox_disk short_description: Management of a disk of a Qemu(KVM) VM in a Proxmox VE cluster version_added: 5.7.0 description: - Allows you to perform some supported operations on a disk in Qemu(KVM) Virtual Machines in a Proxmox VE cluster. author: "Castor Sky (@castorsky) " attributes: check_mode: support: none diff_mode: support: none action_group: version_added: 9.0.0 options: name: description: - The unique name of the VM. - You can specify either O(name) or O(vmid) or both of them. type: str vmid: description: - The unique ID of the VM. - You can specify either O(vmid) or O(name) or both of them. type: int disk: description: - The disk key (V(unused[n]), V(ide[n]), V(sata[n]), V(scsi[n]) or V(virtio[n])) you want to operate on. - Disk buses (IDE, SATA and so on) have fixed ranges of V(n) that accepted by Proxmox API. - 'For IDE: 0-3; for SCSI: 0-30; for SATA: 0-5; for VirtIO: 0-15; for Unused: 0-255.' type: str required: true state: description: - Indicates desired state of the disk. - O(state=present) can be used to create, replace disk or update options in existing disk. It will create missing disk or update options in existing one by default. See the O(create) parameter description to control behavior of this option. - Some updates on options (like O(cache)) are not being applied instantly and require VM restart. - Use O(state=detached) to detach existing disk from VM but do not remove it entirely. When O(state=detached) and disk is V(unused[n]) it will be left in same state (not removed). - O(state=moved) may be used to change backing storage for the disk in bounds of the same VM or to send the disk to another VM (using the same backing storage). - O(state=resized) intended to change the disk size. As of Proxmox 7.2 you can only increase the disk size because shrinking disks is not supported by the PVE API and has to be done manually. - To entirely remove the disk from backing storage use O(state=absent). type: str choices: ['present', 'resized', 'detached', 'moved', 'absent'] default: present create: description: - With O(create) flag you can control behavior of O(state=present). - When O(create=disabled) it will not create new disk (if not exists) but will update options in existing disk. - When O(create=regular) it will either create new disk (if not exists) or update options in existing disk. - When O(create=forced) it will always create new disk (if disk exists it will be detached and left unused). type: str choices: ['disabled', 'regular', 'forced'] default: regular storage: description: - The drive's backing storage. - Used only when O(state) is V(present). type: str size: description: - Desired volume size in GB to allocate when O(state=present) (specify O(size) without suffix). - New (or additional) size of volume when O(state=resized). With the V(+) sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. type: str bwlimit: description: - Override I/O bandwidth limit (in KB/s). - Used only when O(state=moved). type: int delete_moved: description: - Delete the original disk after successful copy. - By default the original disk is kept as unused disk. - Used only when O(state=moved). type: bool target_disk: description: - The config key the disk will be moved to on the target VM (for example, V(ide0) or V(scsi1)). - Default is the source disk key. - Used only when O(state=moved). type: str target_storage: description: - Move the disk to this storage when O(state=moved). - You can move between storages only in scope of one VM. - Mutually exclusive with O(target_vmid). - Consider increasing O(timeout) in case of large disk images or slow storage backend. type: str target_vmid: description: - The (unique) ID of the VM where disk will be placed when O(state=moved). - You can move disk between VMs only when the same storage is used. - Mutually exclusive with O(target_vmid). type: int timeout: description: - Timeout in seconds to wait for slow operations such as importing disk or moving disk between storages. - Used only when O(state) is V(present) or V(moved). type: int default: 600 aio: description: - AIO type to use. type: str choices: ['native', 'threads', 'io_uring'] backup: description: - Whether the drive should be included when making backups. type: bool bps_max_length: description: - Maximum length of total r/w I/O bursts in seconds. type: int bps_rd_max_length: description: - Maximum length of read I/O bursts in seconds. type: int bps_wr_max_length: description: - Maximum length of write I/O bursts in seconds. type: int cache: description: - The drive's cache mode. type: str choices: ['none', 'writethrough', 'writeback', 'unsafe', 'directsync'] cyls: description: - Force the drive's physical geometry to have a specific cylinder count. type: int detect_zeroes: description: - Control whether to detect and try to optimize writes of zeroes. type: bool discard: description: - Control whether to pass discard/trim requests to the underlying storage. type: str choices: ['ignore', 'on'] format: description: - The drive's backing file's data format. type: str choices: ['raw', 'cow', 'qcow', 'qed', 'qcow2', 'vmdk', 'cloop'] heads: description: - Force the drive's physical geometry to have a specific head count. type: int import_from: description: - Import volume from this existing one. - Volume string format. - V(:/) or V(/). - Attention! Only root can use absolute paths. - This parameter is mutually exclusive with O(size). - Increase O(timeout) parameter when importing large disk images or using slow storage. type: str iops: description: - Maximum total r/w I/O in operations per second. - You can specify either total limit or per operation (mutually exclusive with O(iops_rd) and O(iops_wr)). type: int iops_max: description: - Maximum unthrottled total r/w I/O pool in operations per second. type: int iops_max_length: description: - Maximum length of total r/w I/O bursts in seconds. type: int iops_rd: description: - Maximum read I/O in operations per second. - You can specify either read or total limit (mutually exclusive with O(iops)). type: int iops_rd_max: description: - Maximum unthrottled read I/O pool in operations per second. type: int iops_rd_max_length: description: - Maximum length of read I/O bursts in seconds. type: int iops_wr: description: - Maximum write I/O in operations per second. - You can specify either write or total limit (mutually exclusive with O(iops)). type: int iops_wr_max: description: - Maximum unthrottled write I/O pool in operations per second. type: int iops_wr_max_length: description: - Maximum length of write I/O bursts in seconds. type: int iothread: description: - Whether to use iothreads for this drive (only for SCSI and VirtIO). type: bool mbps: description: - Maximum total r/w speed in megabytes per second. - Can be fractional but use with caution - fractionals less than 1 are not supported officially. - You can specify either total limit or per operation (mutually exclusive with O(mbps_rd) and O(mbps_wr)). type: float mbps_max: description: - Maximum unthrottled total r/w pool in megabytes per second. type: float mbps_rd: description: - Maximum read speed in megabytes per second. - You can specify either read or total limit (mutually exclusive with O(mbps)). type: float mbps_rd_max: description: - Maximum unthrottled read pool in megabytes per second. type: float mbps_wr: description: - Maximum write speed in megabytes per second. - You can specify either write or total limit (mutually exclusive with O(mbps)). type: float mbps_wr_max: description: - Maximum unthrottled write pool in megabytes per second. type: float media: description: - The drive's media type. type: str choices: ['cdrom', 'disk'] iso_image: description: - The ISO image to be mounted on the specified in O(disk) CD-ROM. - O(media=cdrom) needs to be specified for this option to work. - Use V(:iso/) to mount ISO. - Use V(cdrom) to access the physical CD/DVD drive. - Use V(none) to unmount image from existent CD-ROM or create empty CD-ROM drive. type: str version_added: 8.1.0 queues: description: - Number of queues (SCSI only). type: int replicate: description: - Whether the drive should considered for replication jobs. type: bool rerror: description: - Read error action. type: str choices: ['ignore', 'report', 'stop'] ro: description: - Whether the drive is read-only. type: bool scsiblock: description: - Whether to use scsi-block for full passthrough of host block device. - Can lead to I/O errors in combination with low memory or high memory fragmentation on host. type: bool secs: description: - Force the drive's physical geometry to have a specific sector count. type: int serial: description: - The drive's reported serial number, url-encoded, up to 20 bytes long. type: str shared: description: - Mark this locally-managed volume as available on all nodes. - This option does not share the volume automatically, it assumes it is shared already! type: bool snapshot: description: - Control qemu's snapshot mode feature. - If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown. type: bool ssd: description: - Whether to expose this drive as an SSD, rather than a rotational hard disk. type: bool trans: description: - Force disk geometry bios translation mode. type: str choices: ['auto', 'lba', 'none'] werror: description: - Write error action. type: str choices: ['enospc', 'ignore', 'report', 'stop'] wwn: description: - The drive's worldwide name, encoded as 16 bytes hex string, prefixed by V(0x). type: str extends_documentation_fragment: - community.general.proxmox.actiongroup_proxmox - community.general.proxmox.documentation - community.general.attributes aJ - name: Create new disk in VM (do not rewrite in case it exists already) community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data name: vm-name disk: scsi3 backup: true cache: none storage: local-zfs size: 5 state: present - name: Create new disk in VM (force rewrite in case it exists already) community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data vmid: 101 disk: scsi3 format: qcow2 storage: local size: 16 create: forced state: present - name: Update existing disk community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data vmid: 101 disk: ide0 backup: false ro: true aio: native state: present - name: Grow existing disk community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data vmid: 101 disk: sata4 size: +5G state: resized - name: Detach disk (leave it unused) community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data name: vm-name disk: virtio0 state: detached - name: Move disk to another storage community.general.proxmox_disk: api_host: node1 api_user: root@pam api_password: secret vmid: 101 disk: scsi7 target_storage: local format: qcow2 state: moved - name: Move disk from one VM to another community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data vmid: 101 disk: scsi7 target_vmid: 201 state: moved - name: Remove disk permanently community.general.proxmox_disk: api_host: node1 api_user: root@pam api_password: secret vmid: 101 disk: scsi4 state: absent - name: Mount ISO image on CD-ROM (create drive if missing) community.general.proxmox_disk: api_host: node1 api_user: root@pam api_token_id: token1 api_token_secret: some-token-data vmid: 101 disk: ide2 media: cdrom iso_image: local:iso/favorite_distro_amd64.iso state: present z vmid: description: The VM vmid. returned: success type: int sample: 101 msg: description: A short message on what the module did. returned: always type: str sample: "Disk scsi3 created in VM 101" ) AnsibleModule) LooseVersion)proxmox_auth_argument_specProxmoxAnsible)compilematchsubc.|jd}|jd}|dvrt|ddd}n.|jd}|d}|d}t|d|||}|j|D]}|jd \}}|||<|S) a Transform Proxmox configuration string for disk element into dictionary which has volume option parsed in '{ storage }:{ volume }' format and other options parsed in '{ option }={ value }' format. This dictionary will be compared afterward with attributes that user passed to this module in playbook. config_string examples: - local-lvm:vm-100-disk-0,ssd=1,discard=on,size=25G - local:iso/new-vm-ignition.iso,media=cdrom,size=70k - none,media=cdrom :param config_string: Retrieved from Proxmox API configuration string :return: Dictionary with volume option divided into parts ('volume_name', 'storage_name', 'volume') and other options as key:value. ,r)nonecdromN)volume storage_name volume_namesize:)rrr=)splitpopdictsort) config_stringconfigstorage_volumeconfig_currentrroptionkvs r/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/proxmox_disk.pydisk_conf_str_to_dictr$s  %FZZ]N**!  (--c2%a( $Q' *K8%#   KKM||C 1q c eZdZgdZeeddeddeddeddeddZd Zd Zd Z d Z y )ProxmoxDiskAnsible)*aiobackupbps_max_lengthbps_rd_max_lengthbps_wr_max_lengthcachecyls detect_zeroesdiscardformatheads import_fromiopsiops_maxiops_max_lengthiops_rd iops_rd_maxiops_rd_max_lengthiops_wr iops_wr_maxiops_wr_max_lengthiothreadmbpsmbps_maxmbps_rd mbps_rd_maxmbps_wr mbps_wr_maxmediaqueues replicatererrorro scsiblocksecsserialsharedsnapshotssdtranswerrorwwnr)idescsisatavirtiounusedc |jjjDcic]3\}}|,||jvr|t |t r t |n|5}}}|Scc}}w)N)moduleparamsitemscreate_update_fields isinstanceboolint)selfr!r"r^s r#get_create_attributesz(ProxmoxDiskAnsible.get_create_attributessj **002 1}d&?&?!? At,s1v! 3    s8A%c>|jjd}|dk(r||vr dd|d|dfSd}|dk(r||vs|d k(r7|j}|jd d }|jjj d d } |r&|jjd ddd|} d}d} n| | } d} n|jjd } | s|jj d|jjj ddk7r| d|jjdzz } d} d}|j D]\} } | d| d| z } |jjd| i}|dvr||vrd } |jjj d d } t||}|j}|jd d | | } n|d!} |j D]\} } | d| d| z } d"D]}|j|||i| | |d!<|j D cic]\} } | t| }} } ||k(r dd|d#|fS|jjd| i}|jj|d$j|jjd)i}|j|d$||jjd%\}}|r d& ||fzfS|t j"k(rf|jj ||jj|d$j%|j&j d d'zy |jj d(|zy cc} } w)*aCreate a disk in the specified virtual machine. Check if creation is required, and if so, compile the disk configuration and create it by updating the virtual machine configuration. After calling the API function, wait for the result. :param disk: ID of the disk in format "". :param vmid: ID of the virtual machine where the disk will be created. :param vm: Name of the virtual machine where the disk will be created. :param vm_config: Configuration of the virtual machine. :return: (bool, string) Whether the task was successful or not and the message to return to Ansible. createdisabledFDisk z not found in VM z) and creation was disabled in parameters.z5Reached timeout. Last line in task before timeout: %sregularforcedr3N iso_imagestorager0z ,import-from=zMReached timeout while importing VM disk. Last line in task before timeout: %szDisk %s imported into VM %sz%CD-ROM was created on %s bus in VM %sz%The storage option must be specified.msgrDrz:%srzDisk %s created in VM %szLReached timeout while creating VM disk. Last line in task before timeout: %srrdisk)rhrjzDisk %s updated in VM %sr)rrrrz is up to date in VM nodetimeoutTr$Error occurred on task execution: %s)r]r^rerget fail_jsonr_r$updatestr proxmox_apinodesqemurpostapi_task_completer TASK_TIMED_OUTtaskslog)rdrqvmidvm vm_configrg timeout_strplaybook_config import_stringrl config_strok_strr!r"disk_config_to_applyproxmox_configr current_task_id task_success fail_reasons r# create_diskzProxmoxDiskAnsible.create_disk s##H- Z D $9cgimnn nM i D $9v?Q"88:O+// tDM **..{DAI7;{{7I7I)7TVY[hi m 6&& @![[// : !KK)).U)V;;%%))'2g=%4;;+=+=f+E"FFJ3l '--/ 01!Q//  0%)KK$6$6v$> #K , ,1B/F **..{DAI29T?CN"88:O    t 4$& +H5 '--/ 01!Q//  0L I&&v0F'GH I$,5)5D5J5J5LMTQq#a&yMOM0$MMM$(KK$6$6v$> #K S$**00F<AA$GNNSSkVjk$($:$:2f:X\XcXcXjXjktXu$v! k 4,.. .n;;; %%#d&6&6&<&". :param vmid: ID of virtual machine which disk will be moved. :param vm: Name of virtual machine which disk will be moved. :param vm_config: Virtual machine configuration. :return: (bool, string) Whether the task was successful or not and the message to return to Ansible. rrqrbwlimittarget_storagerm target_diskz target-disk target_vmidz target-vmidr1 delete_movedFrrdeleteNriz already at z storagerrrsTz moved from VM z storage zVReached timeout while waiting for moving VM disk. Last line in task before timeout: %srortru)r$rr]r^rvr_rzr{r| move_diskr}r~r rrwrr) rdrqrrr disk_config disk_storager^r!r"rrrs r#rzProxmoxDiskAnsible.move_diskhsJ,IdO< ">2 vv KK..y9y KK../?@y $ 2 2= A} $ 2 2= A};;--h7x $ 2 2 6 6~u M1STx#)<<>C41aQ]!Q$CC ::i '/ $@Ki K$??|TTTV$**00F<AA$GQQVV`Y_`$($:$:2f:X\XcXcXjXjktXu$v! k $l[[ [n;;; %%p((..r&z:@@QUUYY[\^]^_`&  %%*PS^*^%_)Ds 4 I?Ic|jjd}td|s"|jjd|d|t ||}|d}||k(r dd|d|d fS|j }|t d krd n|j d } | d k\r|jj|dj|jj||} |j|d| |jjd\} } | r dd|d|fS| tjk(rf|jjd|jj|dj| j j#ddzy|jjd| zy|jj|dj|jj||dd|d|fS)aCall the `resize` API function to change the disk size and wait for the result. :param disk: ID of disk in format "". :param vmid: ID of virtual machine which disk will be resized. :param vm: Name of virtual machine which disk will be resized. :param vm_config: Virtual machine configuration. :return: (Bool, string) Whether the task was successful or not and the message to return to Ansible. rz^\+?\d+(\.\d+)?[KMGT]?$z#Unrecognized size pattern for disk : roFriz is already z sizez4.0rrr)rqrrsTz resized in VM zIReached timeout while resizing disk. Last line in task before timeout: %sNrrt)r]r^r rwr$versionrrzr{r|resizesetr~r rrrrv) rdrqrrrrr actual_sizerpve_major_versionrrrs r# resize_diskzProxmoxDiskAnsible.resize_disks{{!!&)/6 KK ! !UY[_&` ! a+IdO< !&) ; $EE E,,.!(<+>!>AGOOTUDV  !"..44RZ@EEdKRRVV\`gkVlO(,(>(>r&z?\`\g\g\n\nox\y(z %L+4FFF."?"??KK))g ,,222f:>DD_UYY]]_`babcd* KK)).TWb.b)c    " "2f: . 3 3D 9 @ @ D D$UY D ZtTBB Br%N) __name__ __module__ __qualname__r`rrangesupported_bus_num_rangesrerrrrur%r#r'r's^ $ !QK 1b\ 1a[Q|Q}   \`|+`Z$Cr%r'ct}tdidtdgddtddtd d td d td d tdgd dtd dtddtdddgdtdgddtd dtddtd dtd dtd dtd dtd dtd dtd dtd dtd d tdd!tdd"td#d$td#d%td#d&td#d'td#d(td#d)tdd*d+gd,td d-tdd.tdgd/d0tdd1tdd2td d3tdd4tdd5tdd6tdd7tdgd8d9tdgd:d;tddtdd?td d@tddAtd dBCdDtddEtd d+tddFGdHtddItddJtdgdKdLMdNtdgdOdPM}|j|t|dQgdRdSgdNdTdHgfdJdUdIgfgd?d"d%d'd$d&d(ddddddd)dVdWgdXY}t |}|j d+}t dZ}t|d[|}tt|d\|}||jvr |jjd]|z^nL||j|vr;|j|}|jjd_|d`|dadb|dcdd^|j dD} |j dJ} |j dExs|j| } d} d} |j| } |jj| dej!| j"j%} || vr| dhvr|j| di|dj| k| dLk(r- |j+|| | | \}}|j-|| |ly| dok(r |dpk(r|j-dW| d_|dq| l|| vr|j-dW| d_|dr| dsl|jj| dej!| j.j1|dat|j-dF| d_|du| ly| dyk(r- |j3|| | | \}}|j-|| |ly| dUk(r- |j5|| | | \}}|j-|| |ly| d|k(r || vr|j-dW| d_|d}| l|jj| dej!| j.j1|d~t|j-dF| d_|d| lyy#t&$r6}|jjdf| dgt)|^Yd}~ d}~wwxYw#t&$r/}|j| dm|dj| dnt)|kYd}~yd}~wwxYw#t&$r.}|jdv|dw| dxt)|^Yd}~yd}~wwxYw#t&$r.}|jdz|dj| dxt)|^Yd}~yd}~wwxYw#t&$r.}|jd{|dj| dxt)|^Yd}~yd}~wwxYw#t&$r/}|j| d|dw| dnt)|kYd}~yd}~wwxYw)Nr(ry)nativethreadsio_uring)typechoicesr)rb)rr*rcr+r,r-)r writethrough writebackunsafe directsyncr.r/r0ignoreonr1)rawcowqcowqedqcow2vmdkcloopr2r3r4r5r6r7r8r9r:r;r<r=rlr>floatr?r@rArBrCrDrrqrErFrG)rreportstoprHrIrJrKrLrMrNrO)autolbarrP)enospcrrrrQrrrrrrs600)rdefaultnamerT)rrequiredrmrstate)presentresizeddetachedmovedabsentr)rrrrg)rhrjrkrj) api_token_idapi_token_secret)rr) api_passwordrrkr)rr?rArCr*r+r,r5r8r;r6r9r<rlF))rr)r>r@)r>rB)r4r7)r4r:)r3r) argument_specrequired_togetherrequired_one_of required_if required_bysupports_check_modemutually_exclusivez^([a-z]+)([0-9]+)$z\1z\2zUnsupported disk bus: %sroriz number not in range rz.. rrzGetting information for VM z failed with exception: )rrzUnable to process missing disk z in VM )rrp)changedrrpzUnable to create/update disk rrr[z already detached in VM z not present in VM z config)idlistforcez detached from VM zFailed to detach disk z from VM z with exception: rzFailed to move disk zFailed to resize disk rz is already absent in VM rz removed from VM zUnable to remove disk ru)rrrxrr'r^r r rcrr]rwget_vmidget_vmrzr{r|rrv Exceptionryr exit_jsonunlinkputrr) module_args disk_argsr]proxmoxrq disk_regexdisk_bus disk_number bus_rangerrrrrermessages r#mainrs ,.K? e%F G? ?' ? E* ? E* ?'de?u ?'?%(D)9:?(_`??e$?u ?5!? %(!?"% #?$e$%?& U+'?(% )?*e$+?, U+-?.6"/?0E"1?2w 3?47#5?6'"7?8g&9?:'";?<g&=?>'89??@A?BF#C?D(DEE?F V G?HF#I?Ju K?LM?N O?P6"Q?R f S?T'>?U?V(NOW?X e Y?^% _?`'a?be$c?de$e?fv&g?h%/i?nu o?pu q?rut ,s?t% u?vu w?x'\$&y?|(IS\]}?IBy! !?@)+KL x) - i& * )$$(!.!.$$)"/"/  " 3!FF!(G == D./J:ud+Hc*eT23Kw777  %?(%J K G<   dT]^_T`bklnbo%p q == D MM' "E == :G$4$4T$:D BIq ^^D !''--bj9>>tDKKOOQ  9*>!>dX\^b(cd  s&224r9M GW   W4W  E *  r8#  Tfjlp?q r9$  Thlnr?s t    % %bj 1 6 6t < C C G Gt[\ G ]   T[_ae:f  g '  n&00tRK GW   W4W  E )  p&224r9M GW   W4W  E (  n9$  Tgkmq?r s    % %bj 1 6 6t < C C G Gt[\ G ]   TZ^`d:e  f O q  bfhklmhn%o ppq s   $^bdhjmnojp,q  r r s r   ]acgilmnio!p  q q r n   Y]_cehijek!l  m m n p   [_aegjklgm!n  o o p n   $Y]_cehijek,l  m m nsAZ+[B \,+] +^B^= [+[  [ \ %\\  ]$]] ^$];;^ ^: $^55^:= _5%_00_5__main__N) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrBansible_collections.community.general.plugins.module_utils.versionrBansible_collections.community.general.plugins.module_utils.proxmoxrr rer r r r$r'rrrur%r#rssA@ u n i V 5[`""(VLCLC^mn` zFr%