Added some missing config documentation to the vsphere driver

This commit is contained in:
rallytime 2015-06-16 13:47:58 -06:00
parent 3d33fe7676
commit bfdebb6e18

View file

@ -37,6 +37,8 @@ configuration at:
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
@ -51,17 +53,22 @@ your VMWare installation is configured:
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.
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.
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.
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.
IF not specified:
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.
@ -70,8 +77,25 @@ host: MOR of the host where the virtual machine should be registered.
* 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
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.
.. versionadded:: 2015.5.2
sudo_password
The password corresponding to the sudo user to access the VM with sudo privileges.
.. versionadded:: 2015.5.2
'''
from __future__ import absolute_import