Documentation

vmware_vm_facts - Return basic facts pertaining to a vSphere virtual machine guest

New in version 2.0.

Synopsis

Return basic facts pertaining to a vSphere virtual machine guest

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
hostname
yes
    The hostname or IP address of the vSphere vCenter
    password
    yes
      The password of the vSphere vCenter

      aliases: pass, pwd
      username
      yes
        The username of the vSphere vCenter

        aliases: user, admin

        Examples

        - name: Gather all registered virtual machines
          local_action:
            module: vmware_vm_facts
            hostname: esxi_or_vcenter_ip_or_hostname
            username: username
            password: password
        

        Notes

        Note

        Tested on vSphere 5.5

        This is an Extras Module

        For more information on what this means please read Extras Modules

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