community / community.vmware / 4.2.0 / module / vmware_guest_disk Manage disks related to virtual machine in given vCenter infrastructure Authors: Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>community.vmware.vmware_guest_disk (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to add, remove and update disks belonging to given virtual machine.
All parameters and VMware object names are case sensitive.
This module is destructive in nature, please read documentation carefully before proceeding.
Be careful while removing disk specified as this may lead to data loss.
- name: Add disks to virtual machine using UUID community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" uuid: 421e4592-c069-924d-ce20-7e7533fab926 disk: - size_mb: 10 type: thin datastore: datacluster0 state: present scsi_controller: 1 unit_number: 1 scsi_type: 'paravirtual' disk_mode: 'persistent' - size_gb: 10 type: eagerzeroedthick state: present autoselect_datastore: true scsi_controller: 2 scsi_type: 'buslogic' unit_number: 12 disk_mode: 'independent_persistent' - size: 10Gb type: eagerzeroedthick state: present autoselect_datastore: true scsi_controller: 2 scsi_type: 'buslogic' unit_number: 1 disk_mode: 'independent_nonpersistent' - filename: "[datastore1] path/to/existing/disk.vmdk" delegate_to: localhost register: disk_facts
- name: Add disks with specified shares to the virtual machine community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" disk: - size_gb: 1 type: thin datastore: datacluster0 state: present scsi_controller: 1 unit_number: 1 disk_mode: 'independent_persistent' shares: level: custom level_value: 1300 delegate_to: localhost register: test_custom_shares
- name: Add physical raw device mapping to virtual machine using name community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false name: "Test_VM" disk: - type: rdm state: present scsi_controller: 1 unit_number: 5 rdm_path: /vmfs/devices/disks/naa.060000003b1234efb453 compatibility_mode: 'physicalMode'
- name: Add virtual raw device mapping to virtual machine using name and virtual mode community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false name: "Test_VM" disk: - type: rdm state: present scsi_controller: 1 unit_number: 5 rdm_path: /vmfs/devices/disks/naa.060000003b1234efb453 compatibility_mode: 'virtualMode' disk_mode: 'persistent'
- name: Add raw device mapping to virtual machine with Physical bus sharing community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false name: "Test_VM" disk: - type: rdm state: present scsi_controller: 1 unit_number: 5 rdm_path: /vmfs/devices/disks/naa.060000003b1234efb453 compatibility_mode: 'virtualMode' disk_mode: 'persistent' bus_sharing: physicalSharing
- name: Add raw device mapping to virtual machine with Physical bus sharing and clustered disk community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false name: "Test_VM" disk: - type: rdm state: present scsi_controller: 1 unit_number: 5 compatibility_mode: 'virtualMode' disk_mode: 'persistent' bus_sharing: physicalSharing filename: "[datastore1] path/to/rdm/disk-marker.vmdk"
- name: create new disk with custom IO limits and shares in IO Limits community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" disk: - size_gb: 1 type: thin datastore: datacluster0 state: present scsi_controller: 1 unit_number: 1 disk_mode: 'independent_persistent' iolimit: limit: 1506 shares: level: custom level_value: 1305 delegate_to: localhost register: test_custom_IoLimit_shares
- name: Remove disks from virtual machine using name community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" name: VM_225 disk: - state: absent scsi_controller: 1 unit_number: 1 delegate_to: localhost register: disk_facts
- name: Remove disk from virtual machine using moid community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" moid: vm-42 disk: - state: absent scsi_controller: 1 unit_number: 1 delegate_to: localhost register: disk_facts
- name: Remove disk from virtual machine but keep the VMDK file on the datastore community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" name: VM_225 disk: - state: absent scsi_controller: 1 unit_number: 2 destroy: false delegate_to: localhost register: disk_facts
- name: Add disks to virtual machine using UUID to SATA and NVMe controller community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false uuid: 421e4592-c069-924d-ce20-7e7533fab926 disk: - size_mb: 256 type: thin datastore: datacluster0 state: present controller_type: sata controller_number: 1 unit_number: 1 disk_mode: 'persistent' - size_gb: 1 state: present autoselect_datastore: true controller_type: nvme controller_number: 2 unit_number: 3 disk_mode: 'independent_persistent' delegate_to: localhost register: disk_facts
- name: Add a new vPMem disk to virtual machine to SATA controller community.vmware.vmware_guest_disk: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" validate_certs: false name: VM_226 disk: - type: vpmemdisk size_gb: 1 state: present controller_type: sata controller_number: 1 unit_number: 2 delegate_to: localhost register: disk_facts
disk: default: [] description: - A list of disks to add or remove. - The virtual disk related information is provided using this list. - All values and parameters are case sensitive. elements: dict suboptions: autoselect_datastore: description: - Select the less used datastore. Specify only if O(disk.datastore) is not specified. - Not applicable when disk O(disk.type=vpmemdisk). type: bool bus_sharing: choices: - noSharing - physicalSharing - virtualSharing default: noSharing description: - Only functions with Paravirtual SCSI Controller. - Allows for the sharing of the scsi bus between two virtual machines. type: str cluster_disk: default: false description: - This value allows for the sharing of an RDM between two machines. - The primary machine holding the RDM uses the default V(false). - The secondary machine holding the RDM uses V(true). type: bool compatibility_mode: choices: - physicalMode - virtualMode description: Compatibility mode for raw devices. Required when O(disk.type=rdm). type: str controller_number: choices: - 0 - 1 - 2 - 3 description: - This parameter is used with O(disk.controller_type) for specifying controller bus number. - For O(disk.controller_type=ide), valid value is 0 or 1. type: int controller_type: choices: - buslogic - lsilogic - lsilogicsas - paravirtual - sata - nvme - ide description: - This parameter is added for managing disks attaching other types of controllers, e.g., SATA or NVMe. - If either O(disk.controller_type) or O(disk.scsi_type) is not specified, then use V(paravirtual) type. type: str datastore: description: - Name of datastore or datastore cluster to be used for the disk. - Not applicable when disk O(disk.type=vpmemdisk). type: str destroy: default: true description: If O(disk.state=absent), make sure the disk file is deleted from the datastore. type: bool disk_mode: choices: - persistent - independent_persistent - independent_nonpersistent description: - Type of disk mode. If not specified then use V(persistent) mode for new disk. - If set to V(persistent) mode, changes are immediately and permanently written to the virtual disk. - If set to V(independent_persistent) mode, same as persistent, but not affected by snapshots. - If set to V('independent_nonpersistent) mode, changes to virtual disk are made to a redo log and discarded at power off, but not affected by snapshots. - Not applicable when disk O(disk.type=vpmemdisk). type: str filename: description: - Existing disk image to be used. Filename must already exist on the datastore. - Specify filename string in C([datastore_name] path/to/file.vmdk) format. - Not applicable when disk O(disk.type=vpmemdisk). type: str iolimit: description: - Section specifies the shares and limit for storage I/O resource. - Not applicable when O(disk.type=vpmemdisk). suboptions: limit: description: Section specifies values for limit where the utilization of a virtual machine will not exceed, even if there are available resources. type: int shares: description: Specifies different types of shares user can add for the given disk. suboptions: level: choices: - low - normal - high - custom description: Specifies different level for the shares section. type: str level_value: description: Custom value when O(disk.iolimit.shares.level=custom). type: int type: dict type: dict rdm_path: description: - Path of LUN for Raw Device Mapping required for O(disk.type=rdm). - Only valid if O(disk.type=rdm). type: str scsi_controller: choices: - 0 - 1 - 2 - 3 description: - SCSI controller number. Only 4 SCSI controllers are allowed per VM. type: int scsi_type: choices: - buslogic - lsilogic - lsilogicsas - paravirtual description: - Type of SCSI controller. This value is required only for the first occurrence of SCSI Controller. - This value is ignored, if SCSI Controller is already present or O(disk.state=absent). type: str shares: description: - Section for iolimit section tells about what are all different types of shares user can add for disk. - Not applicable when disk O(disk.type=vpmemdisk). suboptions: level: choices: - low - normal - high - custom description: Tells about different level for the shares section. type: str level_value: description: Custom value when O(disk.shares.level=custom). type: int type: dict sharing: default: false description: - The sharing mode of the virtual disk. - Setting sharing means that multiple virtual machines can write to the virtual disk. - Sharing can only be set if O(disk.type=eagerzeroedthick) or O(disk.type=rdm). type: bool size: description: - Disk storage size. - If size specified then unit must be specified. There is no space allowed in between size number and unit. - Only first occurrence in disk element will be considered, even if there are multiple size* parameters available. type: str size_gb: description: Disk storage size in gb. type: int size_kb: description: Disk storage size in kb. type: int size_mb: description: Disk storage size in mb. type: int size_tb: description: Disk storage size in tb. type: int state: choices: - present - absent default: present description: - State of disk. - If set to V(absent), disk will be removed permanently from virtual machine configuration and from VMware storage. - If set to V(present), disk will be added if not present at given Controller and Unit Number. - or disk exists with different size, disk size is increased, reducing disk size is not allowed. type: str type: choices: - thin - eagerzeroedthick - thick - rdm - vpmemdisk description: - The type of disk, if not specified then use V(thick) type for new disk, no eagerzero. type: str unit_number: description: - Disk Unit Number. - Valid value range from 0 to 15, except 7 for SCSI Controller. - Valid value range from 0 to 64, except 7 for Paravirtual SCSI Controller on Virtual Hardware version 14 or higher. - Valid value range from 0 to 29 for SATA controller. - Valid value range from 0 to 14 for NVME controller. - Valid value range from 0 to 1 for IDE controller. required: true type: int type: list moid: description: - Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. - This is required if O(name) or O(uuid) is not supplied. type: str name: description: - Name of the virtual machine. - This is a required parameter, if parameter O(uuid) or O(moid) is not supplied. type: str port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int uuid: description: - UUID of the instance to gather facts if known, this is VMware's unique identifier. - This is a required parameter, if parameter O(name) or O(moid) is not supplied. type: str folder: description: - Destination folder, absolute or relative path to find an existing guest. - This is a required parameter, only if multiple VMs are found with same name. - The folder should include the datacenter. ESX's datacenter is ha-datacenter - 'Examples:' - ' folder: /ha-datacenter/vm' - ' folder: ha-datacenter/vm' - ' folder: /datacenter1/vm' - ' folder: datacenter1/vm' - ' folder: /datacenter1/vm/folder1' - ' folder: datacenter1/vm/folder1' - ' folder: /folder1/datacenter1/vm' - ' folder: folder1/datacenter1/vm' - ' folder: /folder1/datacenter1/vm/folder2' type: str hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datacenter: description: - The datacenter name to which virtual machine belongs to. required: true type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool use_instance_uuid: default: false description: - Whether to use the VMware instance UUID rather than the BIOS UUID. type: bool
disk_changes: description: result of each task, key is the 0-based index with the same sequence in which the tasks were defined returned: always sample: '0': Disk deleted. '1': Disk created. type: dict disk_data: description: metadata about the virtual machine's disks after managing them returned: always sample: '0': backing_datastore: datastore2 backing_disk_mode: persistent backing_eagerlyscrub: false backing_filename: '[datastore2] VM_225/VM_225.vmdk' backing_thinprovisioned: false backing_uuid: 421e4592-c069-924d-ce20-7e7533fab926 backing_writethrough: false capacity_in_bytes: 10485760 capacity_in_kb: 10240 controller_key: 1000 key: 2000 label: Hard disk 1 summary: 10,240 KB unit_number: 0 type: dict