salt.cloud.clouds.vsphere¶

vSphere Cloud Module¶

The vSphere cloud module is used to control access to VMWare vSphere.

Note: Ensure python pysphere module is installed by running following one-liner check. The output should be 0.

python -c "import pysphere" ; echo $?
# if this fails install using
pip install https://pysphere.googlecode.com/files/pysphere-0.1.8.zip

Use of this module only requires a URL, username and password. Set up the cloud configuration at:

/etc/salt/cloud.providers or /etc/salt/cloud.providers.d/vsphere.conf:

my-vsphere-config:
  provider: vsphere
  user: myuser
  password: verybadpass
  template_user: root
  template_password: mybadVMpassword
  url: 'https://10.1.1.1:443'

Note: Your URL may or may not look like any of the following, depending on how your VMWare installation is configured:

10.1.1.1
10.1.1.1:443
https://10.1.1.1:443
https://10.1.1.1:443/sdk
10.1.1.1:443/sdk

folder

Name of the folder that will contain the new VM. If not set, the VM will be added to the folder the original VM belongs to.

resourcepool

MOR of the resourcepool to be used for the new vm. If not set, it uses the same resourcepool than the original vm.

datastore

MOR of the datastore where the virtual machine should be located. If not specified, the current datastore is used.

host

MOR of the host where the virtual machine should be registered.

Id not specified:

• if resourcepool is not specified, current host is used.
• if resourcepool is specified, and the target pool represents a stand-alone host, the host is used.
• if resourcepool is specified, and the target pool represents a DRS-enabled cluster, a host selected by DRS is used.
• if resourcepool is specified and the target pool represents a cluster without DRS enabled, an InvalidArgument exception will be thrown.

template

Specifies whether or not the new virtual machine should be marked as a template. Default is False.

template_user

Specifies the user to access the VM. Should be

template_password

The password with which to access the VM.

sudo

The user to access the VM with sudo privileges.

New in version 2015.5.2.

sudo_password

The password corresponding to the sudo user to access the VM with sudo privileges.

New in version 2015.5.2.

salt.cloud.clouds.vsphere.avail_images()¶

Return a dict of all available VM images on the cloud provider.

salt.cloud.clouds.vsphere.avail_locations()¶

Return a dict of all available VM locations on the cloud provider with relevant data

salt.cloud.clouds.vsphere.create(vm_)¶

Create a single VM from a data dict

salt.cloud.clouds.vsphere.destroy(name, call=None)¶

Destroy a node.

CLI Example:

salt-cloud --destroy mymachine

salt.cloud.clouds.vsphere.get_configured_provider()¶

Return the first configured instance.

salt.cloud.clouds.vsphere.get_conn()¶

Return a conn object for the passed VM data

salt.cloud.clouds.vsphere.list_clusters(kwargs=None, call=None)¶

List the clusters for this VMware environment

salt.cloud.clouds.vsphere.list_datacenters(kwargs=None, call=None)¶

List the data centers for this VMware environment

salt.cloud.clouds.vsphere.list_datastores(kwargs=None, call=None)¶

List the datastores for this VMware environment

salt.cloud.clouds.vsphere.list_folders(kwargs=None, call=None)¶

List the folders for this VMWare environment

salt.cloud.clouds.vsphere.list_hosts(kwargs=None, call=None)¶

List the hosts for this VMware environment

salt.cloud.clouds.vsphere.list_nodes(kwargs=None, call=None)¶

Return a list of the VMs that are on the provider, with basic fields

salt.cloud.clouds.vsphere.list_nodes_full(kwargs=None, call=None)¶

Return a list of the VMs that are on the provider with full details

salt.cloud.clouds.vsphere.list_nodes_min(kwargs=None, call=None)¶

Return a list of the nodes in the provider, with no details

salt.cloud.clouds.vsphere.list_nodes_select()¶

Return a list of the VMs that are on the provider, with select fields

salt.cloud.clouds.vsphere.list_resourcepools(kwargs=None, call=None)¶

List the hosts for this VMware environment

salt.cloud.clouds.vsphere.script(vm_)¶

Return the script deployment object

salt.cloud.clouds.vsphere.show_instance(name, call=None)¶

Show the details from vSphere concerning a guest

salt.cloud.clouds.vsphere.wait_for_ip(vm_)¶