community.vmware.vmware_guest_find – Find the folder path(s) for a virtual machine by name or UUID

Note

This plugin is part of the community.vmware collection (version 1.6.0).

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_guest_find.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Find the folder path(s) for a virtual machine by name or UUID

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.6
PyVmomi

Parameters

Parameter	Choices/Defaults	Comments
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 `VMWARE_HOST` will be used instead. Environment variable support added in Ansible 2.6.
name string		Name of the VM to work with. This is required if `uuid` parameter is not supplied.
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 `VMWARE_PASSWORD` will be used instead. Environment variable support added in Ansible 2.6. aliases: pass, pwd
port integer	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 Ansible 2.6.
proxy_host string		Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_HOST` will be used instead. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer		Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_PORT` will be used instead.
use_instance_uuid boolean	no ← yes	Whether to use the VMware instance UUID rather than the BIOS UUID.
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 `VMWARE_USER` will be used instead. Environment variable support added in Ansible 2.6. aliases: admin, user
uuid string		UUID of the instance to manage if known, this is VMware's BIOS UUID by default. This is required if `name` parameter is not supplied.
validate_certs boolean	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 Ansible 2.6. If set to `true`, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

Tested on vSphere 6.5

Examples

- name: Find Guest's Folder using name
  community.vmware.vmware_guest_find:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: testvm
  delegate_to: localhost
  register: vm_folder

- name: Find Guest's Folder using UUID
  community.vmware.vmware_guest_find:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 38c4c89c-b3d7-4ae6-ae4e-43c5118eae49
  delegate_to: localhost
  register: vm_folder

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
folders list / elements=string	on success	List of folders for user specified virtual machine Sample: ['/DC0/vm']

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.10/collections/community/vmware/vmware_guest_find_module.html