vmware.vmware_rest.vcenter_host_info module – Gather information about vCenter ESXi hosts.

Note

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

To use it in a playbook, specify: vmware.vmware_rest.vcenter_host_info.

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.esxi_info.

Alternative:

Use vmware.vmware.esxi_info instead.

Synopsis

  • Retrieve information about one or more VMware vCenter ESXi hosts.

  • Returns the hosts that match the supplied filters, or all hosts when no filter is given.

  • Use the filter parameters to narrow results by host name, identifier, connection state, cluster, folder, or datacenter.

Parameters

Parameter

Comments

clusters

list / elements=string

A list of cluster MOIDs to filter the results.

Only hosts that belong to the specified clusters will be returned.

If omitted or empty, hosts in any cluster and hosts that are not in a cluster are returned.

If this list is not empty while filter.standalone is true, no hosts will match the filter.

connection_states

list / elements=string

A list of connection states to filter the results.

Only hosts that are in one of the listed connection states will be returned.

CONNECTED - Host is connected to the vCenter Server.

DISCONNECTED - Host is disconnected from the vCenter Server.

NOT_RESPONDING - vCenter Server is not receiving heartbeats from the host. The state automatically changes to connected once heartbeats are received again.

If omitted or empty, hosts in any connection state are returned.

datacenters

aliases: filter_datacenters

list / elements=string

A list of datacenter MOIDs to filter the results.

Only hosts that reside in the specified datacenters will be returned.

If omitted or empty, hosts in any datacenter are returned.

filter

dictionary

A specification used to filter the hosts that are returned.

If omitted, all hosts match the filter.

standalone

boolean

When true, only hosts that are not part of a cluster are returned.

When false, only hosts that are part of a cluster are returned.

If omitted, hosts are returned regardless of cluster membership.

If set to true while clusters is also specified, no hosts will match the filter.

Choices:

  • false

  • true

folders

aliases: filter_folders

list / elements=string

A list of folder MOIDs to filter the results.

Only hosts that reside in the specified folders will be returned.

If omitted or empty, hosts in any folder are returned.

host_uuids

list / elements=string

A list of host UUIDs to filter the results.

The UUID maps to “UUID” in SMBIOS System Information (Type 1) at offset 08h.

This property was added in vSphere API 9.0.0.0.

If omitted or empty, hosts with any UUID are returned.

hosts

list / elements=string

A list of host MOIDs to filter the results.

Only hosts whose identifiers appear in this list will be returned.

If omitted or empty, hosts with any identifier are returned.

names

aliases: filter_names

list / elements=string

A list of host names to filter the results.

Only hosts whose names appear in this list will be returned.

If omitted or empty, hosts with any name are returned.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all hosts
  vmware.vmware_rest.vcenter_host_info:
  register: all_hosts

- name: Filter hosts by name
  vmware.vmware_rest.vcenter_host_info:
    names:
      - esxi01.example.com
  register: filtered_hosts

- name: List connected standalone hosts
  vmware.vmware_rest.vcenter_host_info:
    filter:
      standalone: true
    connection_states:
      - CONNECTED
  register: standalone_hosts

- name: List hosts in a specific cluster
  vmware.vmware_rest.vcenter_host_info:
    clusters:
      - domain-c1001
  register: cluster_hosts

Return Values

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

Key

Description

id

string

MOID of the queried host.

Returned: When only one resource, with a MOID, was queried.

Sample: "host-1001"

info

list / elements=string

A list of hosts matching the query.

Returned: On success.

Sample: [{"connection_state": "CONNECTED", "host": "host-1001", "name": "esxi01.example.com", "power_state": "POWERED_ON"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success.

Sample: {"connection_state": "CONNECTED", "host": "host-1001", "name": "esxi01.example.com", "power_state": "POWERED_ON"}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ansible Eco Content Team (@eco-ansible-content)