New in version 2.3.
- python >= 2.6
- PyVmomi
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| datacenter |
yes | Destination datacenter for the deploy operation | ||
| folder |
no | /vm | Destination folder, absolute or relative path to find an existing guest. This is required if name is supplied. 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 folder: vm/folder2 folder: folder2 | |
| hostname |
yes | The hostname or IP address of the vSphere vCenter. | ||
| name |
yes | Name of the Virtual Machine to work with | ||
| name_match |
no | first |
|
If multiple Virtual Machines matching the name, use the first or last found |
| password |
yes | The password of the vSphere vCenter. aliases: pass, pwd | ||
| username |
yes | The username of the vSphere vCenter. aliases: user, admin | ||
| uuid |
no | UUID of the instance to manage if known, this is VMware's unique identifier. This is required if name is not supplied. | ||
| validate_certs |
no | True |
|
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted. |
- name: gather the Virtual Machine facts vmware_guest_facts: hostname: 192.168.1.209 username: administrator@vsphere.local password: vmware validate_certs: no uuid: 421e4592-c069-924d-ce20-7e7533fab926 register: facts
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| instance | metadata about the virtual machine | always | dict | None |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.