Manage VMware vCenter servers and ESXi hosts.
New in version 2015.8.4.
| codeauthor: | Alexandru Bleotu <alexandru.bleotu@morganstaley.com> |
|---|
PyVmomi can be installed via pip:
pip install pyVmomi
Note
Version 6.0 of pyVmomi has some problems with SSL error handling on certain versions of Python. If using version 6.0 of pyVmomi, Python 2.7.9, or newer must be present. This is due to an upstream dependency in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the version of Python is not in the supported range, you will need to install an earlier version of pyVmomi. See Issue #29537 for more information.
Based on the note above, to install an earlier version of pyVmomi than the version currently listed in PyPi, run the following:
pip install pyVmomi==5.5.0.2014.1.1
The 5.5.0.2014.1.1 is a known stable version that this original vSphere Execution Module was developed against.
Currently, about a third of the functions used in the vSphere Execution Module require the ESXCLI package be installed on the machine running the Proxy Minion process.
The ESXCLI package is also referred to as the VMware vSphere CLI, or vCLI. VMware provides vCLI package installation instructions for vSphere 5.5 and vSphere 6.0.
Once all of the required dependencies are in place and the vCLI package is installed, you can check to see if you can connect to your ESXi host or vCenter server by running the following command:
esxcli -s <host-location> -u <username> -p <password> system syslog config get
If the connection was successful, ESXCLI was successfully installed on your system. You should see output related to the ESXi host's syslog configuration.
Note
Be aware that some functionality in this execution module may depend on the type of license attached to a vCenter Server or ESXi host(s).
For example, certain services are only available to manipulate service state or policies with a VMware vSphere Enterprise or Enterprise Plus license, while others are available with a Standard license. The ntpd service is restricted to an Enterprise Plus license, while ssh is available via the Standard license.
Please see the vSphere Comparison page for more information.
This execution module was designed to be able to handle connections both to a vCenter Server, as well as to an ESXi host. It utilizes the pyVmomi Python library and the ESXCLI package to run remote execution functions against either the defined vCenter server or the ESXi host.
Whether or not the function runs against a vCenter Server or an ESXi host depends entirely upon the arguments passed into the function. Each function requires a host location, username, and password. If the credentials provided apply to a vCenter Server, then the function will be run against the vCenter Server. For example, when listing hosts using vCenter credentials, you'll get a list of hosts associated with that vCenter Server:
# salt my-minion vsphere.list_hosts <vcenter-ip> <vcenter-user> <vcenter-password> my-minion: - esxi-1.example.com - esxi-2.example.com
However, some functions should be used against ESXi hosts, not vCenter Servers. Functionality such as getting a host's coredump network configuration should be performed against a host and not a vCenter server. If the authentication information you're using is against a vCenter server and not an ESXi host, you can provide the host name that is associated with the vCenter server in the command, as a list, using the host_names or esxi_host kwarg. For example:
# salt my-minion vsphere.get_coredump_network_config <vcenter-ip> <vcenter-user> <vcenter-password> esxi_hosts='[esxi-1.example.com, esxi-2.example.com]'
my-minion:
----------
esxi-1.example.com:
----------
Coredump Config:
----------
enabled:
False
esxi-2.example.com:
----------
Coredump Config:
----------
enabled:
True
host_vnic:
vmk0
ip:
coredump-location.example.com
port:
6500 You can also use these functions against an ESXi host directly by establishing a connection to an ESXi host using the host's location, username, and password. If ESXi connection credentials are used instead of vCenter credentials, the host_names and esxi_hosts arguments are not needed.
# salt my-minion vsphere.get_coredump_network_config esxi-1.example.com root <host-password>
local:
----------
10.4.28.150:
----------
Coredump Config:
----------
enabled:
True
host_vnic:
vmk0
ip:
coredump-location.example.com
port:
6500 Adds capacity disks to the disk group with the specified cache disk.
salt '*' vsphere.add_capacity_to_diskgroup
cache_disk_id='naa.000000000000001'
capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' Adds an ESXi host to a vSphere Distributed Virtual Switch and migrates the desired adapters to the DVS from the standard switch.
https.443.CLI Example:
salt some_host vsphere.add_host_to_dvs host='vsphere.corp.com'
username='[email protected]' password='vsphere_password'
vmknic_name='vmk0' vmnic_name='vnmic0' dvs_name='DSwitch'
target_portgroup_name='DPortGroup' uplink_portgroup_name='DSwitch1-DVUplinks-181'
protocol='https' port='443', host_names="['esxi1.corp.com','esxi2.corp.com','esxi3.corp.com']" Return Example:
somehost:
----------
esxi1.corp.com:
----------
dvs:
DSwitch
portgroup:
DPortGroup
status:
True
uplink:
DSwitch-DVUplinks-181
vmknic:
vmk0
vmnic:
vmnic0
esxi2.corp.com:
----------
dvs:
DSwitch
portgroup:
DPortGroup
status:
True
uplink:
DSwitch-DVUplinks-181
vmknic:
vmk0
vmnic:
vmnic0
esxi3.corp.com:
----------
dvs:
DSwitch
portgroup:
DPortGroup
status:
True
uplink:
DSwitch-DVUplinks-181
vmknic:
vmk0
vmnic:
vmnic0
message:
success:
True This was very difficult to figure out. VMware's PyVmomi documentation at
https://github.com/vmware/pyvmomi/blob/master/docs/vim/DistributedVirtualSwitch.rst (which is a copy of the official documentation here: https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.DistributedVirtualSwitch.html)
says to create the DVS, create distributed portgroups, and then add the host to the DVS specifying which physical NIC to use as the port backing. However, if the physical NIC is in use as the only link from the host to vSphere, this will fail with an unhelpful "busy" error.
There is, however, a Powershell PowerCLI cmdlet called Add-VDSwitchPhysicalNetworkAdapter that does what we want. I used Onyx (https://labs.vmware.com/flings/onyx) to sniff the SOAP stream from Powershell to our vSphere server and got this snippet out:
<UpdateNetworkConfig xmlns="urn:vim25">
<_this type="HostNetworkSystem">networkSystem-187</_this>
<config>
<vswitch>
<changeOperation>edit</changeOperation>
<name>vSwitch0</name>
<spec>
<numPorts>7812</numPorts>
</spec>
</vswitch>
<proxySwitch>
<changeOperation>edit</changeOperation>
<uuid>73 a4 05 50 b0 d2 7e b9-38 80 5d 24 65 8f da 70</uuid>
<spec>
<backing xsi:type="DistributedVirtualSwitchHostMemberPnicBacking">
<pnicSpec><pnicDevice>vmnic0</pnicDevice></pnicSpec>
</backing>
</spec>
</proxySwitch>
<portgroup>
<changeOperation>remove</changeOperation>
<spec>
<name>Management Network</name><vlanId>-1</vlanId><vswitchName /><policy />
</spec>
</portgroup>
<vnic>
<changeOperation>edit</changeOperation>
<device>vmk0</device>
<portgroup />
<spec>
<distributedVirtualPort>
<switchUuid>73 a4 05 50 b0 d2 7e b9-38 80 5d 24 65 8f da 70</switchUuid>
<portgroupKey>dvportgroup-191</portgroupKey>
</distributedVirtualPort>
</spec>
</vnic>
</config>
<changeMode>modify</changeMode>
</UpdateNetworkConfig> The SOAP API maps closely to PyVmomi, so from there it was (relatively) easy to figure out what Python to write.
Adds a license to the vCenter or ESXi host
salt '*' vsphere.add_license key=<license_key> desc='License desc'
Assigns a storage policy as the default policy to a datastore.
salt '*' vsphere.assign_storage_policy_to_datastore
policy='policy name' datastore=ds1 Assigns a license to an entity
_get_entity docstrings for format.salt '*' vsphere.assign_license license_key=00000:00000
license name=test entity={type:cluster,datacenter:dc,cluster:cl} Compares virtual machine current and new configuration, the current is the one which is deployed now, and the new is the target config. Returns the differences between the objects in a dictionary, the keys are the configuration parameter keys and the values are differences objects: either list or recursive difference
Configures the host cache on the selected host.
true.true. Must be smaller than the datastore size.salt '*' vsphere.configure_host_cache enabled=False
salt '*' vsphere.configure_host_cache enabled=True datastore=ds1
swap_size_MiB=1024 Enable or disable ESXi core dump collection. Returns True if coredump is enabled and returns False if core dump is not enabled. If there was an error, the error will be the value printed in the Error key dictionary for the given host.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.CLI Example:
# Used for ESXi host connection information salt '*' vsphere.coredump_network_enable my.esxi.host root bad-password True # Used for connecting to a vCenter Server salt '*' vsphere.coredump_network_enable my.vcenter.location root bad-password True esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Creates a cluster.
Note: cluster_dict['name'] will be overridden by the cluster param value
# esxdatacenter proxy salt '*' vsphere.create_cluster cluster_dict=$cluster_dict cluster=cl1 # esxcluster proxy salt '*' vsphere.create_cluster cluster_dict=$cluster_dict
Creates a datacenter.
Supported proxies: esxdatacenter
salt '*' vsphere.create_datacenter dc1
Creates disk group on an ESXi host with the specified cache and capacity disks.
salt '*' vsphere.create_diskgroup cache_disk_id='naa.000000000000001'
capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' Creates a distributed virtual portgroup.
Note: The portgroup_name param will override any name already set in portgroup_dict.
salt '*' vsphere.create_dvportgroup portgroup_dict=<dict>
portgroup_name=pg1 dvs=dvs1 Creates a distributed virtual switch (DVS).
Note: The dvs_name param will override any name set in dvs_dict.
salt '*' vsphere.create_dvs dvs dict=$dvs_dict dvs_name=dvs_name
Creates a storage policy.
Supported capability types: scalar, set, range.
policy_dict.salt '*' vsphere.create_storage_policy policy_name='policy name'
policy_dict="$policy_dict" Creates a virtual machine container.
CLI Example:
salt vm_minion vsphere.create_vm vm_name=vmname cpu='{count: 2, nested: True}' ... interfaces
interfaces:
adapter: 'Network adapter 1'
name: vlan100
switch_type: distributed or standard
adapter_type: vmxnet3 or vmxnet, vmxnet2, vmxnet3, e1000, e1000e
mac: '00:11:22:33:44:55'
connectable:
allow_guest_control: True
connected: True
start_connected: True disks
disks: adapter: 'Hard disk 1' size: 16 unit: GB address: '0:0' controller: 'SCSI controller 0' thin_provision: False eagerly_scrub: False datastore: 'myshare' filename: 'vm/mydisk.vmdk'
scsi_devices
scsi_devices: controller: 'SCSI controller 0' type: paravirtual bus_sharing: no_sharing
serial_ports
serial_ports:
adapter: 'Serial port 1'
type: network
backing:
uri: 'telnet://something:port'
direction: <client|server>
filename: 'service_uri'
connectable:
allow_guest_control: True
connected: True
start_connected: True
yield: False cd_drives
cd_drives:
adapter: 'CD/DVD drive 0'
controller: 'IDE 0'
device_type: datastore_iso_file
datastore_iso_file:
path: path_to_iso
connectable:
allow_guest_control: True
connected: True
start_connected: True
Creates a ESXi host disk group with the specified cache and capacity disks.
salt '*' vsphere.create_vmfs_datastore datastore_name=ds1 disk_id=
vmfs_major_version=5 Removes extra config parameters from a virtual machine
Deletes a virtual machine defined by name and placement
salt '*' vsphere.delete_vm name=my_vm datacenter=my_datacenter
Disconnects from a vCenter or ESXi host
Note
Should be used by state functions, not invoked directly.
CLI Example:
See note above.
Enable or disable an ESXi firewall rule set.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | A standard cmd.run_all dictionary, per host. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.enable_firewall_ruleset my.esxi.host root bad-password True 'syslog' # Used for connecting to a vCenter Server salt '*' vsphere.enable_firewall_ruleset my.vcenter.location root bad-password True 'syslog' esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Erases the partitions on a disk. The disk can be specified either by the canonical name, or by the scsi_address.
disk_id or scsi_address needs to be specified (disk_id supersedes scsi_address.disk_id or scsi_address needs to be specified (disk_id supersedes scsi_address.salt '*' vsphere.erase_disk_partitions scsi_address='vmhaba0:C0:T0:L0' salt '*' vsphere.erase_disk_partitions disk_id='naa.000000000000001'
Run an ESXCLI command directly on the host or list of hosts.
root.-s, -u, -p, -h, --protocol, or --portnumber arguments that are frequently passed when using a bare ESXCLI command from the command line. Those arguments are handled by this function via the other args and kwargs.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.CLI Example:
# Used for ESXi host connection information salt '*' vsphere.esxcli_cmd my.esxi.host root bad-password 'system coredump network get' # Used for connecting to a vCenter Server salt '*' vsphere.esxcli_cmd my.vcenter.location root bad-password 'system coredump network get' esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Returns extra config parameters from a virtual machine advanced config list
Retrieve information on ESXi or vCenter network dump collection and format it into a dictionary.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | A dictionary with the network configuration, or, if getting the network config failed, a an error message retrieved from the standard cmd.run_all dictionary, per host. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.get_coredump_network_config my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_coredump_network_config my.vcenter.location root bad-password esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Show status of all firewall rule sets.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | Nested dictionary with two toplevel keys rulesets and success success will be True or False depending on query success rulesets will list the rulesets and their statuses if success was true, per host. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.get_firewall_status my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_firewall_status my.vcenter.location root bad-password esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Returns the host cache configuration on the proxy host.
salt '*' vsphere.get_host_cache
Get the date/time information for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to get date/time information.
If host_names is not provided, the date/time information will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_host_datetime my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_host_datetime my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Get the NTP configuration information for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to get ntp configuration information.
If host_names is not provided, the NTP configuration will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_ntp_config my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_ntp_config my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Returns the proxy type retrieved either from the pillar of from the proxy minion's config. Returns <undefined> otherwise.
CLI Example:
salt '*' vsphere.get_proxy_type
Returns a service instance to the proxied endpoint (vCenter/ESXi host).
Note
Should be used by state functions not invoked directly.
Get the service name's policy for a given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to get service policy information.
If host_names is not provided, the service policy information will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_service_policy my.esxi.host root bad-password 'ssh' # Used for connecting to a vCenter Server salt '*' vsphere.get_service_policy my.vcenter.location root bad-password 'ntpd' host_names='[esxi-1.host.com, esxi-2.host.com]'
Get the service name's running state for a given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to get the service's running state.
If host_names is not provided, the service's running state will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_service_running my.esxi.host root bad-password 'ssh' # Used for connecting to a vCenter Server salt '*' vsphere.get_service_running my.vcenter.location root bad-password 'ntpd' host_names='[esxi-1.host.com, esxi-2.host.com]'
Retrieve the authorized_keys entry for root. This function only works for ESXi, not vCenter.
| Parameters: |
|
|---|---|
| Returns: |
True if upload is successful |
CLI Example:
salt '*' vsphere.get_ssh_key my.esxi.host root bad-password certificate_verify=True
Retrieve the syslog configuration.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | Dictionary with keys and values corresponding to the syslog configuration, per host. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.get_syslog_config my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_syslog_config my.vcenter.location root bad-password esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Returns vm object properties.
Queries and converts the virtual machine properties to the available format from the schema. If the objects attribute is True the config objects will have extra properties, like 'object' which will include the vim.vm.device.VirtualDevice, this is necessary for deletion and update actions.
Queries the virtual machine config file and returns vim.host.DatastoreBrowser.SearchResults object on success None on failure
Get the VMotion enabled status for a given host or a list of host_names. Returns True if VMotion is enabled, False if it is not enabled.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts to check if VMotion is enabled.
If host_names is not provided, the VMotion status will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_vmotion_enabled my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_vmotion_enabled my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Returns a list of VSAN-eligible disks for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts to check if any VSAN-eligible disks are available.
If host_names is not provided, the VSAN-eligible disks will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_vsan_eligible_disks my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_vsan_eligible_disks my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Get the VSAN enabled status for a given host or a list of host_names. Returns True if VSAN is enabled, False if it is not enabled, and None if a VSAN Host Config is unset, per host.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts to check if VSAN enabled.
If host_names is not provided, the VSAN status will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.get_vsan_enabled my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.get_vsan_enabled my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Decorator that connects to a target system (vCenter or ESXi host) using the proxy details and passes the connection (vim.ServiceInstance) to the decorated function.
Supported proxies: esxi, esxcluster, esxdatacenter.
Notes
1. The decorated function must have a service_instance parameter or a **kwarg type argument (name of argument is not important); 2. If the service_instance parameter is already defined, the value is passed through to the decorated function; 3. If the service_instance parameter in not defined, the connection is created using the proxy details and the service instance is returned.
Lists the licenses assigned to an entity
_get_entity docstrings for format.salt '*' vsphere.list_assigned_licenses
entity={type:cluster,datacenter:dc,cluster:cl}
entiy_display_name=cl Returns a list of the metadata of all capabilities in the vCenter.
salt '*' vsphere.list_capabilities
Returns a dict representation of an ESX cluster.
# vcenter proxy salt '*' vsphere.list_cluster datacenter=dc1 cluster=cl1 # esxdatacenter proxy salt '*' vsphere.list_cluster cluster=cl1 # esxcluster proxy salt '*' vsphere.list_cluster
Returns a list of clusters for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_clusters 1.2.3.4 root bad-password
Returns a list of datacenters for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_datacenters 1.2.3.4 root bad-password
Returns a list of dict representations of VMware datacenters. Connection is done via the proxy details.
Supported proxies: esxdatacenter
salt '*' vsphere.list_datacenters_via_proxy salt '*' vsphere.list_datacenters_via_proxy dc1 salt '*' vsphere.list_datacenters_via_proxy dc1,dc2 salt '*' vsphere.list_datacenters_via_proxy datacenter_names=[dc1, dc2]
Returns a list of datastore clusters for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_datastore_clusters 1.2.3.4 root bad-password
Returns a list of datastores for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_datastores 1.2.3.4 root bad-password
Returns a list of dict representations of the datastores visible to the proxy object. The list of datastores can be filtered by datastore names, backing disk ids (canonical names) or backing disk scsi addresses.
Supported proxy types: esxi, esxcluster, esxdatacenter
salt '*' vsphere.list_datastores_via_proxy salt '*' vsphere.list_datastores_via_proxy datastore_names=[ds1, ds2]
Returns a list of datastores assign the the storage policies.
salt '*' vsphere.list_default_storage_policy_of_datastore datastore=ds1
Returns the default vsan storage policy.
salt '*' vsphere.list_storage_policies salt '*' vsphere.list_storage_policy policy_names=[policy_name]
Lists the partitions on a disk. The disk can be specified either by the canonical name, or by the scsi_address.
disk_id or scsi_address needs to be specified (disk_id supersedes scsi_address.disk_id or scsi_address needs to be specified (disk_id supersedes scsi_address.salt '*' vsphere.list_disk_partitions scsi_address='vmhaba0:C0:T0:L0' salt '*' vsphere.list_disk_partitions disk_id='naa.000000000000001'
Returns a list of disk group dict representation on an ESXi host. The list of disk groups can be filtered by the cache disks canonical names. If no filtering is applied, all disk groups are returned.
salt '*' vsphere.list_diskgroups salt '*' vsphere.list_diskgroups cache_disk_ids='[naa.000000000000001]'
Returns a list of dict representations of the disks in an ESXi host. The list of disks can be filtered by disk canonical names or scsi addresses.
salt '*' vsphere.list_disks
salt '*' vsphere.list_disks disk_ids='[naa.00, naa.001]'
salt '*' vsphere.list_disks
scsi_addresses='[vmhba0:C0:T0:L0, vmhba1:C0:T0:L0]' Returns a list of distributed virtual switch portgroups. The list can be filtered by the portgroup names or by the DVS.
salt '*' vsphere.list_dvporgroups salt '*' vsphere.list_dvportgroups dvs=dvs1 salt '*' vsphere.list_dvportgroups portgroup_names=[pg1] salt '*' vsphere.list_dvportgroups dvs=dvs1 portgroup_names=[pg1]
Returns a list of distributed virtual switches for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_dvs 1.2.3.4 root bad-password
Returns a list of distributed virtual switches (DVSs). The list can be filtered by the datacenter or DVS names.
salt '*' vsphere.list_dvss salt '*' vsphere.list_dvss dvs_names=[dvs1,dvs2]
Returns a list of folders for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_folders 1.2.3.4 root bad-password
Returns a list of hosts for the the specified VMware environment.
root.https.443.CLI Example:
salt '*' vsphere.list_hosts 1.2.3.4 root bad-password
Returns a list of hosts for the the specified VMware environment. The list of hosts can be filtered by datacenter name and/or cluster name
CLI Example:
salt '*' vsphere.list_hosts_via_proxy salt '*' vsphere.list_hosts_via_proxy hostnames=[esxi1.example.com] salt '*' vsphere.list_hosts_via_proxy datacenter=dc1 cluster=cluster1
Lists all licenses on a vCenter.
salt '*' vsphere.list_licenses
Returns a list of networks for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_networks 1.2.3.4 root bad-password
Returns a list of Non-SSD disks for the given host or list of host_names.
Note
In the pyVmomi StorageSystem, ScsiDisks may, or may not have an ssd attribute. This attribute indicates if the ScsiDisk is SSD backed. As this option is optional, if a relevant disk in the StorageSystem does not have ssd = true, it will end up in the non_ssds list here.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to retrieve Non-SSD disks.
If host_names is not provided, Non-SSD disks will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.list_non_ssds my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.list_non_ssds my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Returns a list of resource pools for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_resourcepools 1.2.3.4 root bad-password
Returns a list of SSDs for the given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to retrieve SSDs.
If host_names is not provided, SSDs will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.list_ssds my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.list_ssds my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Returns a list of storage policies.
salt '*' vsphere.list_storage_policies salt '*' vsphere.list_storage_policy policy_names=[policy_name]
Returns the uplink portgroup of a distributed virtual switch.
salt '*' vsphere.list_uplink_dvportgroup dvs=dvs_name
Returns a list of vApps for the the specified host.
root.https.443.CLI Example:
# List vapps from all minions salt '*' vsphere.list_vapps 1.2.3.4 root bad-password
Returns a list of VMs for the the specified host.
root.https.443.CLI Example:
salt '*' vsphere.list_vms 1.2.3.4 root bad-password
Powers off a virtual machine specified by it's name.
salt '*' vsphere.power_off_vm name=my_vm
Powers on a virtual machine specified by it's name.
salt '*' vsphere.power_on_vm name=my_vm
Registers a virtual machine to the inventory with the given vmx file. Returns comments and change list
Remove capacity disks from the disk group with the specified cache disk.
salt '*' vsphere.remove_capacity_from_diskgroup
cache_disk_id='naa.000000000000001'
capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' Removes a datastore. If multiple datastores an error is raised.
salt '*' vsphere.remove_datastore ds_name
Remove the diskgroup with the specified cache disk.
salt '*' vsphere.remove_diskgroup cache_disk_id='naa.000000000000001'
Removes a distributed virtual portgroup.
salt '*' vsphere.remove_dvportgroup portgroup=pg1 dvs=dvs1
Renames a datastore. The datastore needs to be visible to the proxy.
salt '*' vsphere.rename_datastore old_name new_name
Reset the syslog service to its default settings.
Valid syslog_config values are logdir, loghost, logdir-unique, default-rotate, default-size, default-timeout, or all for all of these.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | Dictionary with a top-level key of 'success' which indicates if all the parameters were reset, and individual keys for each parameter indicating which succeeded or failed, per host. |
|---|
CLI Example:
syslog_config can be passed as a quoted, comma-separated string, e.g.
# Used for ESXi host connection information salt '*' vsphere.reset_syslog_config my.esxi.host root bad-password syslog_config='logdir,loghost' # Used for connecting to a vCenter Server salt '*' vsphere.reset_syslog_config my.vcenter.location root bad-password syslog_config='logdir,loghost' esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Restart the named service for the given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to restart the service.
If host_names is not provided, the service will be restarted for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.service_restart my.esxi.host root bad-password 'ntpd' # Used for connecting to a vCenter Server salt '*' vsphere.service_restart my.vcenter.location root bad-password 'ntpd' host_names='[esxi-1.host.com, esxi-2.host.com]'
Start the named service for the given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to start the service.
If host_names is not provided, the service will be started for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.service_start my.esxi.host root bad-password 'ntpd' # Used for connecting to a vCenter Server salt '*' vsphere.service_start my.vcenter.location root bad-password 'ntpd' host_names='[esxi-1.host.com, esxi-2.host.com]'
Stop the named service for the given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to stop the service.
If host_names is not provided, the service will be stopped for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.service_stop my.esxi.host root bad-password 'ssh' # Used for connecting to a vCenter Server salt '*' vsphere.service_stop my.vcenter.location root bad-password 'ssh' host_names='[esxi-1.host.com, esxi-2.host.com]'
Appends extra config parameters to a virtual machine advanced config list
Set the network parameters for a network coredump collection. Note that ESXi requires that the dumps first be enabled (see coredump_network_enable) before these parameters may be set.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.vmk0.6500.| Returns: | A standard cmd.run_all dictionary with a success key added, per host. success will be True if the set succeeded, False otherwise. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.set_coredump_network_config my.esxi.host root bad-password 'dump_ip.host.com' # Used for connecting to a vCenter Server salt '*' vsphere.set_coredump_network_config my.vcenter.location root bad-password 'dump_ip.host.com' esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Set NTP configuration for a given host of list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts to configure ntp servers.
If host_names is not provided, the NTP servers will be configured for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.ntp_configure my.esxi.host root bad-password '[192.174.1.100, 192.174.1.200]' # Used for connecting to a vCenter Server salt '*' vsphere.ntp_configure my.vcenter.location root bad-password '[192.174.1.100, 192.174.1.200]' host_names='[esxi-1.host.com, esxi-2.host.com]'
Set the service name's policy for a given host or list of hosts.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter the hosts for which to set the service policy.
If host_names is not provided, the service policy information will be retrieved for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.set_service_policy my.esxi.host root bad-password 'ntpd' 'automatic' # Used for connecting to a vCenter Server salt '*' vsphere.set_service_policy my.vcenter.location root bad-password 'ntpd' 'automatic' host_names='[esxi-1.host.com, esxi-2.host.com]'
Set the specified syslog configuration parameter. By default, this function will reset the syslog service after the configuration is set.
Name of parameter to set (corresponds to the command line switch for esxcli without the double dashes (--))
Valid syslog_config values are logdir, loghost, default-rotate`,
``default-size, default-timeout, and logdir-unique.
Value for the above parameter. For loghost, URLs or IP addresses to use for logging. Multiple log servers can be specified by listing them, comma-separated, but without spaces before or after commas.
(reference: https://blogs.vmware.com/vsphere/2012/04/configuring-multiple-syslog-servers-for-esxi-5.html)
https.443.True.True.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | Dictionary with a top-level key of 'success' which indicates if all the parameters were reset, and individual keys for each parameter indicating which succeeded or failed, per host. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.set_syslog_config my.esxi.host root bad-password loghost ssl://localhost:5432,tcp://10.1.0.1:1514 # Used for connecting to a vCenter Server salt '*' vsphere.set_syslog_config my.vcenter.location root bad-password loghost ssl://localhost:5432,tcp://10.1.0.1:1514 esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Decorator to specify which proxy types are supported by a function
Reload the syslog service so it will pick up any changes.
root.https.443.host is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines.| Returns: | A standard cmd.run_all dictionary. This dictionary will at least have a retcode key. If retcode is 0 the command was successful. |
|---|
CLI Example:
# Used for ESXi host connection information salt '*' vsphere.syslog_service_reload my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.syslog_service_reload my.vcenter.location root bad-password esxi_hosts='[esxi-1.host.com, esxi-2.host.com]'
Return system information about a VMware environment.
root.https.443.CLI Example:
salt '*' vsphere.system_info 1.2.3.4 root bad-password
Checks if a connection is to a vCenter
CLI Example:
salt '*' vsphere.test_vcenter_connection
Unregisters a virtual machine defined by name and placement
salt '*' vsphere.unregister_vm name=my_vm datacenter=my_datacenter
Updates a cluster.
# esxdatacenter proxy salt '*' vsphere.update_cluster cluster_dict=$cluster_dict cluster=cl1 # esxcluster proxy salt '*' vsphere.update_cluster cluster_dict=$cluster_dict
Updates a distributed virtual portgroup.
salt '*' vsphere.update_dvportgroup portgroup_dict=<dict>
portgroup=pg1
salt '*' vsphere.update_dvportgroup portgroup_dict=<dict>
portgroup=pg1 dvs=dvs1 Updates a distributed virtual switch (DVS).
dvs_dict will be ignored.salt '*' vsphere.update_dvs dvs_dict=$dvs_dict dvs=dvs1
Update the date/time on the given host or list of host_names. This function should be used with caution since network delays and execution delays can result in time skews.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts should update their date/time.
If host_names is not provided, the date/time will be updated for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.update_date_time my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.update_date_time my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Update the password for a given host.
Note
Currently only works with connections to ESXi hosts. Does not work with vCenter servers.
root.https.443.CLI Example:
salt '*' vsphere.update_host_password my.esxi.host root original-bad-password new-bad-password
Updates a storage policy.
Supported capability types: scalar, set, range.
salt '*' vsphere.update_storage_policy policy='policy name'
policy_dict="$policy_dict" Updates the configuration of the virtual machine if the config differs
Upload an ssh key for root to an ESXi host via http PUT. This function only works for ESXi, not vCenter. Only one ssh key can be uploaded for root. Uploading a second key will replace any existing key.
| Parameters: |
|
|---|---|
| Returns: |
Dictionary with a 'status' key, True if upload is successful. If upload is unsuccessful, 'status' key will be False and an 'Error' key will have an informative message. |
CLI Example:
salt '*' vsphere.upload_ssh_key my.esxi.host root bad-password ssh_key_file='/etc/salt/my_keys/my_key.pub'
Disable vMotion for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts should disable VMotion.
If host_names is not provided, VMotion will be disabled for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.vmotion_disable my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.vmotion_disable my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Enable vMotion for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts should enable VMotion.
If host_names is not provided, VMotion will be enabled for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
vmk0.CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.vmotion_enable my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.vmotion_enable my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Add any VSAN-eligible disks to the VSAN System for the given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts need to add any VSAN-eligible disks to the host's VSAN system.
If host_names is not provided, VSAN-eligible disks will be added to the hosts's VSAN system for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.vsan_add_disks my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.vsan_add_disks my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Disable VSAN for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts should disable VSAN.
If host_names is not provided, VSAN will be disabled for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.vsan_disable my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.vsan_disable my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
Enable VSAN for a given host or list of host_names.
root.https.443.List of ESXi host names. When the host, username, and password credentials are provided for a vCenter Server, the host_names argument is required to tell vCenter which hosts should enable VSAN.
If host_names is not provided, VSAN will be enabled for the host location instead. This is useful for when service instance connection information is used for a single ESXi host.
CLI Example:
# Used for single ESXi host connection information salt '*' vsphere.vsan_enable my.esxi.host root bad-password # Used for connecting to a vCenter Server salt '*' vsphere.vsan_enable my.vcenter.location root bad-password host_names='[esxi-1.host.com, esxi-2.host.com]'
© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.vsphere.html