vmware_host_feature_facts – Gathers facts about an ESXi host’s feature capability information

New in version 2.8.

Synopsis

  • This module can be used to gather facts about an ESXi host’s feature capability information when ESXi hostname or Cluster name is given.

Requirements

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

  • python >= 2.6

  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster_name
-
Name of the cluster from all host systems to be used for facts gathering.
If esxi_hostname is not given, this parameter is required.
esxi_hostname
-
ESXi hostname to gather facts from.
If cluster_name is not given, this parameter is required.
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
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
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 support added in Ansible 2.6.
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
validate_certs
boolean
    Choices:
  • 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 yes, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Gather feature capability facts about all ESXi Hosts in given Cluster
  vmware_host_feature_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  delegate_to: localhost
  register: all_cluster_hosts_facts

- name: Check if ESXi is vulnerable for Speculative Store Bypass Disable (SSBD) vulnerability
  vmware_host_feature_facts:
    hostname: "{{ vcenter_server }}"
    username: "{{ vcenter_user }}"
    password: "{{ vcenter_pass }}"
    validate_certs: no
    esxi_hostname: "{{ esxi_hostname }}"
  register: features_set
- set_fact:
    ssbd : "{{ item.value }}"
  loop: "{{ features_set.host_feature_facts[esxi_hostname] |json_query(name) }}"
  vars:
    name: "[?key=='cpuid.SSBD']"
- assert:
    that:
      - ssbd|int == 1
  when: ssbd is defined

Return Values

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

Key Returned Description
hosts_feature_facts
dictionary
 always
metadata about host's feature capability information

Sample:
{'10.76.33.226': [{'feature_name': 'cpuid.3DNOW', 'key': 'cpuid.3DNOW', 'value': '0'}, {'feature_name': 'cpuid.3DNOWPLUS', 'key': 'cpuid.3DNOWPLUS', 'value': '0'}]}


Status

Authors

  • Abhijeet Kasurde (@Akasurde)

Hint

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