Documentation

vmware_host - Add/remove ESXi host to/from vCenter

New in version 2.0.

Synopsis

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

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
  • present
  • absent
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

# Example from Ansible playbook

    - name: Add ESXi Host to VCSA
      local_action:
        module: vmware_host
        hostname: vcsa_host
        username: vcsa_user
        password: vcsa_pass
        datacenter_name: datacenter_name
        cluster_name: cluster_name
        esxi_hostname: esxi_hostname
        esxi_username: esxi_username
        esxi_password: esxi_password
        state: present

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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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