Documentation

vmware_host_facts - Gathers facts about remote ESXi hostsystem

New in version 2.5.

Synopsis

  • This module can be used to gathers facts like CPU, memory, datastore, network and system etc. about ESXi host system.
  • Please specify hostname or IP address of ESXi host system as hostname.
  • If hostname or IP address of vCenter is provided as hostname, then information about first ESXi hostsystem is returned.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
hostname
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 supported added in version 2.6.
password
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 supported added in version 2.6.

aliases: pass, pwd
port
(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 supported added in version 2.6.
username
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 supported added in version 2.6.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
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 supported added in version 2.6.

Examples

- name: Gather vmware host facts
  vmware_host_facts:
    hostname: esxi_ip_or_hostname
    username: username
    password: password
  register: host_facts
  delegate_to: localhost

Status

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

Author

  • Wei Gao (@woshihaoren)

Hint

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