community.vmware.vmware_vm_info module – Return basic info pertaining to a VMware machine guest

Note

This module is part of the community.vmware collection (version 2.5.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 community.vmware.

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

Synopsis

  • Return basic information pertaining to a vSphere or ESXi virtual machine guest.

  • Cluster name as fact is added in version 2.7.

Requirements

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

  • python >= 2.6

  • PyVmomi

Parameters

Parameter

Comments

folder

string

Specify a folder location of VMs to gather information from.

Examples:

folder: /ha-datacenter/vm

folder: ha-datacenter/vm

folder: /datacenter1/vm

folder: datacenter1/vm

folder: /datacenter1/vm/folder1

folder: datacenter1/vm/folder1

folder: /folder1/datacenter1/vm

folder: folder1/datacenter1/vm

folder: /folder1/datacenter1/vm/folder2

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.

password

aliases: pass, pwd

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.

port

integer

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.

Default: 443

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.

show_allocated

boolean

added in 2.5.0 of community.vmware

Allocated storage in byte and memory in MB are shown if it set to True.

Choices:

  • no ← (default)

  • yes

show_attribute

boolean

Attributes related to VM guest shown in information only when this is set true.

Choices:

  • no ← (default)

  • yes

show_tag

boolean

Tags related to virtual machine are shown if set to True.

Choices:

  • no ← (default)

  • yes

username

aliases: admin, user

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.

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.

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.

Choices:

  • no

  • yes ← (default)

vm_name

string

Name of the virtual machine to get related configurations information from.

vm_type

string

If set to vm, then information are gathered for virtual machines only.

If set to template, then information are gathered for virtual machine templates only.

If set to all, then information are gathered for all virtual machines and virtual machine templates.

Choices:

  • all ← (default)

  • vm

  • template

Notes

Note

  • Tested on ESXi 6.7, vSphere 5.5 and vSphere 6.5

  • From 2.8 and onwards, information are returned as list of dict instead of dict.

  • Fact about moid added in VMware collection 1.4.0.

  • Fact about datastore_url is added in VMware collection 1.18.0.

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

Examples

- name: Gather all registered virtual machines
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost
  register: vminfo

- debug:
    var: vminfo.virtual_machines

- name: Gather one specific VM
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
  delegate_to: localhost
  register: vm_info

- debug:
    var: vminfo.virtual_machines

- name: Gather only registered virtual machine templates
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_type: template
  delegate_to: localhost
  register: template_info

- debug:
    var: template_info.virtual_machines

- name: Gather only registered virtual machines
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_type: vm
  delegate_to: localhost
  register: vm_info

- debug:
    var: vm_info.virtual_machines

- name: Get UUID from given VM Name
  block:
    - name: Get virtual machine info
      community.vmware.vmware_vm_info:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
        folder: "/datacenter/vm/folder"
      delegate_to: localhost
      register: vm_info

    - debug:
        msg: "{{ item.uuid }}"
      with_items:
        - "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
      vars:
        query: "[?guest_name=='DC0_H0_VM0']"

- name: Get Tags from given VM Name
  block:
    - name: Get virtual machine info
      community.vmware.vmware_vm_info:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
        folder: "/datacenter/vm/folder"
      delegate_to: localhost
      register: vm_info

    - debug:
        msg: "{{ item.tags }}"
      with_items:
        - "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
      vars:
        query: "[?guest_name=='DC0_H0_VM0']"

- name: Gather all VMs from a specific folder
  community.vmware.vmware_vm_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    folder: "/Asia-Datacenter1/vm/prod"
  delegate_to: localhost
  register: vm_info

- name: Get datastore_url from given VM name
  block:
    - name: Get virtual machine info
      community.vmware.vmware_vm_info:
        hostname: '{{ vcenter_hostname }}'
        username: '{{ vcenter_username }}'
        password: '{{ vcenter_password }}'
      delegate_to: localhost
      register: vm_info

    - debug:
        msg: "{{ item.datastore_url }}"
      with_items:
        - "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
      vars:
        query: "[?guest_name=='DC0_H0_VM0']"

Return Values

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

Key

Description

virtual_machines

list / elements=string

list of dictionary of virtual machines and their information

Returned: success

Sample: [{“allocated”: {“cpu”: 2, “memory”: 16, “storage”: 500000000}, “attributes”: {“job”: “backup-prepare”}, “cluster”: null, “datacenter”: “Datacenter-1”, “datastore_url”: [{“name”: “t880-o2g”, “url”: “/vmfs/volumes/e074264a-e5c82a58”}], “esxi_hostname”: “10.76.33.226”, “folder”: “/Datacenter-1/vm”, “guest_fullname”: “Ubuntu Linux (64-bit)”, “guest_name”: “ubuntu_t”, “ip_address”: “”, “mac_address”: [“00:50:56:87:a5:9a”], “moid”: “vm-24”, “power_state”: “poweredOff”, “tags”: [{“category_id”: “urn:vmomi:InventoryServiceCategory:b316cc45-f1a9-4277-811d-56c7e7975203:GLOBAL”, “category_name”: “cat_0001”, “description”: “”, “id”: “urn:vmomi:InventoryServiceTag:43737ec0-b832-4abf-abb1-fd2448ce3b26:GLOBAL”, “name”: “tag_0001”}], “uuid”: “4207072c-edd8-3bd5-64dc-903fd3a0db04”, “vm_network”: {“00:50:56:87:a5:9a”: {“ipv4”: [“10.76.33.228”], “ipv6”: []}}}]

Authors

  • Joseph Callen (@jcpowermac)

  • Abhijeet Kasurde (@Akasurde)

  • Fedor Vompe (@sumkincpp)