vmware_guest_snapshot_facts – Gather facts about virtual machine’s snapshots in vCenter
vmware_guest_snapshot_facts – Gather facts about virtual machine’s snapshots in vCenter
New in version 2.6.
Synopsis
- This module can be used to gather facts about virtual machine’s snapshots.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
datacenter - / required |
Name of the datacenter. | |
folder - |
Destination folder, absolute or relative path to find an existing guest. This is required only, if multiple virtual machines with same name are found on given vCenter. 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 | |
hostname string |
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 Environment variable support added in version 2.6. | |
name - |
Name of the VM to work with. This is required if | |
password string |
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in version 2.6.
| |
port integer added in 2.5 |
Default: 443 |
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in version 2.6. |
username string |
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in version 2.6.
| |
uuid - |
UUID of the instance to manage if known, this value is VMware's unique identifier. This is required if The | |
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 Environment variable support added in version 2.6. If set to |
Notes
Note
- Tested on vSphere 6.0 and 6.5
Examples
- name: Gather snapshot facts about the virtual machine in the given vCenter
vmware_guest_snapshot_facts:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: "{{ guest_name }}"
delegate_to: localhost
register: snapshot_facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
guest_snapshots dictionary |
always |
metadata about the snapshot facts
Sample: {'current_snapshot': {'creation_time': '2018-02-10T14:48:31.999459+00:00', 'description': , 'id': 28, 'name': 'snap_0003', 'state': 'poweredOff'}, 'snapshots': [{'creation_time': '2018-02-10T14:48:31.999459+00:00', 'description': , 'id': 28, 'name': 'snap_0003', 'state': 'poweredOff'}]} |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Abhijeet Kasurde (@Akasurde) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_guest_snapshot_facts_module.html