You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vmware_host - Add/remove ESXi host to/from vCenter¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

This module can be used to add/remove an ESXi host to/from vCenter.

Requirements (on host that executes module)¶

python >= 2.6

PyVmomi

Options ¶

parameter	required	default	choices	comments
cluster_name	yes			Name of the cluster to add the host.
datacenter_name	yes			Name of the datacenter to add the host.
esxi_hostname	yes			ESXi hostname to manage.
esxi_password	yes			ESXi password.
esxi_username	yes			ESXi username.
hostname	yes			The hostname or IP address of the vSphere vCenter.
password	yes			The password of the vSphere vCenter. aliases: pass, pwd
state	no	present	absent present	Add or remove the host.
username	yes			The username of the vSphere vCenter. aliases: user, admin
validate_certs	no	True	True False	Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples ¶

- name: Add ESXi Host to vCenter
  vmware_host:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    cluster_name: cluster_name
    esxi_hostname: '{{ esxi_hostname }}'
    esxi_username: '{{ esxi_username }}'
    esxi_password: '{{ esxi_password }}'
    state: present
  delegate_to: localhost

Notes ¶

Note

Tested on vSphere 5.5

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.