vmware.vmware.guest_info module – Gather guest information

Note

This module is part of the vmware.vmware collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware.guest_info.

Synopsis

  • This module gathers vm guest information.

Requirements

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

  • vSphere Automation SDK

Parameters

Parameter

Comments

datacenter

aliases: datacenter_name

string

The datacenter with the VM you would like to query.

This is only used if the folder parameter is supplied as a relative path.

folder

string

Absolute or relative folder path to search for the virtual machine.

This parameter is only used if name is supplied, and can help identify the machine you want to query.

For example ‘datacenter name/vm/path/to/folder’ or ‘path/to/folder’

folder_paths_are_absolute

boolean

If true, any folder path parameters are treated as absolute paths.

If false, modules will try to intelligently determine if the path is absolute or relative.

This option is useful when your environment has a complex folder structure. By default, modules will try to intelligently determine if the path is absolute or relative. They may mistakenly prepend the datacenter name or other folder names, and this option can be used to avoid this.

Choices:

  • false ← (default)

  • true

gather_tags

boolean

If true, gather any tags attached to the vm(s)

Choices:

  • false ← (default)

  • true

guest_password

string

The password of the user to be used to connect to guest vm and fetch environment info.

guest_username

string

The username to be used to connect to guest vm and fetch environment info.

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

moid

string

The MOID of the vm to gather info for

Only one of name, moid, uuid is allowed

name

aliases: guest_name

string

The name of the vm to gather info for

Only one of name, moid, uuid is allowed

name_match

string

If using name and multiple VMs have the same name, specify which VM should be selected

Choices:

  • "first"

  • "last"

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

properties

list / elements=string

If the schema is ‘vsphere’, gather these specific properties only

proxy_host

string

The 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.

proxy_port

integer

The 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.

proxy_protocol

aliases: protocol

string

The proxy connection protocol to use.

This option is used if the correct proxy protocol cannot be automatically determined.

Choices:

  • "http"

  • "https" ← (default)

schema

string

The type of info to gather from the vms

Choices:

  • "summary" ← (default)

  • "vsphere"

use_instance_uuid

boolean

If true, search by instance UUID instead of BIOS UUID.

BIOS UUID may not be unique and may cause errors.

Choices:

  • false

  • true ← (default)

username

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

uuid

string

The UUID of the vm to gather info for

Only one of name, moid, uuid is allowed

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

The check_mode support.

Notes

Note

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Gather guest vm info
  vmware.vmware.guest_info:
    hostname: "https://vcenter"
    username: "username"
    password: "password"
    validate_certs: false
    guest_name: "my_vm"

Return Values

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

Key

Description

guests

list / elements=string

Information about guest.

Returned: On success

Sample: [{"advanced_settings": {"govcsim": "TRUE"}, "annotation": null, "current_snapshot": null, "customvalues": {}, "env": {}, "guest_consolidation_needed": false, "guest_question": null, "guest_tools_status": "guestToolsNotRunning", "guest_tools_version": "0", "hw_cluster": null, "hw_cores_per_socket": 1, "hw_datastores": ["LocalDS_0"], "hw_esxi_host": "DC0_H0", "hw_eth0": {"addresstype": "generated", "ipaddresses": [], "label": "ethernet-0", "macaddress": "00:0c:29:36:63:62", "macaddress_dash": "00-0c-29-36-63-62", "portgroup_key": "dvportgroup-13", "portgroup_portkey": null, "summary": "DVSwitch: fea97929-4b2d-5972-b146-930c6d0b4014"}, "hw_files": ["[LocalDS_0] DC0_H0_VM0/DC0_H0_VM0.vmx", "[LocalDS_0] DC0_H0_VM0/DC0_H0_VM0.nvram", "[LocalDS_0] DC0_H0_VM0/vmware.log", "[LocalDS_0] DC0_H0_VM0/disk1.vmdk"], "hw_folder": "DC0/vm", "hw_guest_full_name": null, "hw_guest_ha_state": null, "hw_guest_id": "otherGuest", "hw_interfaces": ["eth0"], "hw_is_template": false, "hw_memtotal_mb": 32, "hw_name": "DC0_H0_VM0", "hw_power_status": "poweredOn", "hw_processor_count": 1, "hw_product_uuid": "265104de-1472-547c-b873-6dc7883fb6cb", "hw_version": "vmx-13", "identity": {}, "instance_uuid": "b4689bed-97f0-5bcd-8a4c-07477cc8f06f", "ipv4": null, "ipv6": null, "module_hw": true, "moid": "vm-63", "snapshots": [], "tags": [], "tpm_info": {"provider_id": null, "tpm_present": null}, "vimref": "vim.VirtualMachine:vm-63", "vnc": {}}]

Authors

  • Ansible Cloud Team (@ansible-collections)