community.vmware.vmware_guest_controller module – Manage disk or USB controllers related to virtual machine in given vCenter infrastructure
Note
This module is part of the community.vmware collection (version 6.2.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.vmware.
To use it in a playbook, specify: community.vmware.vmware_guest_controller.
Synopsis
- This module can be used to add, remove disk controllers or USB controllers belonging to given virtual machine.
Parameters
Parameter | Comments |
|---|---|
controllers list / elements=dictionary | A list of disk or USB controllers to add or remove. Total 4 disk controllers with the same type are allowed per VM. Total 2 USB controllers are allowed per VM, 1 USB 2.0 and 1 USB 3.0 or 3.1. For specific guest OS, supported controller types please refer to VMware Compatibility Guide. |
|
bus_sharing string |
Bus sharing type for SCSI controller. Choices:
|
|
controller_number integer |
Disk controller bus number. When When Choices:
|
|
state string / required |
Add new controller or remove specified existing controller. If set to If specified controller is removed or not exist, no action will be taken only warning message. If set to If the number of controller with specified controller type reaches it’s maximum, no action will be taken only warning message. Choices:
|
|
type string / required |
Type of disk or USB controller. From vSphere 6.5 and virtual machine with hardware version 13, Choices:
|
datacenter string | The datacenter name to which virtual machine belongs to. Default: |
folder string | 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 |
gather_disk_controller_facts boolean | Whether to collect existing disk and USB controllers facts only. When this parameter is set to Choices:
|
hostname string | The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
moid string | |
name string | |
password aliases: pass, pwd string | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
port integer | The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable Default: |
proxy_host string | The 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 |
proxy_port integer | The 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 |
sleep_time integer | The sleep time in seconds after VM reconfigure task completes, used when not get the updated VM controller facts after VM reconfiguration. This parameter is not required. Maximum value is 600. Default: |
use_instance_uuid boolean | Whether to use the VMware instance UUID rather than the BIOS UUID. Choices:
|
username aliases: admin, user string | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
uuid string | |
validate_certs boolean | Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
- All modules require API write access and hence are not supported on a free ESXi license.
- All variables and VMware object names are case sensitive.
- Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’
Examples
- name: Add disk and USB 3.0 controllers for virtual machine located by name
community.vmware.vmware_guest_controller:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: test_VM
controllers:
- state: present
type: sata
- state: present
type: nvme
- state: present
type: usb3
delegate_to: localhost
register: disk_controller_facts
- name: Remove disk controllers and USB 2.0 from virtual machine located by moid
community.vmware.vmware_guest_controller:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
moid: vm-33
controllers:
- state: absent
controller_number: 1
type: sata
- state: absent
controller_number: 0
type: nvme
- state: absent
type: usb2
delegate_to: localhost
register: disk_controller_facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
disk_controller_status dictionary | metadata about the virtual machine’s existing disk controllers or after adding or removing operation Returned: always Sample: |
Authors
- Diane Wang (@Tomorrow9)
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_controller_module.html
