Docs4dev
Docs
ansible / 2.4 / vmware_guest_find_module.html

vmware_guest_find - Find the folder path(s) for a VM by name or UUID

New in version 2.4.

Synopsis

  • Find the folder path(s) for a VM by name or UUID

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
datacenter
 yes
Destination datacenter for the find operation.
hostname
 yes
The hostname or IP address of the vSphere vCenter.
name
 no
Name of the VM to work with.
This is required if uuid is not supplied.
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 BIOS UUID.
This is required if name is not supplied.
validate_certs
 no True
  • True
  • False
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples

- name: Find Guest's Folder using name
  vmware_guest_find:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    validate_certs: no
    name: testvm
  register: vm_folder

- name: Find Guest's Folder using UUID
  vmware_guest_find:
    hostname: 192.168.1.209
    username: administrator@vsphere.local
    password: vmware
    validate_certs: no
    uuid: 38c4c89c-b3d7-4ae6-ae4e-43c5118eae49
  register: vm_folder

Notes

Note

  • Tested on vSphere 6.5

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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