community.vmware.vmware_host_service_info module – Gathers info about an ESXi host’s services

Note

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

Synopsis

  • This module can be used to gather information about an ESXi host’s services.

Parameters

Parameter

Comments

cluster_name

string

Name of the cluster.

Service information about each ESXi server will be returned for given cluster.

If esxi_hostname is not given, this parameter is required.

esxi_hostname

string

ESXi hostname.

Service information about this ESXi server will be returned.

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

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.

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:

  • false

  • true ← (default)

Notes

Note

  • If source package name is not available then fact is populated as null.

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

Examples

- name: Gather info about all ESXi Host in given Cluster
  community.vmware.vmware_host_service_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  delegate_to: localhost
  register: cluster_host_services

- name: Gather info about ESXi Host
  community.vmware.vmware_host_service_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
  delegate_to: localhost
  register: host_services

Return Values

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

Key

Description

host_service_info

dictionary

dict with hostname as key and dict with host service config information

Returned: always

Sample: {"10.76.33.226": [{"key": "DCUI", "label": "Direct Console UI", "policy": "on", "required": false, "running": true, "source_package_desc": "This VIB contains all of the base functionality of vSphere ESXi.", "source_package_name": "esx-base", "uninstallable": false}, {"key": "TSM", "label": "ESXi Shell", "policy": "off", "required": false, "running": false, "source_package_desc": "This VIB contains all of the base functionality of vSphere ESXi.", "source_package_name": "esx-base", "uninstallable": false}]}

Authors

  • Abhijeet Kasurde (@Akasurde)