From d7a10de0fd3a57e99d5870ae728729118cefb056 Mon Sep 17 00:00:00 2001 From: Mike Morency Date: Wed, 13 Nov 2024 15:28:48 -0500 Subject: [PATCH] update vcenter_vm_hardware_disk description --- .../fragments/548-update-docs-for-vm-harware-disk.yml | 3 +++ config/modules.yaml | 3 +++ plugins/modules/vcenter_vm_hardware_disk.py | 8 ++++---- 3 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 changelogs/fragments/548-update-docs-for-vm-harware-disk.yml diff --git a/changelogs/fragments/548-update-docs-for-vm-harware-disk.yml b/changelogs/fragments/548-update-docs-for-vm-harware-disk.yml new file mode 100644 index 00000000..e3960a68 --- /dev/null +++ b/changelogs/fragments/548-update-docs-for-vm-harware-disk.yml @@ -0,0 +1,3 @@ +--- +trivial: + - vcenter_vm_hardware_disk - Updated description to explicitly mention that the disk type is thin diff --git a/config/modules.yaml b/config/modules.yaml index a5a9291c..4310f6c4 100644 --- a/config/modules.yaml +++ b/config/modules.yaml @@ -151,6 +151,9 @@ - vcenter_vm_hardware_cpu: - vcenter_vm_hardware_disk_info: - vcenter_vm_hardware_disk: + documentation: + short_description: Adds a thin provisioned virtual disk to the virtual machine + description: Adds a virtual disk to the virtual machine. The disk (provision) type is always 'thin'. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk. - vcenter_vm_hardware_ethernet_info: - vcenter_vm_hardware_ethernet: - vcenter_vm_hardware_floppy_info: diff --git a/plugins/modules/vcenter_vm_hardware_disk.py b/plugins/modules/vcenter_vm_hardware_disk.py index 9a9e826c..f77c5554 100644 --- a/plugins/modules/vcenter_vm_hardware_disk.py +++ b/plugins/modules/vcenter_vm_hardware_disk.py @@ -9,10 +9,10 @@ DOCUMENTATION = r""" module: vcenter_vm_hardware_disk -short_description: Adds a virtual disk to the virtual machine -description: Adds a virtual disk to the virtual machine. While adding the virtual - disk, a new VMDK file may be created or an existing VMDK file may be used to back - the virtual disk. +short_description: Adds a thin provisioned virtual disk to the virtual machine +description: Adds a virtual disk to the virtual machine. The disk (provision) + type is always 'thin'. While adding the virtual disk, a new VMDK file may + be created or an existing VMDK file may be used to back the virtual disk. options: backing: description: