Skip to content

Commit

Permalink
update vcenter_vm_hardware_disk description (#548)
Browse files Browse the repository at this point in the history
SUMMARY
Fixes #469
Mention the new disks type in the module description, since mentioned elsewhere
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vcenter_vm_hardware_disk

Reviewed-by: Anna Savina
  • Loading branch information
mikemorency authored Nov 14, 2024
1 parent b32b44f commit d1b04da
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
3 changes: 3 additions & 0 deletions changelogs/fragments/548-update-docs-for-vm-harware-disk.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
trivial:
- vcenter_vm_hardware_disk - Updated description to explicitly mention that the disk type is thin
3 changes: 3 additions & 0 deletions config/modules.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/vcenter_vm_hardware_disk.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit d1b04da

Please sign in to comment.