Docs4dev
Docs
ansible / 2.6 / modules / vmware_guest_snapshot_facts_module.html

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
str
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 VMWARE_HOST will be used instead.
Environment variable support added in version 2.6.
name
Name of the VM to work with.
This is required if uuid is not supplied.
password
str
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in version 2.6.

aliases: pass, pwd
port
int

(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 VMWARE_PORT will be used instead.
Environment variable support added in version 2.6.
username
str
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in version 2.6.

aliases: admin, user
uuid
UUID of the instance to manage if known, this value is VMware's unique identifier.
This is required if name is not supplied.
The folder is ignored, if uuid is provided.
validate_certs
bool
    Choices:
  • no
  • yes ←
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable support added in version 2.6.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.0 and 6.5

Examples

- name: Gather facts about the virtual machine in given vCenter
  vmware_guest_snapshot_facts:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    datacenter: datacenter_name
    name: dummy_vm
  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
dict
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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vmware_guest_snapshot_facts_module.html