vmware.vmware.esxi_connection module – Manage VMware ESXi host connection status in vCenter

Note

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

To use it in a playbook, specify: vmware.vmware.esxi_connection.

Synopsis

  • Manage VMware ESXi host connection status in vCenter. Disconnecting hosts temporarily disables monitoring for the host and its VMs. However they will still show up in vCenter.

  • This module does not manage the addition, removal, or placement of hosts in vCenter. That functionality is in vmware.vmware.esxi_host

  • The community.vmware.vmware_host module allows you to add a host in a disconnected state. The host must have been added in a connected state for you to reconnect it using this module. You can remove the host and add it back using the vmware.vmware.esxi_host to get it in the proper state.

Parameters

Parameter

Comments

datacenter

aliases: datacenter_name

string / required

The name of the datacenter.

esxi_host_name

aliases: name

string / required

ESXi hostname to manage.

hostname

string

The hostname or IP address of the vSphere vCenter server.

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

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

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

port

integer

The port number of the vSphere vCenter server.

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

Default: 443

proxy_host

string

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

proxy_port

integer

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

state

string

Sets the connection status of the host in vCenter

Choices:

  • "connected" ← (default)

  • "disconnected"

username

aliases: admin, user

string

The username of the vSphere vCenter server.

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

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

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

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

See Also

See also

vmware.vmware.esxi_host

Manage VMware ESXi host status in vCenter.

Examples

- name: Connect Host
  vmware.vmware.esxi_connection:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    datacenter: "{{ vcenter_datacenter }}"
    esxi_host_name: 10.10.10.10
    state: connected

- name: Disconnect Host
  vmware.vmware.esxi_connection:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    datacenter: "{{ vcenter_datacenter }}"
    esxi_host_name: 10.10.10.10
    state: disconnected

Return Values

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

Key

Description

host

dictionary

Identifying information about the managed host

Returned: Always

Sample: {"host": {"moid": "host-111111", "name": "10.10.10.10"}}

result

dictionary

Information about the vCenter task, if something changed

Returned: On change

Sample: {"result": {"completion_time": "2024-07-29T15:27:37.041577+00:00", "entity_name": "test-5fb1_my_esxi_host", "error": null, "state": "success"}}

Authors

  • Ansible Cloud Team (@ansible-collections)