New in version 2.3.
- python >= 2.6
- PyVmomi
parameter | required | default | choices | comments |
---|---|---|---|---|
datacenter |
yes | Destination datacenter for the deploy operation | ||
description |
no | Define an arbitrary description to attach to snapshot. | ||
folder |
no | Define instance folder location. | ||
hostname |
yes | The hostname or IP address of the vSphere vCenter. | ||
name |
yes | Name of the VM to work with | ||
name_match |
no | first |
|
If multiple VMs matching the name, use the first or last found |
password |
yes | The password of the vSphere vCenter.
aliases: pass, pwd | ||
snapshot_name |
no | Sets the snapshot name to manage. This param is required only if state is not remove_all | ||
state |
yes |
|
Manage snapshots attached to a specific virtual machine. | |
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: Create snapshot vmware_guest_snapshot: hostname: 192.168.1.209 username: administrator@vsphere.local password: vmware name: dummy_vm state: present snapshot_name: snap1 description: snap1_description - name: Remove a snapshot vmware_guest_snapshot: hostname: 192.168.1.209 username: administrator@vsphere.local password: vmware name: dummy_vm state: remove snapshot_name: snap1 - name: Revert to a snapshot vmware_guest_snapshot: hostname: 192.168.1.209 username: administrator@vsphere.local password: vmware name: dummy_vm state: revert snapshot_name: snap1 - name: Remove all snapshots of a VM vmware_guest_snapshot: hostname: 192.168.1.209 username: administrator@vsphere.local password: vmware name: dummy_vm state: remove_all
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
instance | 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.