VMware: standardization - ansible/community GitHub Wiki

VMware Parameter standardization

Connection plugins

vcenter

Question: Should we call this plugin vsphere or vmomi instead (or just vmware) ?

ansible_vcenter_host

The vCenter or ESXi hostname or IP address to use for the VMOMI connection. (Fallback: ansible_host or remote_addr)

ansible_vcenter_port

The vCenter or ESXi port to use for the VMOMI connection. (Fallback: ansible_port or remote_port)

ansible_vcenter_user

The vCenter or ESXi user to use for the VMOMI connection. (Fallback: ansible_user or remote_user)

ansible_vcenter_password

The vCenter or ESXi user password to use for the VMOMI connection. (Fallback: ansible_password)

ansible_vcenter_validate_certs

Whether TLS certificates need to be validated on connections. (defaults: yes)

ansible_vcenter_proxy

The proxy settings to use for the VMOMI connection.

ansible_vcenter_use_proxy

Whether to use the system proxy configuration for VMOMI connections. (defaults: yes)

vmwaretools

Question: Is vmwaretools a good name, or is there a better suggestion for the "connection".

The vmwaretools connection plugin would be using the same variables for the VMOMI connection as the vcenter connection plugin.

ansible_vmwaretools_host

The VM guest hostname or IP address to connect to. (Fallback: ansible_host or remote_addr)

ansible_vmwaretools_user

The VM guest username. (Fallback: ansible_user or remote_user)

ansible_vmwaretools_password

The VM guest user password. (Fallback: ansible_password)

ansible_vmwaretools_folder

The VM guest folder location.

ansible_vmwaretools_operation_delay

The delay between VMOMI operations in seconds. (Default: 5) (Why 5?)

ansible_vmwaretools_file_chunksize

The file chunksize to be used for VMOMI file operations. (Default: ?)

Module parameters

The below parameters will disappear when we have a working connection plugin.

host

The vCenter or ESXi hostname or IP address to use (Used to be hostname, but should become alias for backward compatibility)

port

The vCenter or ESXi port to use.

user

The vCenter or ESXi user to use.

password

The vCenter or ESXi user password to use.

validate_certs

Whether TLS certificates need to be validated on connections. (defaults: yes)

proxy

The proxy settings to use.

use_proxy

Whether to use the system proxy configuration. (defaults: yes)

common

  • cluster (not cluster_name)
  • datacenter
  • datastore
  • disk
  • esxi_hostname
  • folder
  • portgroup (not portgroup_name)
  • resource_pool
  • switch (not switch_name)
⚠️ **GitHub.com Fallback** ⚠️