Proxy Minion interface module for managing VMWare ESXi virtual machines.
To use this integration proxy module, please configure the following:
Proxy minions get their configuration from Salt's Pillar. This can now happen from the proxy's configuration file.
proxy: proxytype: esxvm datacenter: <datacenter name> vcenter: <ip or dns name of parent vcenter> mechanism: userpass username: <vCenter username> passwords: (required if userpass is used) - first_password - second_password - third_password
proxy: proxytype: esxvm datacenter: <datacenter name> vcenter: <ip or dns name of parent vcenter> mechanism: sspi domain: <user domain> principal: <host kerberos principal>
To use this Proxy Module, set this to
Name of the datacenter where the virtual machine should be deployed. Required.
The location of the VMware vCenter server (host of ip) where the virtual machine should be managed. Required.
The mechanism used to connect to the vCenter server. Supported values are
Connections are attempted using all (
combinations on proxy startup.
The username used to login to the host, such as
root. Required if mechanism
A list of passwords to be used to try and login to the vCenter server. At least
one password in this list is required if mechanism is
userpass. When the
proxy comes up, it will try the passwords listed in order.
User realm domain. Required if mechanism is
Kerberos principal. Rquired if mechanism is
If the ESXi host is not using the default protocol, set this value to an
alternate protocol. Default is
If the ESXi host is not using the default port, set this value to an
alternate port. Default is
After your pillar is in place, you can test the proxy. The proxy can run on any machine that has network connectivity to your Salt Master and to the vCenter server in the pillar. SaltStack recommends that the machine running the salt-proxy process also run a regular minion, though it is not strictly necessary.
To start a proxy minion one needs to establish its identity <id>:
salt-proxy --proxyid <proxy_id>
On the machine that will run the proxy, make sure there is a configuration file
present. By default this is
/etc/salt/proxy. If in a different location, the
<configuration_folder> has to be specified when running the proxy:
file with at least the following in it:
salt-proxy --proxyid <proxy_id> -c <configuration_folder>
Once the proxy is running it will connect back to the specified master and individual commands can be runs against it:
# Master - minion communication salt <proxy_id> test.ping # Test vcenter connection salt <proxy_id> vsphere.test_vcenter_connection
Associated states are documented in
Look there to find an example structure for Pillar as well as an example
.sls file for configuring an ESX virtual machine from scratch.
Cycle through all the possible credentials and return the first one that works.
Function that returns the cached details
This function gets called when the proxy starts up. For login the protocol and port are cached.
salt esx-vm test.ping
Shutdown the connection to the proxy device. For this proxy, shutdown is a no-op.