File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/vsphere.cpython-310.pyc
Back
o ;j�� � @ s� d Z ddlZddlZddlZddlmZ ddlZddlm m Z ddl Zddl Zddl ZddlZddlZddlmZmZ ddlmZmZmZ ddlmZmZ ddlmZ ddl m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ dd l%m&Z&m'Z' dd l(m)Z) dd l*m+Z+ e�,e-�Z.zddl/Z/d Z0W n e1y� d Z0Y nw z'ddl2m3Z3m4Z4m5Z5m6Z6 de3j7v r�ej8dkr�ej8dk r�e.�9d� e1� �d Z:W n e1y� d Z:Y nw z3ddl;m<Z<m=Z=m>Z>m?Z?m@Z@ ddlAmBZBmCZCmDZDmEZEmFZF ddlGmHZH ddlImJZJ eBeCeDeEeFfZKd ZLW n e1�y d ZLY nw ej jM�Nd�ZOeO�rd ZPnd ZPdZQg d�ZRdd� ZSd d � ZTeTd d � �ZUd d!� ZVd"d#� ZWd$d%� ZXe&e:�eWd&d'd(d)d*�eT�d�d+d,����ZYe&e:�eWd&d'd(d)d*�eTd-d.� ���ZZe&eP�eT �d�d/d0���Z[e&eP�eT �d�d1d2���Z\e&eP�eT �d�d3d4���Z]e&eP�eT 5 6 �d�d7d8���Z^e&eP�eT �d�d9d:���Z_e&eP�eT �d�d;d<���Z`e&eP�eT �d�d=d>���Zae&eP�eT �d�d?d@���Zbe&eP�eT �d�dAdB���Zce&eP�eT �d�dCdD���Zde'dE�eT �d�dFdG���Zee'dE�eT �d�dHdI���Zfe&e:�e'dE�eT �d�dJdK����Zge&e:�e'dE�eT �d�dLdM����Zhe&e:�e'dE�eT �d�dNdO����Zie&e:�e'dE�eT �d�dPdQ����Zje&e:�e'dE�eT �d�dRdS����Zke&e:�e'dE�eT �d�dTdU����Zle&e:�e'dE�eT �d�dVdW����Zme&e:�eWd&d'd(d)d*�eXeT�d�dXdY�����Zne&e:�e'dE�eT �d�dZd[����Zoe&e:�e'dE�eT �d�d\d]����Zpe&e:�e'dE�eT�d�d^d_����Zqe&e:�e'dE�eT �d�d`da����Zre&e:�e'dE�eT �d�dbdc����Zse&e:�e'dE�eT�d�ddde����Zte&e:�e'dE�eT �d�dfdg����Zue&e:�e'dE�eT�d�dhdi����Zve&e:�e'dE�eT�d�djdk����Zwe&e:�e'dE�eT�d�dldm����Zxe&e:�e'dE�eT�d�dndo����Zye&e:�e'dE�eT�d�dpdq����Zze&e:�e'dE�eT �d�drds����Z{e&e:�e'dE�eT �d�dtdu����Z|e&e:�e'dE�eT �d�dvdw����Z}e&e:�e'dE�eT �d�dxdy����Z~e&e:�e'dE�eT �d�dzd{����Ze&e:�e'dE�eT �d�d|d}����Z�e&e:�e'dE�eT �d�d~d����Z�e&e:�e'dE�eT �d�d�d�����Z�e&e:�e'dE�eT �d�d�d�����Z�e&e:�e'dE�eT �d�d�d�����Z�e&e:�e'dE�eT 5 �d�d�d�����Z�e&e:�e'dE�eT �d�d�d�����Z�e&e:�e'dE�eT �d�d�d�����Z�e&e:�e'dE�eT �d�d�d�����Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�e&e:�eWd(d'�eXeT�d�d�d������Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�e&e:�eWd(d'�eXeT�d�d�d������Z�e&e:�eWd(d'�eXeT�d�d�d������Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�e&e:�eWd(d'�eXeT�d�d�d������Z�e&e:�eWd(d'�eXeT�d�d�d������Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�e&e:�eWd(d'�eXeT�d�d�d������Z�e&e:�eWd(d'�eXeT�d�d�d������Z�e&e:�eWd(d'�eXeT�d�d�dÄ����Z�d�dń Z�e&e:�eWd(d)�eXeT�d�d�dDŽ����Z�e&e:�eWd(d)�eXeT�d�d�dɄ����Z�d�d˄ Z�e&e:�eWd(d)�eXeT�d�d�d̈́����Z�d�dτ Z�e&e:�eWd(d)�eXeT�d�d�dф����Z�e&e:�eWd(d)�eXeT�d�d�dӄ����Z�e&e:�eWd'd(d)�eXeT�d�d�dՄ����Z�e&e:�eWd'd(d)�eXeT �d�d�dׄ����Z�e&e:�eWd(d'd)d*�eXeT�d�d�dل����Z�e&e:�eWd(d)�eXeT�d�d�dۄ����Z�d�d݄ Z�e&e:�eWd'd(�eXeT�d�d�d߄����Z��d�d�d�Z�e&e:�e&e0�eWd'd(�eXeT�d�d�d������Z�e&e:�e&e0�eWd'd(�eXeT�d�d�d������Z�e&e:�eWd&d'd(�eXeT �d�d�d�����Z�e&e:�e&e0�eWd&�eXeT �d�d�d������Z�e&e:�eWd&d'd(�eXeT�d�d�d�����Z�e&e:�eWd&d'd(�eXeT�d�d�d�����Z�e&e:�eWd'd(�eXeT�d�d�d�����Z�e&e:�eWd'd(�eXeT�d�d�d�����Z�d�d� Z�d�d�� Z�e&e:�e&e0�eWd'd(�eXeT �d�d�d�������Z�e&e:�e&e0�eWd'd(�eXeT �d�d�d�������Z�e&e:�eWd&d'd(d)�eXeT �d�d�d������Z�e&e:�eWd&�eXeT�d�d�d������Z�e&e:�eWd&�eXeT�d�d�d������Z�e&e:�eWd&�eXeT�d��d �d�����Z�e&e:�eWd&�eXeT�d��d�d�����Z�e&e:�e&e0�eWd&�eXeT �d��d�d������Z�e&e:�e&e0�eWd&�eXeT �d��d�d������Z�e&e:�e&e0�eWd&�eXeT �d��d�d ������Z�e&e:�e&e0�eWd&�eXeT�d��d �d ������Z�e&e:�eWd&�eXeT�d��d �d �����Z�e&e:�e&e0�eWd&�eXeT �d��d�d������Zɐd�d� Zʐd�d� Zːd�d� Z̐d�d� Z͐d�d� Zΐd��d�d�Zϐd �d � ZАd �d � Zѐd �d!� ZҐd"�d#� ZӐd$�d%� Z� �d��d&�d'�Z� �d��d(�d)�Z�e&e:�e'dE�eT �d��d*�d+����Z�e&e:�eWd&d'd(d)��d,�d-� ��Zؐd.�d/� Zِd0�d1� Zڐd2�d3� Z�e&e:�eXeT �d��d4�d5����Z�e&e:�eXeT�d��d6�d7����Zݐd��d9�d:�Zސd;�d<� Zߐd=�d>� Z�e&e:�eWd*d'd(�eXeT�d��d?�d@�����Z�d��dA�dB�Z�e&e:�eWd*d'd(�eXeT�d��dC�dD�����Z�dE�dF� Z�e&e:�eWd*d'd(�eXeT �d��dG�dH�����Z�dI�dJ� Z� � K �d��dL�dM�Z�d��dO�dP�Z�dQ�dR� Z� � 8 �d��dS�dT�Z�dU�dV� Z�dW�dX� Z�d��dY�dZ�Z�d[�d\� Z�d��d]�d^�Z� � _ �d��d`�da�Z�db�dc� Z�d��dd�de�Z�d��df�dg�Z�dh�di� Z�d��dj�dk�Z��dl�dm� Z��d��dn�do�Z��dp�dq� Z��dr�ds� Z��dt�du� Z�eT�dv�dw� �Z�eXeT�d��dx�dy���Z��dz�d{� Z��d|�d}� Z��d~�d� Z��d��d�� �Z �d��d��d���Z�d��d�� �Z�d��d��d���Ze&e:eL�eWd)�eXeT �d��d��d�������Ze&e:eL�eWd)�eXeT �d��d��d�������Ze&e:eL�eWd)�eXeT� � �d��d��d�������Ze&e:eL�eWd)�eXeT� � �d��d��d�������Ze&e:eL�eWd)�eXeT �d��d��d�������Ze&e:eL�eWd)�eXeT �d��d��d�������Z e&e:eL�eWd)�eXeT �d��d��d�������Z e&e:eL�eWd)�eXeT �d��d��d�������Z e&e:�eWd*d'd(�eXeT �d��d��d�������Z e&e:�eWd*d'd(�eXeT �d��d��d�������Z e&e:�eWd*d'd(�eXeT�d��d��d�������Ze&e:�eWd*d'd(�eXeT�d��d��d�������Ze&e:�eWd*d'd(�eXeT�d��d��d�������Z�d��d��d���Ze&e:�eWd*d'd(�eXeT�dd��d�������Ze&e:�eWd*d'd(�eXeT �dd��d�������ZdS (� aN Manage VMware vCenter servers and ESXi hosts. .. versionadded:: 2015.8.4 :codeauthor: Alexandru Bleotu <alexandru.bleotu@morganstaley.com> Dependencies ============ - pyVmomi Python Module - ESXCLI pyVmomi ------- PyVmomi can be installed via pip: .. code-block:: bash 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. .. _Issue #29537: https://github.com/saltstack/salt/issues/29537 Based on the note above, to install an earlier version of pyVmomi than the version currently listed in PyPi, run the following: .. code-block:: bash 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. vSphere Automation SDK ---------------------- vSphere Automation SDK can be installed via pip: .. code-block:: bash pip install --upgrade pip setuptools pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git .. note:: The SDK also requires OpenSSL 1.0.1+ if you want to connect to vSphere 6.5+ in order to support TLS1.1 & 1.2. In order to use the tagging functions in this module, vSphere Automation SDK is necessary to install. The module is currently in version 1.0.3 (as of 8/26/2019) ESXCLI ------ 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`_. .. _vSphere 5.5: http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.vcli.getstart.doc/cli_install.4.2.html .. _vSphere 6.0: http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vcli.getstart.doc/cli_install.4.2.html 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: .. code-block:: bash 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. .. _vSphere Comparison: https://www.vmware.com/products/vsphere/compare About ===== 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: .. code-block:: bash # 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: .. code-block:: bash # 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. .. code-block:: bash # 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 � N��wraps)�ESXClusterConfigSchema�ESXClusterEntitySchema)�DiskGroupsDiskIdSchema�SimpleHostCacheSchema�VmfsDatastoreSchema)� ESXVirtualMachineDeleteSchema�!ESXVirtualMachineUnregisterSchema)�VCenterEntitySchema)�ArgumentValueError�CommandExecutionError�InvalidConfigError�InvalidEntityError�VMwareApiError�VMwareObjectExistsError�VMwareObjectRetrievalError�VMwareSaltError)�depends�ignores_kwargs)�recursive_diff)� list_diffTF)� VmomiSupport�pbm�vim�vmodlz vim25/6.0)� � )r r � zFpyVmomi not loaded: Incompatible versions of Python. See Issue #29537.)�Category� CategoryModel�Tag�TagAssociation�TagModel)� AlreadyExists�InvalidArgument�NotFound�Unauthenticated� Unauthorized)� DynamicID)�Cluster�esxcliZvsphere)�esxi� esxcluster� esxdatacenter�vcenter�esxvmc C s t S �N)�__virtualname__� r3 r3 �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/vsphere.py� __virtual__* s r5 c s t � �� fdd��}|S )z> Decorator wrapper to warn about azurearm deprecation c s6 t jjjddtd� � | i t jjjdi |����}|S )NZArgonz�The 'vsphere' functionality in Salt has been deprecated and its functionality will be removed in version 3008 in favor of the saltext.vmware Salt Extension. (https://github.com/saltstack/salt-ext-modules-vmware))�categoryr3 )�salt�utilsZversionsZ warn_until� FutureWarning�args� clean_kwargs)r: �kwargs�ret��functionr3 r4 �wrapped3 s � z%_deprecation_message.<locals>.wrappedr )r? r@ r3 r> r4 �_deprecation_message. s rA c C s@ t �di ��d�rt d d S t�di ��d�r td d S dS )z� Returns the proxy type retrieved either from the pillar of from the proxy minion's config. Returns ``<undefined>`` otherwise. CLI Example: .. code-block:: bash salt '*' vsphere.get_proxy_type �proxy� proxytypez <undefined>)Z __pillar__�getZ__opts__r3 r3 r3 r4 �get_proxy_typeC s rE c C s� t � } | dkr td � }n0| dkrtd � }n&| dkr!td � }n | dkr+td � }n| d kr5td � }ntd | � d ���d|v rF|�d�n|�d �|�d�|�d�|�d�|�d�|�d�|�d�|�d�g}d|v rt|�|�d�� t|�S )zG Returns the connection details of the following proxies: esxi r, �esxi.get_detailsr- �esxcluster.get_detailsr. �esxdatacenter.get_detailsr/ �vcenter.get_detailsr0 zesxvm.get_details�'z' proxy is not supported�host�username�password�protocol�port� mechanism� principal�domain� verify_ssl)rE �__salt__r rD �append�tuple)rC �detailsZ proxy_detailsr3 r3 r4 � _get_proxy_connection_detailsV s0 � rX c s � fdd�}|S )z� Decorator to specify which proxy types are supported by a function proxy_types: Arbitrary list of strings with the supported types of proxies c s t � �� �fdd��}|S )Nc s> t � }|�vrtd�|� j���� | i tjjjdi |����S )Nz*'{}' proxy is not supported by function {}r3 )rE r �format�__name__r7 r8 r: r; )r: r< � proxy_type)�fn� proxy_typesr3 r4 �__supports_proxies_ s �� zJ_supports_proxies.<locals>._supports_proxies_.<locals>.__supports_proxies_r )r\ r^ �r] )r\ r4 �_supports_proxies_~ s z-_supports_proxies.<locals>._supports_proxies_r3 )r] r` r3 r_ r4 �_supports_proxiesv s ra c sL �j �tjj���\� }���dur�ng �t��� ����fdd��}|S )a� 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. Nc s$ d� vr �s t d�����t� }d }d� v rP� �d�}|t� �t�� krOt| �|kr?| | s>tjjj|� }t | �} || |< n!|� d�sOtjjj|� }||d< n|� d�s`tjjj|� }||d< z�| i tjj j di |����}|rytjj� |� |W S ty� } z |r�tjj� |� � d }~ww )N�service_instancezQFunction {} must have either a 'service_instance', or a '**kwargs' type parameterr3 )r rY rX �index�lenr7 r8 �vmware�get_service_instance�listrD r: r; � disconnect� Exception)r: r< �connection_detailsZlocal_service_instance�idxr= �e�� arg_namesZdefault_valuesr\ Zfn_nameZ kwargs_namer3 r4 �!_gets_service_instance_via_proxy_� sP � �� �� � ��zK_gets_service_instance_via_proxy.<locals>._gets_service_instance_via_proxy_)rZ r7 r8 r: Zget_function_argspecr )r\ Z args_namero r3 rm r4 � _gets_service_instance_via_proxy� s �?rp r, r- r. r/ r0 c C s t � }tjjj|� S )a4 Returns a service instance to the proxied endpoint (vCenter/ESXi host). service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. Note: Should be used by state functions not invoked directly. CLI Example: See note above )rX r7 r8 re rf )rb rj r3 r3 r4 � get_service_instance_via_proxy� s �rq c C s t jj�| � dS )z� Disconnects from a vCenter or ESXi host Note: Should be used by state functions, not invoked directly. service_instance Service instance (vim.ServiceInstance) CLI Example: See note above. T)r7 r8 re rh �rb r3 r3 r4 rh s rh c C s� i }|r=t |t�s td��|D ]+} tjjj|||| ||| |d�} | d dkr3|�| d| �d�ii� q|�| | i� q|S tjjj|||| |||d�} | d dkr_|�|d| �d�ii� |S |�|| i� |S )a� Run an ESXCLI command directly on the host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. cmd_str The ESXCLI command to run. Note: This should not include the ``-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. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. CLI Example: .. code-block:: bash # 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]' � 'esxi_hosts' must be a list.�rN rO � esxi_host� credstore�retcoder �Error�stdout�rN rO rv � � isinstancerg r r7 r8 re r+ �updaterD ) Zcmd_strrK rL rM rN rO � esxi_hostsrv r= ru �responser3 r3 r4 � esxcli_cmd sB 9 � �� �r� c C s� d}i }|rCt |t�std��|D ]/} tjjj| |||||| |d�} | d dkr5|�| d| �d�ii� q|�| dt | �ii� q|S tjjj| ||||||d �} | d dkre|�| d| �d�ii� |S t | �} |�| d| ii� |S ) ah Retrieve information on ESXi or vCenter network dump collection and format it into a dictionary. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: 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: .. code-block:: bash # 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]' zsystem coredump network getrs rt rw r rx ry zCoredump Configrz ) r| rg r r7 r8 re r+ r} rD �_format_coredump_stdout) rK rL rM rN rO r~ rv �cmdr= ru r ry r3 r3 r4 �get_coredump_network_configy sJ 1 � ��� �r� c C s� |rd}nd}d|� �} i } |rKt |t�std��|D ]-} tjjj| ||| ||| |d�} | d dkr?| �| d| �d�ii� q| �| d |ii� q| S tjjj| ||| |||d �} | d dkrm| �| d| �d�ii� | S | �| d |ii� | S ) a} 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. enabled Python True or False to enable or disable coredumps. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. CLI Example: .. code-block:: bash # 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]' � r z system coredump network set -e rs rt rw rx ry zCoredump Enabledrz r{ ) rK rL rM �enabledrN rO r~ rv Z enable_itr� r= ru r r3 r3 r4 �coredump_network_enable� sJ 7 � �� �r� �vmk0�d c C s� d� |||�} i } |r@t|t�std��|D ]'} tjjj| ||| ||| | d�} | d dkr2d| d< nd| d< | �| | i� q| S tjjj| ||| ||| d �} | d dkrYd| d< nd| d< | �| | i� | S ) a� 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. dump_ip IP address of host that will accept the dump. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. host_vnic Host VNic port through which to communicate. Defaults to ``vmk0``. dump_port TCP port to use for the dump, defaults to ``6500``. credstore Optionally set to path to the credential store file. :return: 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: .. code-block:: bash # 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]' z-system coredump network set -v {} -i {} -o {}rs rt rw r F�successTrz � rY r| rg r r7 r8 re r+ r} )rK rL rM Zdump_iprN rO � host_vnicZ dump_portr~ rv r� r= ru r r3 r3 r4 �set_coredump_network_config< sJ C� � �� r� c C s� d}i }|rBt |t�std��|D ].} tjjj| |||||| |d�} | d dkr6|�| | d ddd �i� q|�| t| �i� q|S tjjj| ||||||d �} | d dkre|�| | d ddd �i� |S |�| t| �i� |S ) a[ Show status of all firewall rule sets. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: 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: .. code-block:: bash # 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]' z network firewall ruleset listrs rt rw r ry FN)rx r� �rulesetsrz ) r| rg r r7 r8 re r+ r} �_format_firewall_stdout� rK rL rM rN rO r~ rv r� r= ru r r3 r3 r4 �get_firewall_status� s` 0 � ��� �� ��� �r� c C s� d� ||�} i } |r0t|t�std��|D ]} tjjj| ||| ||| |d�} | �| | i� q| S tjjj| ||| |||d�} | �| | i� | S )a- Enable or disable an ESXi firewall rule set. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. ruleset_enable True to enable the ruleset, false to disable. ruleset_name Name of ruleset to target. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: A standard cmd.run_all dictionary, per host. CLI Example: .. code-block:: bash # 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]' z9network firewall ruleset set --enabled {} --ruleset-id={}rs rt rz r� ) rK rL rM �ruleset_enable� ruleset_namerN rO r~ rv r� r= ru r r3 r3 r4 �enable_firewall_ruleset s> ;� � �� r� c C s� d}i }|r,t |t�std��|D ]} tjjj| |||||| |d�} |�| | i� q|S tjjj| ||||||d�} |�| | i� |S )a Reload the syslog service so it will pick up any changes. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: 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: .. code-block:: bash # 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]' zsystem syslog reloadrs rt rz )r| rg r r7 r8 re r+ r} r� r3 r3 r4 �syslog_service_reloadx s: . � �� r� c C s� i } |ry|dkry| rJt | t�std��| D ]3} t| ||dd||| g| d� �| �} | d dkr=| �| d| d d d �ii� q| �| dd diii� qn/t| ||dd||| d ��| �} | d dkrn| �| d| d d d �ii� n | �| dd diii� | r�t | t�s�td��| D ]%} t| |||||||| | d� } | �| �du r�| �| i i� | | �| � q�| S t| |||||||| d� } | �| �du r�| �| i i� | | �| � | S )a6 Set the specified syslog configuration parameter. By default, this function will reset the syslog service after the configuration is set. host ESXi or vCenter host to connect to. username User to connect as, usually root. password Password to connect with. syslog_config 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``. config_value 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) protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. firewall Enable the firewall rule set for syslog. Defaults to ``True``. reset_service After a successful parameter set, reset the service. Defaults to ``True``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: 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: .. code-block:: bash # 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]' �loghostrs TZsyslog)r� r� rN rO r~ rv rw r Zenable_firewallry F)�messager� r� )r� r� rN rO rv )rN rO � reset_serviceru rv N)rN rO r� rv )r| rg r r� rD r} �_set_syslog_config_helper)rK rL rM � syslog_config� config_valuerN rO Zfirewallr� r~ rv r= ru r r3 r3 r4 �set_syslog_config� s� Q � � ���� �� � ���� ��� r� c C s� d}i }|r.t |t�std��|D ]} tjjj| |||||| |d�} |�| t| �i� q|S tjjj| ||||||d�} |�| t| �i� |S )a� Retrieve the syslog configuration. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: Dictionary with keys and values corresponding to the syslog configuration, per host. CLI Example: .. code-block:: bash # 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]' zsystem syslog config getrs rt rz ) r| rg r r7 r8 re r+ r} �_format_syslog_configr� r3 r3 r4 �get_syslog_config� s: . � �� r� c C s� |st d��g d�}d} d|v rdd� |�d�D �} n |dkr"|} n|g} i } |rNt|t�s2t d��|D ]} t| ||| | |||| |d � } | �| | i� q4| S t| ||| | ||||d � } | �| | i� | S ) aM 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. syslog_config List of parameters to reset, provided as a comma-delimited string, or 'all' to reset all syslog configuration parameters. Required. esxi_hosts If ``host`` is a vCenter host, then use esxi_hosts to execute this function on a list of one or more ESXi machines. credstore Optionally set to path to the credential store file. :return: 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. .. note:: ``syslog_config`` can be passed as a quoted, comma-separated string. See CLI Example for details. CLI Example: .. code-block:: bash # 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]' zFThe 'reset_syslog_config' function requires a 'syslog_config' setting.�Zlogdirr� zdefault-rotatez default-sizezdefault-timeoutz logdir-uniquez!system syslog config set --reset=�,c S s g | ]}|� � �qS r3 )�strip)�.0Z ind_resetr3 r3 r4 � <listcomp>( � z'reset_syslog_config.<locals>.<listcomp>�allrs rt rz )r �splitr| rg �_reset_syslog_config_paramsr} )rK rL rM rN rO r� r~ rv � valid_resetsr� �resetsr= ru Z response_dictr3 r3 r4 �reset_syslog_config� sV C� � �� r� rv c C s� |du rd}|du r d}|du rd}|� d| � d|� d�}i } d} z?|r4t jjj|ddd||||d �} n|rFt jjj|ddd|||d |d � } | �d �d krTd| d < W | S d | d < | d | d< W | S ty{ } zd | d < | | d< W Y d} ~ | S d} ~ ww )a� 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. :param host: The location of the ESXi Host :param username: Username to connect as :param password: Password for the ESXi web endpoint :param ssh_key: Public SSH key, will be added to authorized_keys on ESXi :param ssh_key_file: File containing the SSH key. Use 'ssh_key' or ssh_key_file, but not both. :param protocol: defaults to https, can be http if ssl is disabled on ESXi :param port: defaults to 443 for https :param certificate_verify: If true require that the SSL connection present a valid certificate. Default: True :return: 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: .. code-block:: bash salt '*' vsphere.upload_ssh_key my.esxi.host root bad-password ssh_key_file='/etc/salt/my_keys/my_key.pub' N�https� T�://�:� /host/ssh_root_authorized_keys�PUT)�status�text�methodrL rM �datarS F)r� r� r� rL rM Z data_fileZ data_renderrS r� �� �errorrx �r7 r8 �http�queryrD ri ) rK rL rM Zssh_keyZ ssh_key_filerN rO �certificate_verify�urlr= �result�msgr3 r3 r4 �upload_ssh_keyS sZ '� � ����r� c C s� |du rd}|du r d}|du rd}|� d| � d|� d�}i }z/t jjj|ddd|||d �}|�d �d krBd|d < |d |d < W |S d|d < |d |d< W |S tyi } zd|d < | |d< W Y d} ~ |S d} ~ ww )a� Retrieve the authorized_keys entry for root. This function only works for ESXi, not vCenter. :param host: The location of the ESXi Host :param username: Username to connect as :param password: Password for the ESXi web endpoint :param protocol: defaults to https, can be http if ssl is disabled on ESXi :param port: defaults to 443 for https :param certificate_verify: If true require that the SSL connection present a valid certificate. Default: True :return: True if upload is successful CLI Example: .. code-block:: bash salt '*' vsphere.get_ssh_key my.esxi.host root bad-password certificate_verify=True Nr� r� Tr� r� r� ZGET)r� r� r� rL rM rS r� r� r� �keyFr� rx r� ) rK rL rM rN rO r� r� r= r� r� r3 r3 r4 � get_ssh_key� s> � ����r� c C sd t jjj| |||||d�}t|| |�}i }|D ]} t|| | d�} t| �} | �� } |�| | i� q|S )a� Get the date/time information for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' �rK rL rM rN rO rS �� host_name) r7 r8 re rf � _check_hosts� _get_host_ref�_get_date_time_mgrZ QueryDateTimer} ) rK rL rM rN rO � host_namesrS rb r= r� �host_ref�date_time_managerZ date_timer3 r3 r4 �get_host_datetime� s 1� r� c C sb t jjj| |||||d�}t|| |�}i }|D ]} t|| | d�} | jjjj j } |� | | i� q|S )a� Get the NTP configuration information for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� ) r7 r8 re rf r� r� � configManager�dateTimeSystemZ dateTimeInfo� ntpConfig�serverr} ) rK rL rM rN rO r� rS rb r= r� r� � ntp_configr3 r3 r4 �get_ntp_config% s 1� r� c C � t jjj| |||||d�}g d�} t|| |�}i } |D ]p} || vr1| �| d|� d�ii� | S t|| | d�} | jjj j } |dksF|dkrId}n|}| D ]"}|j |kr`| �| ||j ii� nd � || �}| �| d|ii� qM| �| �d u r�d | � d �}t�|� | �| d|ii� q| S ) a" Get the service name's policy for a given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to retrieve the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� �ZDCUIZTSM�SSH�sshZlbtdZlsassdZlwiodZ netlogondZntpdzsfcbd-watchdogZsnmpdZvprobedZvpxaZxorgrx � is not a valid service name.r� r� r� �TSM-SSH�*Could not find service '{}' for host '{}'.Nz-'vsphere.get_service_policy' failed for host �.)r7 r8 re rf r� r} r� r� � serviceSystem� serviceInfo�servicer� �policyrY rD �log�debug�rK rL rM � service_namerN rO r� rS rb �valid_servicesr= r� r� �services�temp_service_namer� r� r3 r3 r4 �get_service_policyh �H H� � � �r� c C r� ) a) Get the service name's running state for a given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to retrieve the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� rx r� r� r� r� r� r� Nz.'vsphere.get_service_running' failed for host r� )r7 r8 re rf r� r} r� r� r� r� r� r� ZrunningrY rD r� r� r� r3 r3 r4 �get_service_running� r� r� c C s| t jjj| |||||d�}t|| |�}i }|D ]$} t|| | d�} | jjjj } | r2|� | ddii� q|� | ddii� q|S )a� 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� �VMotion EnabledTF) r7 r8 re rf r� r� r� � vmotionSystemZ netConfigZ selectedVnicr} ) rK rL rM rN rO r� rS rb r= r� r� Z vmotion_vnicr3 r3 r4 �get_vmotion_enabled~ s" 8� r� c C s� t jjj| |||||d�}t|| |�}i }|D ]0} t|| | d�} | jj} | du r=d| � d�} t� | � |� | d| ii� q|� | d| j ii� q|S )a 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� Nz.VSAN System Config Manager is unset for host 'z'.rx � VSAN Enabled) r7 r8 re rf r� r� �configZvsanHostConfigr� r� r} r� ) rK rL rM rN rO r� rS rb r= r� r� � vsan_configr� r3 r3 r4 �get_vsan_enabled� s& 9� r� c C s� t jjj| |||||d�}t|| |�}t|| |�}i } |�� D ]A\} } | �d�} | r4| �| d| ii� q | �d�} | rWt | t �rWg }| D ]}|� |j � qD| �| d|ii� q | �| d| ii� q | S )a� Returns a list of VSAN-eligible disks for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� rx �Eligible) r7 r8 re rf r� �_get_vsan_eligible_disks�itemsrD r} r| rg rU � canonicalName)rK rL rM rN rO r� rS rb r r= r� �valuer� �disks� disk_names�diskr3 r3 r4 �get_vsan_eligible_disks s0 7� r� c C s0 z t jj�| �r W dS W dS ty Y dS w )z� Checks if a connection is to a vCenter CLI Example: .. code-block:: bash salt '*' vsphere.test_vcenter_connection TF)r7 r8 re �is_connection_to_a_vcenterr rr r3 r3 r4 �test_vcenter_connectionw s � ��r� c C sZ t jjj| |||||d�}t jj�|�jj}d|v r+|d dkr+t�|t jj� |��}|S )a� Return system information about a VMware environment. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.system_info 1.2.3.4 root bad-password r� ZapiTypeZ HostAgent) r7 r8 re rf � get_inventoryZabout�__dict__� dictupdater} Zget_hardware_grains)rK rL rM rN rO rS rb r= r3 r3 r4 � system_info� s (� �r� c C �( t jjj| |||||d�}t jj�|�S )a� Returns a list of datacenters for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_datacenters 1.2.3.4 root bad-password r� )r7 r8 re rf �list_datacenters�rK rL rM rN rO rS rb r3 r3 r4 r� � s $�r� c C r� )a� Returns a list of clusters for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_clusters 1.2.3.4 root bad-password r� )r7 r8 re rf � list_clustersr� r3 r3 r4 r� � � "�r� c C r� )a� Returns a list of datastore clusters for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_datastore_clusters 1.2.3.4 root bad-password r� )r7 r8 re rf �list_datastore_clustersr� r3 r3 r4 r " � #�r c C r� )a� Returns a list of datastores for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_datastores 1.2.3.4 root bad-password r� )r7 r8 re rf �list_datastoresr� r3 r3 r4 r P r r c C r� )a� Returns a list of hosts for the specified VMware environment. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_hosts 1.2.3.4 root bad-password r� )r7 r8 re rf � list_hostsr� r3 r3 r4 r ~ � !�r c C r� )a� Returns a list of resource pools for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_resourcepools 1.2.3.4 root bad-password r� )r7 r8 re rf �list_resourcepoolsr� r3 r3 r4 r � r r c C r� )a� Returns a list of networks for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_networks 1.2.3.4 root bad-password r� )r7 r8 re rf � list_networksr� r3 r3 r4 r � r r c C r� )a� Returns a list of VMs for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_vms 1.2.3.4 root bad-password r� )r7 r8 re rf �list_vmsr� r3 r3 r4 r r r c C r� )a� Returns a list of folders for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_folders 1.2.3.4 root bad-password r� )r7 r8 re rf � list_foldersr� r3 r3 r4 r 0 r r c C r� )a� Returns a list of distributed virtual switches for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.list_dvs 1.2.3.4 root bad-password r� )r7 r8 re rf �list_dvsr� r3 r3 r4 r \ r r c C r� )a� Returns a list of vApps for the specified host. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # List vapps from all minions salt '*' vsphere.list_vapps 1.2.3.4 root bad-password r� )r7 r8 re rf � list_vappsr� r3 r3 r4 r � r r c C �v t jjj| |||||d�}t|| |�}i }g } |D ] } t|| | d�} t| �} | D ]} | �| j� q(|� | | i� q|S )av Returns a list of SSDs for the given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� ) r7 r8 re rf r� r� �_get_host_ssdsrU r� r} �rK rL rM rN rO r� rS rb r= �namesr� r� r� r� r3 r3 r4 � list_ssds� s$ 1� r c C r )a� 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� ) r7 r8 re rf r� r� �_get_host_non_ssdsrU r� r} r r3 r3 r4 � list_non_ssds� s$ 8� r c C s� t jjj| |||||d�}t|t�std��tj|d�} tj | d�} t || |�}i } |D ]M} t || | d�} t | �}t �d|| � z|j| d� W n' tjjyo } zd|� �}t �|� | �| d |ii� W Y d }~q,d }~ww | �| d | ii� q,| S ) aO Set NTP configuration for a given host of list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. ntp_servers A list of servers that should be added to and configured for the specified host's NTP configuration. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� z 'ntp_servers' must be a list.)r� )r� r� z+Configuring NTP Servers '%s' for host '%s'.�r� z&vsphere.ntp_configure_servers failed: rx Nz NTP Servers)r7 r8 re rf r| rg r r Z HostNtpConfigZHostDateTimeConfigr� r� r� r� r� ZUpdateDateTimeConfig�fault�HostConfigFaultr} )rK rL rM Z ntp_serversrN rO r� rS rb r� Z date_configr= r� r� r� �errr� r3 r3 r4 �set_ntp_configH s: <� ��r c C �\ t jjj| |||||d�}t|| |�}g d�} i } |dks!|dkr$d} n|} |D ]�} || vr>| �| d|� d�ii� | S t|| | d�} t| �}t� d || � z|j | d � W nI t j j y� } zd �| |�}t� |� | �| d|ii� W Y d }~q(d }~w t j jy� } zt� |� | �| d|ii� W Y d }~q(d }~ww | �| d dii� q(| S )a� Start the named service for the given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to set the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� r� r� r� rx r� r� z Starting the '%s' service on %s.��idz.'vsphere.service_start' failed for host {}: {}NzService StartedT)r7 r8 re rf r� r} r� �_get_service_managerr� r� Z StartServicer r r rY �RestrictedVersion�rK rL rM r� rN rO r� rS rb r� r= r� r� r� �service_managerr r� r3 r3 r4 � service_start� �R H� �� � ��r c C s` t jjj| |||||d�}t|| |�}g d�} i } |dks!|dkr$d} n|} |D ]�} || vr>| �| d|� d�ii� | S t|| | d�} t| �}t� d || � z|j | d � W nK t j j y� } z d | � d |� �}t� |� | �| d|ii� W Y d }~q(d }~w t j jy� } zt� |� | �| d|ii� W Y d }~q(d }~ww | �| ddii� q(| S )a� Stop the named service for the given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to set the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� r� r� r� rx r� r� z Stopping the '%s' service on %s.r z''vsphere.service_stop' failed for host �: NzService StoppedT)r7 r8 re rf r� r} r� r r� r� Z StopServicer r r r r r3 r3 r4 � service_stop3 sN H� � � ��r" c C r )a� Restart the named service for the given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to set the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� r� r� r� rx r� r� z"Restarting the '%s' service on %s.r z0'vsphere.service_restart' failed for host {}: {}NzService RestartedT)r7 r8 re rf r� r} r� r r� r� ZRestartServicer r r rY r r r3 r3 r4 �service_restart� r r# c C s� t jjj| |||||d�} t| | |�}g d�} i } |D ]�} || vr1| �| d|� d�ii� | S t| | | d�} t| �}| jj j j }|D ]�}d}|j |krQ|j }n|dksY|dkr`|j d kr`d }|r�z |j ||d � W nF tjjy� d |� d �}t�|� | �| d|ii� Y qD tjjy� } zd �| |�}t�|� | �| d|ii� W Y d}~qDd}~ww | �| di� | �| �du r�d�|| �}t�|� | �| d|ii� qDq| S )a� Set the service name's policy for a given host or list of hosts. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. service_name The name of the service for which to set the policy. Supported service names are: - DCUI - TSM - SSH - lbtd - lsassd - lwiod - netlogond - ntpd - sfcbd-watchdog - snmpd - vprobed - vpxa - xorg service_policy The policy to set for the service. For example, 'automatic'. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� rx r� r� Nr� r� r� )r r� zThe service name 'z' was not found.z3'vsphere.set_service_policy' failed for host {}: {}Tr� )r7 r8 re rf r� r} r� r r� r� r� r� r� ZUpdateServicePolicyr r r& r� r� r rY rD )rK rL rM r� Zservice_policyrN rO r� rS rb r� r= r� r� r r� r� Z service_keyr� r r3 r3 r4 �set_service_policyG sp L� � � � ��� ��(r$ c C s� t jjj| |||||d�}t|| |�}i }|D ]I} t|| | d�} t| �} z | �tj� � � W n( t j j yV } zd� | | �} t�| � |�| d| ii� W Y d} ~ qd} ~ ww |�| ddii� q|S )a� 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. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� z1'vsphere.update_date_time' failed for host {}: {}rx NzDatetime UpdatedT)r7 r8 re rf r� r� r� ZUpdateDateTime�datetime�utcnowr r r rY r� r� r} )rK rL rM rN rO r� rS rb r= r� r� r� r r� r3 r3 r4 �update_host_datetime� s4 2� � ��r' c C s� t jjj| |||||d�}t jj�|�j}tjj� � } || _ || _ z|� | � W dS t jjy< } zt| j��d} ~ w tjjyK td�| ��� tjjyV Y dS w )a� Update the password for a given host. .. note:: Currently only works with connections to ESXi hosts. Does not work with vCenter servers. host The location of the ESXi host. username The username used to login to the ESXi host, such as ``root``. password The password used to login to the ESXi host. new_password The new password that will be updated for the provided username on the ESXi host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt '*' vsphere.update_host_password my.esxi.host root original-bad-password new-bad-password r� NzF'vsphere.update_host_password' failed for host {}: User was not found.T)r7 r8 re rf r� ZaccountManagerr rK ZLocalAccountManagerZAccountSpecificationr rM Z UpdateUserr r � SystemErrorr r� Z UserNotFoundrY r$ ) rK rL rM Z new_passwordrN rO rS rb Zaccount_managerZ user_accountr r3 r3 r4 �update_host_password6 s6 )� � ���r) c C s� t jjj| |||||d�}t|| |�}i }|D ]E} t|| | d�} | jj} z| �� W n( t j j yR } zd| � �} t � | � |�| | dd�i� W Y d} ~ qd} ~ ww |�| ddii� q|S ) ay Disable vMotion for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� � vsphere.vmotion_disable failed: F)rx �VMotion DisabledNr+ T)r7 r8 re rf r� r� r� r� Z DeselectVnicr r r r� r� r} )rK rL rM rN rO r� rS rb r= r� r� �vmotion_systemr r� r3 r3 r4 �vmotion_disable� s0 1� ��r- c C s� t jjj| |||||d�}t|| |�}i } |D ]F} t|| | d�} | jj} z| �|� W n( t j j yS } zd| � �}t � |� | �| |dd�i� W Y d} ~ qd} ~ ww | �| ddii� q| S ) a Enable vMotion for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. device The device that uniquely identifies the VirtualNic that will be used for VMotion for each host. Defaults to ``vmk0``. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� r* F)rx r� Nr� T)r7 r8 re rf r� r� r� r� Z SelectVnicr r r r� r� r} )rK rL rM rN rO r� �devicerS rb r= r� r� r, r r� r3 r3 r4 �vmotion_enable� s0 <� ��r/ c C s� t jjj| |||||d�}t|| |�}t|| |�}i } |�� D ]�\} } t|| | d�} | jj } | du rFd� | �}t � |� | � | d|ii� q | �d�}| �d�}|r�t|t�r�z| �|�}t jjj|| ddd � W nI tjjy� } zt � |j� | � | d|jii� W Y d}~q d}~w ty� } zd � | |�}t � |� | � | d|ii� W Y d}~q d}~ww t � d | � g }|D ]}|�|j� q�| � | d |ii� q |r�t|t�r�| � | d |ii� q |r�| � | d|ii� q | � | d d ii� q | S )a� Add any VSAN-eligible disks to the VSAN System for the given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� r� N�yVSAN System Config Manager is unset for host '{}'. VSAN configuration cannot be changed without a configured VSAN System.rx r� zAdding disks to VSAN� �Z sleep_secondsz/'vsphere.vsan_add_disks' failed for host {}: {}z:Successfully added disks to the VSAN system for host '%s'.z Disks Addedz-No new VSAN-eligible disks were found to add.)r7 r8 re rf r� r� r� r� r� � vsanSystemrY r� r� r} rD r| rg ZAddDisks� wait_for_taskr r ZInsufficientDisksr� ri rU r� �str)rK rL rM rN rO r� rS rb r r= r� r� r� � vsan_systemr� �eligibler� �taskr r� r� r3 r3 r4 �vsan_add_disks% s| 2� � � �� ������ r9 c C sZ t jjj| |||||d�}tjj�� }d|_t || |�}i } |D ]�} t || | d�} | j j } | du rEd� | �} t�| � | �| d| ii� q z| �|�}t jjj|| ddd � W nI tjjy{ } zt�|j� | �| d|jii� W Y d}~q d}~w ty� } zd � | |�} t�| � | �| d| ii� W Y d}~q d}~ww | �| d d ii� q | S ) aj Disable VSAN for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� Fr� Nr0 rx zDisabling VSANr1 r2 z-'vsphere.vsan_disable' failed for host {}: {}z VSAN DisabledT)r7 r8 re rf r �vsanrK � ConfigInfor� r� r� r� r3 rY r� r� r} �UpdateVsan_Taskr4 r r r( r� ri �rK rL rM rN rO r� rS rb r� r= r� r� r6 r� r8 r r3 r3 r4 � vsan_disable� sT 1� � � �� ��r> c C s^ t jjj| |||||d�}tjj�� }d|_t || |�}i } |D ]�} t || | d�} | j j } | du rEd� | �} t�| � | �| d| ii� q z| �|�}t jjj|| ddd � W nK tjjy{ } zt�|j� | �| d|jii� W Y d}~q d}~w tjjy� } zd � | |�} t�| � | �| d| ii� W Y d}~q d}~ww | �| d dii� q | S ) ae Enable VSAN for a given host or list of host_names. host The location of the host. username The username used to login to the host, such as ``root``. password The password used to login to the host. protocol Optionally set to alternate protocol if the host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the host is not using the default port. Default port is ``443``. host_names 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. verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash # 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]' r� Tr� Nr0 rx z Enabling VSANr1 r2 z,'vsphere.vsan_enable' failed for host {}: {}r� )r7 r8 re rf r r: rK r; r� r� r� r� r3 rY r� r� r} r< r4 r r r( r� Z VsanFaultr= r3 r3 r4 � vsan_enable sT 1� � � �� ��r? c C sX t �d| � | |jj|jj|j|j|j|j|jd�}t |j t j �r*|� d|j ji� |S )z� Returns the dict representation of the DVS config dvs_name The name of the DVS dvs_config The DVS config z(Building the dict of the DVS '%s' config)�name� contact_email� contact_name� description�lacp_api_version� network_resource_control_version�#network_resource_management_enabled�max_mtu� uplink_names)r� �trace�contactr@ rC �lacpApiVersion� networkResourceControlVersionZ networkResourceManagementEnabled�maxMtur| �uplinkPortPolicyr � DVSNameArrayUplinkPortPolicyr} �uplinkPortName)�dvs_name� dvs_configZ conf_dictr3 r3 r4 �_get_dvs_config_dicto s � rS c C s t �d| � |j|jd�S )z� Returns the dict representation of the DVS link discovery protocol dvs_name The name of the DVS dvs_link_disc_protocl The DVS link discovery protocol z9Building the dict of the DVS '%s' link discovery protocol�� operationrN )r� rI rU rN )rQ Zdvs_link_disc_protocolr3 r3 r4 � _get_dvs_link_discovery_protocol� s �rV c C � t �d| � |j|j|jd�S )z� Returns the dict representation of the DVS product_info dvs_name The name of the DVS dvs_product_info The DVS product info z.Building the dict of the DVS '%s' product info)r@ �vendor�version)r� rI r@ rX rY )rQ Zdvs_product_infor3 r3 r4 �_get_dvs_product_info� � �rZ c C rW )z� Returns the dict representation of the DVS product_info dvs_name The name of the DVS dvs_capability The DVS capability z,Building the dict of the DVS '%s' capability)�operation_supported� portgroup_operation_supported�port_operation_supported)r� rI �dvsOperationSupported� dvPortGroupOperationSupported�dvPortOperationSupported)rQ Zdvs_capabilityr3 r3 r4 �_get_dvs_capability� r[ rb c C sb t �d| � g }|D ]$}|j|jj|jjd�}|jjr)|�|jjj|jjjd�� |� |� q |S )z� Returns a list of dict representations of the DVS infrastructure traffic resource dvs_name The name of the DVS dvs_infra_traffic_ress The DVS infrastructure traffic resources zCBuilding the dicts of the DVS '%s' infrastructure traffic resources)r� �limit� reservation)� num_shares� share_level) r� rI r� �allocationInforc rd �sharesr} �levelrU )rQ Zdvs_infra_traffic_ressZ res_dicts�res�res_dictr3 r3 r4 �)_get_dvs_infrastructure_traffic_resources� s" ���� rl c C s0 g }t � }|dkrtd � d } t|�}n|dkr(td � d } tjj�|| �}tjj�||| �D ]c}i }tjj�|g d��}t |d |d �}|� d t |d |d j �i� |d j rl|� d t|d |d j �i� |� d t|d |d �i� t|d d �r�|� d t|d |d j�i� |�|� q2|S )a� Returns a list of distributed virtual switches (DVSs). The list can be filtered by the datacenter or DVS names. datacenter The datacenter to look for DVSs in. Default value is None. dvs_names List of DVS names to look for. If None, all DVSs are returned. Default value is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_dvss salt '*' vsphere.list_dvss dvs_names=[dvs1,dvs2] r. rH � datacenterr- rG )r@ r� � capabilityZnetworkResourcePoolr@ r� � product_info�link_discovery_protocolrn �#infrastructureTrafficResourceConfig�%infrastructure_traffic_resource_pools)rE rT �_get_proxy_targetr7 r8 re �get_datacenter�get_dvss� get_properties_of_managed_objectrS r} rZ � productInfo�linkDiscoveryProtocolConfigrV rb �hasattrrl rq rU ) rm � dvs_namesrb �ret_listr[ �dc_ref�dvs�dvs_dict�propsr3 r3 r4 � list_dvss� sP ���� ������� r� c C s� |� d�r |d | _|� d�s|� d�r*| js t�� | _|� d�| j_|� d�| j_|� d�r5|� d�| _|� d�r@|� d�| _|� d�rK|� d�| _|� d�rV|� d�| _|� d�rr| j ret | j tj �sjt� � | _ |d | j _ d S d S ) zi Applies the values of the config dict dictionary to a config spec (vim.VMwareDVSConfigSpec) r@ rA rB rC rG rD rE rH N) rD r@ rJ r ZDVSContactInforC rM rK rL rN r| rO rP )� config_specZ config_dictr3 r3 r4 �_apply_dvs_config, s0 � � �r� c C s |d | _ |d | _dS )z� Applies the values of the disc_prot_dict dictionary to a link discovery protocol config object (vim.LinkDiscoveryProtocolConfig) rU rN NrT )Zdisc_prot_configZdisc_prot_dictr3 r3 r4 �"_apply_dvs_link_discovery_protocolK s r� c C sD |� d�r |d | _|� d�r|d | _|� d�r |d | _dS dS )z� Applies the values of the product_info_dict dictionary to a product info spec (vim.DistributedVirtualSwitchProductSpec) r@ rX rY N)rD r@ rX rY )Zproduct_info_specZproduct_info_dictr3 r3 r4 �_apply_dvs_product_infoT s �r� c C s> d|v r |d | _ d|v r|d | _d|v r |d | _dS dS )zu Applies the values of the capability_dict dictionary to a DVS capability object (vim.vim.DVSCapability) r\ r^ r] N)r_ ra r` )Zcapability_specZcapability_dictr3 r3 r4 �_apply_dvs_capabilitya s � ��r� c s� |D ]j� � fdd�| D �}|r|d }nt �� }� d |_t �� |_| �|� � �d�r2� d |j_� �d�r=� d |j_� �d�sG� �d�rQ|jj sQt � � |j_ � �d�r`t � � d �|jj _ � �d�rl� d |jj _ qd S ) z� Applies the values of the resource dictionaries to infra traffic resources, creating the infra traffic resource if required (vim.DistributedVirtualSwitchProductSpec) c � g | ] }|j � d kr|�qS �r� r� �r� �r�rk r3 r4 r� { s z?_apply_dvs_infrastructure_traffic_resources.<locals>.<listcomp>r r� rc rd re rf N) r Z$DvsHostInfrastructureTrafficResourcer� Z.DvsHostInfrastructureTrafficResourceAllocationrg rU rD rc rd rh � SharesInfo� SharesLevelri )Zinfra_traffic_resources�resource_dictsZfiltered_traffic_resourcesZ traffic_resr3 r� r4 �+_apply_dvs_infrastructure_traffic_resourcesr s4 � � � ��r� c s� |D ]U� � fdd�| D �}|r|d }nt �� }� d |_t �� |_| �|� � �d�r2� d |j_� �d�rW� �d�rW|jjsFt � � |j_� d |jj_t � � d �|jj_ qdS ) z� Applies the values of the resource dictionaries to network resource pools, creating the resource pools if required (vim.DVSNetworkResourcePoolConfigSpec) c r� r� r� r� r� r3 r4 r� � s z5_apply_dvs_network_resource_pools.<locals>.<listcomp>r r� rc re rf N) r Z DVSNetworkResourcePoolConfigSpecr� Z$DVSNetworkResourcePoolAllocationInforg rU rD rc rh r� r� ri )Znetwork_resource_poolsr� Zressrj r3 r� r4 �!_apply_dvs_network_resource_pools� s" ��r� c C s� t �d|| � t� }|dkrtd � d }t|�}n|dkr-td � d }tjj�||�}|| d< t � � }t � � |_ t |j | � | �d�rRt �� |_t|j| d � | �d �rdt �� |_t|j| d � | �d �rxt �� |j _t|j j| d � | �d �r�g |j _t|j j| d � t �d |� tjj�|||� d | v r�tjjj||gd�}|s�t d|� d|� d���|d }tjj� || d � dS )a� Creates a distributed virtual switch (DVS). Note: The ``dvs_name`` param will override any name set in ``dvs_dict``. dvs_dict Dict representation of the new DVS (example in salt.states.dvs) dvs_name Name of the DVS to be created. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_dvs dvs dict=$dvs_dict dvs_name=dvs_name z Creating dvs '%s' with dict = %sr. rH rm r- rG r@ ro rn rp rr zdvs_create_spec = %srF �rz �DVS '� ' wasn't found in datacenter 'rJ r T) r� rI rE rT rs r7 r8 re rt r Z DVSCreateSpec�VMwareDVSConfigSpecZ configSpecr� rD Z#DistributedVirtualSwitchProductSpecrw r� Z DVSCapabilityrn r� �LinkDiscoveryProtocolConfigrx r� rq r� � create_dvsru r �+set_dvs_network_resource_management_enabled) r~ rQ rb r[ rm r| Zdvs_create_spec�dvs_refs�dvs_refr3 r3 r4 r� � sX �� � ��r� c C s� t �d|| � dD ] }|| v r| |= q t� }|dkr&td � d }t|�}n|dkr9td � d }tjj�||�}tjjj ||gd�}|sPt d |� d |� d ���|d }tjj� |d dg�} t � � } dg} | j�� D ]}|| v rqqjt| d |�r�t| |t| d |�� qjt| | � | �d�r�| js�t �� | _t| j| d � | �d�r�| js�g | _t| j| d � t �d| � tjjj|| d� d| v r�tjj�|| d � dS )aZ Updates a distributed virtual switch (DVS). Note: Updating the product info, capability, uplinks of a DVS is not supported so the corresponding entries in ``dvs_dict`` will be ignored. dvs_dict Dictionary with the values the DVS should be update with (example in salt.states.dvs) dvs Name of the DVS to be updated. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.update_dvs dvs_dict=$dvs_dict dvs=dvs1 z Updating dvs '%s' with dict = %s)ro rn rH r@ r. rH rm r- rG r� r� r� rJ r r� rn rK rp rr zdvs_config = %s)Zdvs_config_specrF T) r� rI rE rT rs r7 r8 re rt ru r rv r r� r� �keysry �setattr�getattrr� rD rx r� r� rq r� � update_dvsr� ) r~ r} rb �propr[ rm r| r� r� Z dvs_propsrR Zskipped_propertiesr3 r3 r4 r� � sd � ��� � � �r� c C s8 t �d| � |j}|s i S |jj|jj|jj|jjd�S )z� Returns the out shaping policy of a distributed virtual portgroup pg_name The name of the portgroup pg_default_port_config The dafault port config of the portgroup z.Retrieving portgroup's '%s' out shaping config)�average_bandwidth� burst_sizer� �peak_bandwidth)r� rI �outShapingPolicy�averageBandwidthr� � burstSizer� � peakBandwidth)�pg_name�pg_default_port_configZout_shaping_policyr3 r3 r4 � _get_dvportgroup_out_shapingO s �r� c C s2 t �d| � |j}|s i S |jj|jj|jjd�S )z� Returns the security policy of a distributed virtual portgroup pg_name The name of the portgroup pg_default_port_config The dafault port config of the portgroup z2Retrieving portgroup's '%s' security policy config)�allow_promiscuous�forged_transmits� mac_changes)r� rI �securityPolicy�allowPromiscuousr� �forgedTransmits� macChanges)r� r� � sec_policyr3 r3 r4 � _get_dvportgroup_security_policye s �r� c C s� t �d| � |j}|s i S |jj|jj|jj|jjd�}|jr?|j}|� d|j j|j j|j j|j j|jj|jj|jjd�i� |jrQ|j}|� d|j|jd�i� |S )z� Returns the teaming of a distributed virtual portgroup pg_name The name of the portgroup pg_default_port_config The dafault port config of the portgroup z*Retrieving portgroup's '%s' teaming config)�notify_switchesr� �reverse_policy� rolling_order�failure_criteria)� check_beacon� check_duplex�check_error_percent� check_speed� full_duplex� percentage�speed� port_order)�active�standby)r� rI �uplinkTeamingPolicy�notifySwitchesr� r� � reversePolicy� rollingOrder�failureCriteriar} � checkBeacon� checkDuplex�checkErrorPercent� checkSpeed� fullDuplexr� r� �uplinkPortOrder�activeUplinkPort�standbyUplinkPort)r� r� Zteaming_policy�ret_dictr� Z uplink_orderr3 r3 r4 �_get_dvportgroup_teamingz sB ���� ���r� c C s� t jj�| g d��}|d |�d�|d |d d�}|d r_|d }|jr5t|jtj�r5|� d|jj i� |� d t |d |d �i� |� d t |d |d �i� |� d t |d |d �i� |S ) zq Returns a dictionary with a distributed virtual portgroup data pg_ref Portgroup reference )r@ �config.description�config.numPorts� config.type�config.defaultPortConfigr@ r� r� r� )r@ rC � num_ports�typer� �vlan_id� out_shaping�security_policy�teaming)r7 r8 re rv rD �vlanr| r �(VmwareDistributedVirtualSwitchVlanIdSpecr} �vlanIdr� r� r� )�pg_refr Zpg_dictZdpgr3 r3 r4 �_get_dvportgroup_dict� sD � �� ��� ��� ���r� c C s� g }t � }|dkrtd � d }t|�}n|dkr(td � d }tjj�||�}| rBtjjj|| gd�}|s>td| � d���|d }|sFd nd } tjjj | rP|n||| d �D ] } |� t | �� qV|S ) a� Returns a list of distributed virtual switch portgroups. The list can be filtered by the portgroup names or by the DVS. dvs Name of the DVS containing the portgroups. Default value is None. portgroup_names List of portgroup names to look for. If None, all portgroups are returned. Default value is None service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_dvportgroups salt '*' vsphere.list_dvportgroups dvs=dvs1 salt '*' vsphere.list_dvportgroups portgroup_names=[pg1] salt '*' vsphere.list_dvportgroups dvs=dvs1 portgroup_names=[pg1] r. rH rm r- rG r� r� �' was not retrievedr TF)� parent_ref�portgroup_names�get_all_portgroups) rE rT rs r7 r8 re rt ru r �get_dvportgroupsrU r� ) r} r� rb r� r[ rm r| r� r� r� r� r3 r3 r4 �list_dvportgroups� s* " �r� c C s� t � }|dkrtd � d }t|�}n|dkr&td � d }tjj�||�}tjjj|| gd�}|s:td| � d���tjj� |d �}t |�S ) a[ Returns the uplink portgroup of a distributed virtual switch. dvs Name of the DVS containing the portgroup. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_uplink_dvportgroup dvs=dvs_name r. rH rm r- rG r� r� r� r ) rE rT rs r7 r8 re rt ru r Zget_uplink_dvportgroupr� )r} rb r[ rm r| r� Z uplink_pg_refr3 r3 r4 �list_uplink_dvportgroup s r� c C s� t �d| � |�d�rt�� |_|d |j_|�d�r&t�� |_|d |j_d|v r5t�� |_ |d |j _|�d�rGt�� |_ |d |j _dS dS )z� Applies the values in out_shaping_conf to an out_shaping object pg_name The name of the portgroup out_shaping The vim.DVSTrafficShapingPolicy to apply the config to out_shaping_conf The out shaping config z,Building portgroup's '%s' out shaping policyr� r� r� r� N) r� rI rD r Z LongPolicyr� r� r� � BoolPolicyr� r� )r� r� Zout_shaping_confr3 r3 r4 � _apply_dvportgroup_out_shaping> s �r� c C sn t �d| � d|v rt�� |_|d |j_d|v r$t�� |_|d |j_d|v r5t�� |_|d |j_dS dS )z� Applies the values in sec_policy_conf to a security policy object pg_name The name of the portgroup sec_policy The vim.DVSTrafficShapingPolicy to apply the config to sec_policy_conf The out shaping config z)Building portgroup's '%s' security policyr� r� r� N)r� rI r r� r� r� r� r� )r� r� Zsec_policy_confr3 r3 r4 �"_apply_dvportgroup_security_policyZ s �r� c C s� t �d| � d|v rt�� |_|d |j_d|v r$t�� |_|d |j_d|v r3t�� |_|d |j_d|v rBt�� |_ |d |j _d|v r�|j sNt� � |_ |d }d|v rct�� |j _ |d |j j _d|v rtt�� |j _ |d |j j _d |v r�t�� |j _|d |j j_d |v r�t�� |j _|d |j j_d |v r�t�� |j _|d |j j_d |v r�t�� |j _|d |j j_d |v r�t�� |j _|d |j j_d|v r�|js�t�� |_d|d v r�|d d |j_d|d v r�|d d |j_dS dS dS )z� Applies the values in teaming_conf to a teaming policy object pg_name The name of the portgroup teaming The vim.VmwareUplinkPortTeamingPolicy to apply the config to teaming_conf The teaming config z!Building portgroup's '%s' teamingr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� N)r� rI r r� r� r� Z StringPolicyr� r� r� r� ZDVSFailureCriteriar� r� r� r� r� Z IntPolicyr� r� r� ZVMwareUplinkPortOrderPolicyr� r� )r� r� Z teaming_confZfailure_criteria_confr3 r3 r4 �_apply_dvportgroup_teamings s~ � � � � � � � ��r� c C s0 t �d| � d|v r|d |_d|v r|d |_d|v r!|d |_d|v r*|d |_|js;dD ] }||v r:t�� |_q/d|v rLt� � |j_ |d |jj _ d|v rd|jj sZt� � |j_ t| |jj |d � d |v r||jjsrt�� |j_t| |jj|d � d |v r�|jjs�t�� |j_t| |jj|d � d S d S ) z� Applies the values in conf to a distributed portgroup spec pg_name The name of the portgroup pg_spec The vim.DVPortgroupConfigSpec to apply the config to pg_conf The portgroup config z Building portgroup's '%s' specr@ rC r� r� )r� r� r� r� r� r� r� r� N)r� rI r@ rC �numPortsr� �defaultPortConfigr ZVMwareDVSPortSettingr� r� r� r� ZDVSTrafficShapingPolicyr� r� ZDVSSecurityPolicyr� r� Z VmwareUplinkPortTeamingPolicyr� )r� Zpg_specZpg_confr� r3 r3 r4 �_apply_dvportgroup_config� sN � � ����r� c C s� t �d||| � t� }|dkrtd � d }t|�}n|dkr.td � d }tjj�||�}tjjj ||gd�}|sBt d|� d ���|| d < t � � }t ||| � tjj�|d |� d S ) a� Creates a distributed virtual portgroup. Note: The ``portgroup_name`` param will override any name already set in ``portgroup_dict``. portgroup_dict Dictionary with the config values the portgroup should be created with (example in salt.states.dvs). portgroup_name Name of the portgroup to be created. dvs Name of the DVS that will contain the portgroup. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_dvportgroup portgroup_dict=<dict> portgroup_name=pg1 dvs=dvs1 z2Creating portgroup '%s' in dvs '%s' with dict = %sr. rH rm r- rG r� r� r� r@ r T)r� rI rE rT rs r7 r8 re rt ru r r �DVPortgroupConfigSpecr� �create_dvportgroup) �portgroup_dictZportgroup_namer} rb r[ rm r| r� �specr3 r3 r4 r� � s* � r� c C s t �d||| � t� }|dkrtd � d }t|�}n|dkr.td � d }tjj�||�}tjjj ||gd�}|sBt d|� d ���tjjj |d |gd �}|sXt d |� d ���tjj� |d d g�} t �� } dD ] } t| | t| d | �� qit|| | � tjj�|d | � dS )a� Updates a distributed virtual portgroup. portgroup_dict Dictionary with the values the portgroup should be update with (example in salt.states.dvs). portgroup Name of the portgroup to be updated. dvs Name of the DVS containing the portgroups. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.update_dvportgroup portgroup_dict=<dict> portgroup=pg1 salt '*' vsphere.update_dvportgroup portgroup_dict=<dict> portgroup=pg1 dvs=dvs1 z2Updating portgroup '%s' in dvs '%s' with dict = %sr. rH rm r- rG r� r� r� r �r� � Portgroup 'r� ) Z autoExpand� configVersionr� rC r@ r� r� ZportNameFormatZscoper� ZvendorSpecificConfigT)r� rI rE rT rs r7 r8 re rt ru r r� rv r r� r� r� r� �update_dvportgroup) r� � portgroupr} rb r[ rm r| r� �pg_refsZpg_propsr� r� r3 r3 r4 r� - s< � � � r� c C s� t �d| |� t� }|dkrtd � d }t|�}n|dkr-td � d }tjj�||�}tjjj ||gd�}|sAt d|� d ���tjjj |d | gd �}|sWt d | � d ���tjj� |d � d S )a� Removes a distributed virtual portgroup. portgroup Name of the portgroup to be removed. dvs Name of the DVS containing the portgroups. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.remove_dvportgroup portgroup=pg1 dvs=dvs1 z#Removing portgroup '%s' in dvs '%s'r. rH rm r- rG r� r� r� r r� r� T) r� rI rE rT rs r7 r8 re rt ru r r� �remove_dvportgroup)r� r} rb r[ rm r| r� r� r3 r3 r4 r� z s$ �r� c C s | j | j| jjd�}g }t| tjj�rzt| jtjj�rz| jj D ]Z}|j |j d�}g }|j D ]B}|j j |j j d�}|jd jd j}t|tj jj�rRd|j|jd�} nt|tj jj�rad|jd�} nd |d �} | |d < |�|� q-||d < |�|� q ||d < |S )z/Returns a dictionary representation of a policy)r@ rC Z resource_type)r@ �force_provision)� namespacer r �range)r� �min�max�set)r� �values�scalar)r� r� �setting� capabilities� subprofiles)r@ rC � resourceTyper| r �profileZCapabilityBasedProfile� constraints� SubProfileCapabilityConstraints� subProfiles�forceProvisionrn r r� � constraint�propertyInstancer� �types�Ranger� r� � DiscreteSetr� rU ) r� Z profile_dictZsubprofile_dictsZ subprofile�subprofile_dictZ cap_dictsZcap�cap_dict�valZval_dictr3 r3 r4 �_get_policy_dict� s6 � � � r c C sD t jj�|�}| st jjj|dd�}nt jj�|| �}dd� |D �S )a� Returns a list of storage policies. policy_names Names of policies to list. If None, all policies are listed. Default is None. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_storage_policies salt '*' vsphere.list_storage_policies policy_names=[policy_name] T�Zget_all_policiesc S � g | ]}t |��qS r3 )r �r� �pr3 r3 r4 r� � r� z)list_storage_policies.<locals>.<listcomp>)r7 r8 r �get_profile_manager�get_storage_policies)Z policy_namesrb �profile_manager�policiesr3 r3 r4 �list_storage_policies� s �r c C sF t jj�| �}t jjj|dd�}dd� |D �}|s td��t|d �S )z� Returns the default vsan storage policy. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_default_vsan_policy Tr c S s g | ] }|j d kr|�qS )ZVsanDefaultProfile)ZsystemCreatedProfileTyper r3 r3 r4 r� s z,list_default_vsan_policy.<locals>.<listcomp>z%Default VSAN policy was not retrievedr )r7 r8 r r r r r )rb r r Z def_policiesr3 r3 r4 �list_default_vsan_policy� s �� r c C s( | j j| j j | j| jj| jd jjd�S )Nr )r� r � mandatoryrC r� )r r� r �summaryZpropertyMetadatar� ZtypeName)Z cap_metadatar3 r3 r4 � _get_capability_definition_dict s �r c C s* t jj�| �}dd� t jj�|�D �}|S )a Returns a list of the metadata of all capabilities in the vCenter. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_capabilities c S r r3 )r )r� �cr3 r3 r4 r� * s ��z/list_capability_definitions.<locals>.<listcomp>)r7 r8 r r Zget_capability_definitions)rb r r{ r3 r3 r4 �list_capability_definitions s �r c C s� t �d|� |�d�r|d | _|�d�r|d | _|�d�r�tj�� | _g }|d D ]�}tjjj |d d�}g }|�d�rC|d |_ |d D ]k}tj j |d d �}|d d }|d krltj j �� |_|d d |j_n'|dkr�tj j �� |_|d d |j_|d d |j_n |dkr�|d d |_tj jtj jj|d |d d�tj j|gd�gd�} |�| � qG||_ |�|� q+|| j_t �d| � | S )z,Applies a policy dictionary to a policy speczpolicy_dict = %sr@ rC r �r@ r� r� r r r� r� r� r� r� r� r� r� r� r� )r r� )r )r r zupdated policy_spec = %s)r� rI rD r@ rC r r r r Z SubProfiler rn ZPropertyInstancer r r� r� r r� r� ZCapabilityInstanceZCapabilityMetadataZUniqueIdZConstraintInstancerU r ) Z policy_spec� policy_dictr r Zsubprofile_specZ cap_specsr Zprop_inst_specZ setting_typeZcap_specr3 r3 r4 �_apply_policy_config1 sT � ���� r! c C sp t �d| |� tjj�|�}tj�� }tjjtjj j d�|_ | |d< t �d� t ||� tjj� ||� ddiS )ap Creates a storage policy. Supported capability types: scalar, set, range. policy_name Name of the policy to create. The value of the argument will override any existing name in ``policy_dict``. policy_dict Dictionary containing the changes to apply to the policy. (example in salt.states.pbm) service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_storage_policy policy_name='policy name' policy_dict="$policy_dict" z%create storage policy '%s', dict = %s)r r@ �+Setting policy values in policy_update_spec�create_storage_policyT)r� rI r7 r8 r r r Z CapabilityBasedProfileCreateSpecZ ResourceTypeZResourceTypeEnumZSTORAGEr r! r# )Z policy_namer rb r Zpolicy_create_specr3 r3 r4 r# c s � r# c C s� t �d|� tjj�|�}tjj�|| g�}|s td| � d���|d }tj� � }t �d� dD ] }t ||t ||�� q0t ||� tjj� |||� ddiS ) a Updates a storage policy. Supported capability types: scalar, set, range. policy Name of the policy to update. policy_dict Dictionary containing the changes to apply to the policy. (example in salt.states.pbm) service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.update_storage_policy policy='policy name' policy_dict="$policy_dict" z"updating storage policy, dict = %s�Policy '�' was not foundr r" )rC r �update_storage_policyT)r� rI r7 r8 r r r r r Z CapabilityBasedProfileUpdateSpecr� r� r! r& )r� r rb r r � policy_refZpolicy_update_specr� r3 r3 r4 r& � s �r& c C sh t �d| � t|�}tjjj||| gd�}|s td| � d���tjj� |�}tjj� ||d �}t |�S )a� Returns a list of datastores assign the storage policies. datastore Name of the datastore to assign. The datastore needs to be visible to the VMware entity the proxy points to. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_default_storage_policy_of_datastore datastore=ds1 z4Listing the default storage policy of datastore '%s'��datastore_names� Datastore 'r% r ) r� rI rs r7 r8 re �get_datastoresr r r Z'get_default_storage_policy_of_datastorer )� datastorerb � target_ref�ds_refsr r� r3 r3 r4 �(list_default_storage_policy_of_datastore� s ��r/ c C s� t �d| |� tjj�|�}tjj�|| g�}|s!td| � d���|d }t|�}tjj j |||gd�}|s>td|� d���|d }tjj� |||� dS )a Assigns a storage policy as the default policy to a datastore. policy Name of the policy to assign. datastore Name of the datastore to assign. The datastore needs to be visible to the VMware entity the proxy points to. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.assign_storage_policy_to_datastore policy='policy name' datastore=ds1 z#Assigning policy %s to datastore %sr$ r% r r( r* T) r� rI r7 r8 r r r r rs re r+ �*assign_default_storage_policy_to_datastore) r� r, rb r r r' r- r. �ds_refr3 r3 r4 r0 � s" ��r0 c C s6 | s t jjj|dd�}nt jj�|| �}dd� |D �S )a� Returns a list of dict representations of VMware datacenters. Connection is done via the proxy details. Supported proxies: esxdatacenter datacenter_names List of datacenter names. Default is None. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash 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] T)Zget_all_datacentersc S s g | ] }d t jj�|�i�qS r �r7 r8 re �get_managed_object_name)r� r| r3 r3 r4 r� ; s ��z.list_datacenters_via_proxy.<locals>.<listcomp>)r7 r8 re Zget_datacenters)Zdatacenter_namesrb Zdc_refsr3 r3 r4 �list_datacenters_via_proxy s ��r4 c C s t jj�|| � ddiS )a@ Creates a datacenter. Supported proxies: esxdatacenter datacenter_name The datacenter name service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_datacenter dc1 �create_datacenterT)r7 r8 re r5 )�datacenter_namerb r3 r3 r4 r5 A s r5 c C s t �d| � tjjj|dgd�}d|d jjid|d jjid�}|d j}t �d|� |j |d d< |j rKt |j t j �rK|j }|j|jd �|d d < |jr\|j}|j|jd �|d d < |j|d d < |jrm|j|d d< |jr|dd� |jD �|d d< |j|d d< |d j}t �d|� d|j |d d< |j|d d< |d j|d< tjj�|�}tjj� |��rtjj� |�} t | j �dkr�tjj� |�} t �d| � | j| j!j"d�|d < | j#r�| j#} |d �$| j%p�d | j&d �� |S |d j'�r|d j'j!} |d j'j| j"d�|d < |S ) z� Returns a cluster dict representation from a vim.ClusterComputeResource object. cluster_name Name of the cluster cluster_ref Reference to the cluster z4Building a dictionary representation of cluster '%s'�configurationEx�� propertiesr� )�ha�drsz ha_conf = %sr: �admission_control_enabled)�cpu_failover_percent�memory_failover_percent�admission_control_policy)�isolation_response�restart_priority�default_vm_settings�hb_ds_candidate_policy�host_monitoringc S s g | ] }|j |jd ��qS )�r� r� rE )r� �or3 r3 r4 r� � s �z%_get_cluster_dict.<locals>.<listcomp>�options� vm_monitoringz drs_conf = %s� r; � vmotion_rate�default_vm_behavior�vm_swap_placement�jv7 zvsan_conf = %s)r� �auto_claim_storager: F)�compression_enabled� dedup_enabled)(r� rI r7 r8 re rv � dasConfigr� � drsConfig�admissionControlEnabled�admissionControlPolicyr| r �.ClusterFailoverResourcesAdmissionControlPolicy�cpuFailoverResourcesPercent� memoryFailoverResourcesPercent�defaultVmSettings�isolationResponse�restartPriority�hBDatastoreCandidatePolicy�hostMonitoring�option� vmMonitoring� vmotionRate�defaultVmBehavior�vmSwapPlacement�(get_service_instance_from_managed_objectr: �vsan_supported�get_service_info�int�build�get_cluster_vsan_info� defaultConfig�autoClaimStorage�dataEfficiencyConfigr} �compressionEnabled� dedupEnabled�vsanConfigInfo) � cluster_name� cluster_refr rj Zha_confZpolZ def_vm_setZdrs_conf�si� vcenter_infoZ vsan_confZdata_effZdefault_configr3 r3 r4 �_get_cluster_dict\ sv �� ���� ��� � �rr c C sj t � }|dkrt|�}|std��tjj�||�}n|dkr)t|�}td � d }t� d||� t ||�S )a� Returns a dict representation of an ESX cluster. datacenter Name of datacenter containing the cluster. Ignored if already contained by proxy details. Default value is None. cluster Name of cluster. Ignored if already contained by proxy details. Default value is None. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash # vcenter proxy salt '*' vsphere.list_cluster datacenter=dc1 cluster=cl1 # esxdatacenter proxy salt '*' vsphere.list_cluster cluster=cl1 # esxcluster proxy salt '*' vsphere.list_cluster r. � 'cluster' needs to be specifiedr- rG �clusterz7Retrieving representation of cluster '%s' in a %s proxy) rE rs r r7 r8 re � get_clusterrT r� rI rr )rm rt rb r[ r| ro r3 r3 r4 � list_cluster� s #� rv c C sT t �d|� |�d�r�|d }| jst�� | _| j}d|v r*|d |_|d r*d|_d|v r3|d |_d|v rQ|d }|j rEt |j tj �sQtj |d |d d �|_ d |v ru|d }|j sat� � |_ d |v rk|d |j _d |v ru|d |j _d |v r~|d |_d|v r�|d |_d|v r�g |_|d D ]}|j�tj|d d�� d|v r�|d |jd _q�d|v r�|d |_|| _|�d�r�|d } t�� } d| v r�| d | _d| v r�d| d | _d| v r�t�| d �| _| | _|�d�r�|d | _ |�d��r�|d } |�snd| v �r|j �stj j � � |_ | d |j _d| v �rD|j �s&tj j � � |_ |j j!�s2t�"� |j _!n |j j!j#�r=d |j j!_#| d |j j!_$d | v �rY|j%�sStj �&� |_%| d |j%_'d | v �rn|j%�shtj �&� |_%| d |j%_(| j)�swt�*� | _)| j)} d| v �r�| d | _d| v �r�| j!�s�t�"� | _!n | j!j#�r�d | j!_#| d | j!_$t �d | � d S ) a� Applies the values of cluster_dict dictionary to a cluster spec (vim.ClusterConfigSpecEx). All vsan values (cluster_dict['vsan']) will be applied to vsan_spec (vim.vsan.cluster.ConfigInfoEx). Can be not omitted if not required. VSAN 6.1 config needs to be applied differently than the post VSAN 6.1 way. The type of configuration desired is dictated by the flag vsan_61. zApplying cluster dict %sr: r� r� r< r? r= r> )rV rW rB r@ rA rC rD rG r� r� r� ���rH r; rJ rI rK rL r: rN NrO rP zcluster_spec = %s)+r� rI rD rQ r ZClusterDasConfigInfor� Z failoverLevelrS rT r| rU rX ZClusterDasVmSettingsrY rZ r[ r\ r] rU � OptionValuer� r^ ZClusterDrsConfigInfor_ Z DrsBehaviorr` rR ra ZvsanClusterConfigr: rt r; rh Z$VsanClusterConfigInfoHostDefaultInfo�uuidri rj ZDataEfficiencyConfigrk rl � vsanConfigZVsanClusterConfigInfo) � cluster_spec� cluster_dict� vsan_spec�vsan_61Zha_dictZ das_configZ adm_pol_dictZ vm_set_dictZopt_dictZdrs_dictZ drs_configZ vsan_dictr� r3 r3 r4 �_apply_cluster_dict� s� ����� �� � � � � � r c C s� t �� }zt�| |� W n tjjy } zt|��d}~ww t� }|dkr8td � d }t |�}|s7t d��n|dkrRtd � d }t j j �||�}td � d }| �d �rbt j j�|�sbtd ��|}t�� } d} d} d} | �d �r�t j j �|�} t| j�d kr�t| j�d kr�tjjd d�} d} | �di ��d�r�d }| d } | d= nd } t| | | | � t j j � ||| � | s�| r�t j j � ||�}t j j� || � |r�t| d| i� t j j � || � | | d< dd iS )a5 Creates a cluster. Note: cluster_dict['name'] will be overridden by the cluster param value config_dict Dictionary with the config values of the new cluster. datacenter Name of datacenter containing the cluster. Ignored if already contained by proxy details. Default value is None. cluster Name of cluster. Ignored if already contained by proxy details. Default value is None. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash # esxdatacenter proxy salt '*' vsphere.create_cluster cluster_dict=$cluster_dict cluster=cl1 # esxcluster proxy salt '*' vsphere.create_cluster cluster_dict=$cluster_dict Nr. rH rm rs r- rG rt r: �!VSAN operations are not supported� @rM T��modifyFr: r� �create_cluster) r � serialize� jsonschema�validate� exceptions�ValidationErrorr rE rT rs r r7 r8 re rt rD r: rc r r �ClusterConfigSpecExrd �float� apiVersionre rf � ReconfigSpecr r� ru �reconfigure_cluster_vsan�update_cluster)r| rm rt rb �schema�excr[ r| rp r{ r} Z ha_configr~ rq Z enable_haro r3 r3 r4 r� g sb '���� �r� c C s< t �� }zt�| |� W n tjjy } zt|��d}~ww t� }|dkr8td � d }t |�}|s7t d��n|dkrRtd � d }t j j �||�}td � d }| �d �rbt j j�|�sbtd ��t j j �||�}t�� } t j j j|d gd �} d D ] } t| | t| d | �� qz| d jr�| d j| _d} d} | �d �r�t j j �|�}t |j �dkr�t |j �dkr�d} t j j� |�}tjj!dd�} |j"| _"d|_"nd} t#| | | | � | �rt$�%d| � t j j�&|| � t�� } t j j j|d gd �} d D ] } t| | t| d | �� q�| d j�r | d j| _t#| | � t j j �'|| � ddiS )a� Updates a cluster. config_dict Dictionary with the config values of the new cluster. datacenter Name of datacenter containing the cluster. Ignored if already contained by proxy details. Default value is None. cluster Name of cluster. Ignored if already contained by proxy details. Default value is None. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash # esxdatacenter proxy salt '*' vsphere.update_cluster cluster_dict=$cluster_dict cluster=cl1 # esxcluster proxy salt '*' vsphere.update_cluster cluster_dict=$cluster_dict Nr. rH rm rs r- rG rt r: r� r7 r8 )rQ rR r� rM FTr� zvsan_spec = %sr� )(r r� r� r� r� r� r rE rT rs r r7 r8 re rt rD r: rc r ru r r� rv r� r� rm rz rd r� r� re rf rg r� rj r r� rI r� r� )r| rm rt rb r� r� r[ r| ro r{ r r r} r~ rq Z vsan_infor3 r3 r4 r� � sr &����� � r� c sL t |�}tjj�|�}t�d|� | s|s|sdnd}|r@t�d|� dd� tjjj||d�D �}t�d|� |r>|� |�n|}tjj� ||| ||�}g } t |t j �rktjj�|||�} tjj�| d g�} | �d g �} g } |D ]4� � j� jj� jj� jjd �} g }� fd d�| D �D ] }|� d d� |jD �� q�|r�|| d < | �| � qo| S )a� 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 datastore_names List of the names of datastores to filter on backing_disk_ids List of canonical names of the backing disks of the datastores to filer. Default is None. backing_disk_scsi_addresses List of scsi addresses of the backing disks of the datastores to filter. Default is None. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_datastores_via_proxy salt '*' vsphere.list_datastores_via_proxy datastore_names=[ds1, ds2] ztarget name = %sTFz+Retrieving disk ids for scsi addresses '%s'c S � g | ]}|j �qS r3 �r� �r� �dr3 r3 r4 r� x s ��z-list_datastores_via_proxy.<locals>.<listcomp>)�scsi_addresseszFound disk ids '%s'z fileSystemVolumeInfo.mountInfo)r@ r� Z free_space�capacityc s. g | ]}|j j� jkrt|j tj�r|j �qS r3 )Zvolumer@ r| r ZHostVmfsVolume)r� �i��dsr3 r4 r� � s �c S r� r3 )ZdiskName)r� rl r3 r3 r4 r� � � �backing_disk_ids)rs r7 r8 re r3 r� rI r� � get_disks�extendr+ r| r Z HostSystemZget_storage_systemrv rD r@ r r� Z freeSpacer� ZextentrU )r) r� Zbacking_disk_scsi_addressesrb �target� target_nameZget_all_datastores�disk_ids� datastoresZ mount_infos�storage_systemr r� Zds_dictZvolr3 r� r4 �list_datastores_via_proxyA sf ( ������� � � �� � � r� c C s� t �d� t�� }zt�d| ||d�i|� W n tjjy) } zt|��d}~ww t |�}t d � d }|rNt j j j||gd�} | sNtd|� d |� d ���t j j �|| | d |�} d S ) a� Creates a ESXi host disk group with the specified cache and capacity disks. datastore_name The name of the datastore to be created. disk_id The disk id (canonical name) on which the datastore is created. vmfs_major_version The VMFS major version. safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task. Default is True. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_vmfs_datastore datastore_name=ds1 disk_id= vmfs_major_version=5 z Validating vmfs datastore inputr, )r@ Zbacking_disk_idZ vmfs_versionNrF ru �r� zDisk 'z' was not found in host 'rJ r T)r� r� r r� r� r� r� r� r rs � __proxy__r7 r8 re r� r �create_vmfs_datastore) �datastore_name�disk_idZvmfs_major_version� safety_checksrb r� r� r� �hostnamer� r1 r3 r3 r4 r� � s8 '��� ��� �r� c C s\ t �d| |� t|�}tjjj||| gd�}|s td| � d���|d }tjj�||� dS )a� Renames a datastore. The datastore needs to be visible to the proxy. datastore_name Current datastore name. new_datastore_name New datastore name. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.rename_datastore old_name new_name zRenaming datastore %s to %sr( r* r% r T) r� rI rs r7 r8 re r+ r �rename_datastore)r� Znew_datastore_namerb r� r� r� r3 r3 r4 r� � s �r� c C sr t �d| � t|�}tjjj||| gd�}|s td| � d���t|�dkr-td| � d���tjj� ||d � d S ) aF Removes a datastore. If multiple datastores an error is raised. datastore Datastore name service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.remove_datastore ds_name zRemoving datastore '%s')� referencer) r* r% r� zMultiple datastores 'z ' were foundr T) r� rI rs r7 r8 re r+ r rd �remove_datastore)r, rb r� r� r3 r3 r4 r� s � �r� c C s* t �d� tjj�| �}dd� |D �}|S )z� Lists all licenses on a vCenter. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_licenses zRetrieving all licensesc S sP g | ]$}|j |j|jr|jd jnd|jd kr|jntj|jr"|jnd d��qS )r N)r� r@ rC r� �used)� licenseKeyr@ �labelsr� �total�sys�maxsizer� �r� �lr3 r3 r4 r� H s ���z!list_licenses.<locals>.<listcomp>)r� rI r7 r8 re � get_licenses)rb �licensesr� r3 r3 r4 � list_licenses4 s � r� c C s" t �d| � tjj�|| |� dS )a Adds a license to the vCenter or ESXi host key License key. description License description added in as a label. safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.add_license key=<license_key> desc='License desc' zAdding license '%s'T)r� rI r7 r8 re � add_license)r� rC r� rb r3 r3 r4 r� V s r� c C sb t �d|� |d dkr tjj�| |d �}tjj�||d �S |d dkr(dS td�|d ���)a� Returns the entity associated with the entity dict representation Supported entities: cluster, vcenter Expected entity format: .. code-block:: python cluster: {'type': 'cluster', 'datacenter': <datacenter_name>, 'cluster': <cluster_name>} vcenter: {'type': 'vcenter'} service_instance Service instance (vim.ServiceInstance) of the vCenter. entity Entity dict in the format above zRetrieving entity: %sr� rt rm r/ N� Unsupported entity type '{}') r� rI r7 r8 re rt ru r rY )rb �entityr| r3 r3 r4 � _get_entityw s � r� c C sv | d dkr t �� }n| d dkrt�� }n td�| d ���z t�| |� W dS tjjy: } zt |��d}~ww )z� Validates the entity dict representation entity Dictionary representation of an entity. See ``_get_entity`` docstrings for format. r� rt r/ r� N) r r� r r rY r� r� r� r� r )r� r� r� r3 r3 r4 �_validate_entity� s ��r� c s@ t �d| � t| � tjjj|t|| �|d�}� fdd�|D �S )ab Lists the licenses assigned to an entity entity Dictionary representation of an entity. See ``_get_entity`` docstrings for format. entity_display_name Entity name used in logging license_keys: List of license keys to be retrieved. Default is None. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_assigned_licenses entity={type:cluster,datacenter:dc,cluster:cl} entiy_display_name=cl z&Listing assigned licenses of entity %s�Z entity_refZ entity_namec sT g | ]&}� d u s |j � v r|j |j|jr|jd jnd |jdkr#|jntjd��qS )Nr )r� r@ rC r� )r� r@ r� r� r� r� r� r� �� license_keysr3 r4 r� � s ��z*list_assigned_licenses.<locals>.<listcomp>)r� rI r� r7 r8 re Zget_assigned_licensesr� )r� �entity_display_namer� rb Zassigned_licensesr3 r� r4 �list_assigned_licenses� s !� �r� c sl t �d� |� t|� |r%tjj�|�}� fdd�|D �s%td|� d���tjjj|� |t ||�|d� dS )a Assigns a license to an entity license_key Key of the license to assign See ``_get_entity`` docstrings for format. license_name Display name of license entity Dictionary representation of an entity entity_display_name Entity name used in logging safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task. Default is False. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.assign_license license_key=AAAAA-11111-AAAAA-11111-AAAAA license_name=test entity={type:cluster,datacenter:dc,cluster:cl} z!Assigning license %s to entity %sc � g | ] }|j � kr|�qS r3 )r� r� �� license_keyr3 r4 r� � z"assign_license.<locals>.<listcomp>z License 'z' wasn't foundr� N) r� rI r� r7 r8 re r� r �assign_licenser� )r� Z license_namer� r� r� rb r� r3 r� r4 r� � s , �r� c C sF |r |s t j�d��d}| sd}t jjj||| ||d�}dd� |D �S )a~ Returns a list of hosts for the specified VMware environment. The list of hosts can be filtered by datacenter name and/or cluster name hostnames Hostnames to filter on. datacenter_name Name of datacenter. Only hosts in this datacenter will be retrieved. Default is None. cluster_name Name of cluster. Only hosts in this cluster will be retrieved. If a datacenter is not specified the first cluster with this name will be considerred. Default is None. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash 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 z0Datacenter is required when cluster is specifiedFT)r6 r� rn � get_all_hostsc S s g | ] }t jj�|��qS r3 r2 )r� �hr3 r3 r4 r� V r� z(list_hosts_via_proxy.<locals>.<listcomp>)r7 r� r r8 re � get_hosts)Z hostnamesrm rt rb r� �hostsr3 r3 r4 �list_hosts_via_proxy" s %��r� c C s� t |�}td � d }t�d|| |� | s|sdnd}g }tjjj||d�}dd� |�� D �}tjj� || ||�D ]} |� | j || j d �� q9|S ) a� 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. disk_ids: List of disk canonical names to be retrieved. Default is None. scsi_addresses List of scsi addresses of disks to be retrieved. Default is None service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash 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]' rF ru z?Retrieving disks of host '%s'; disc ids = %s; scsi_address = %sTF�r� c S s i | ]\}}|j |�qS r3 r� )r� Z scsi_addrZlunr3 r3 r4 � <dictcomp>� s �z list_disks.<locals>.<dictcomp>)r � scsi_address) rs r� r� rI r7 r8 re �get_scsi_address_to_lun_mapr� r� rU r� ) r� r� rb r� r� Z get_all_disksr{ �scsi_address_to_lunZ canonical_name_to_scsi_addressr� r3 r3 r4 � list_disksY s2 ������r� c C s� | s|st d��t|�}td � d }| s5tjj�|�}||vr(td�||���|| j } t � d|| |� t � d| |� tjjj ||| |d� t � d| |� d S ) a Erases the partitions on a disk. The disk can be specified either by the canonical name, or by the scsi_address. disk_id Canonical name of the disk. Either ``disk_id`` or ``scsi_address`` needs to be specified (``disk_id`` supersedes ``scsi_address``. scsi_address Scsi address of the disk. ``disk_id`` or ``scsi_address`` needs to be specified (``disk_id`` supersedes ``scsi_address``. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.erase_disk_partitions scsi_address='vmhaba0:C0:T0:L0' salt '*' vsphere.erase_disk_partitions disk_id='naa.000000000000001' �8Either 'disk_id' or 'scsi_address' needs to be specifiedrF ru �5Scsi lun with address '{}' was not found on host '{}'�+[%s] Got disk id '%s' for scsi address '%s'z1Erasing disk partitions on disk '%s' in host '%s'r� z0Erased disk partitions on disk '%s' on host '%s'T)r rs r� r7 r8 re r� r rY r� r� rI �erase_disk_partitions�info)r� r� rb r� r� r� r3 r3 r4 r� � s6 ��� ��r� c s | s|st d��t|�}td � d }| s5tjj�|�}||vr(td�||���|| j } t � d|| |� t � d| |� tjj� || �}g }|j jD ]6� � fdd�|jjD �d }|| |j j� j� j� j� j d |jj|jj d |jj d d �} |�| � qJ|S ) a Lists the partitions on a disk. The disk can be specified either by the canonical name, or by the scsi_address. disk_id Canonical name of the disk. Either ``disk_id`` or ``scsi_address`` needs to be specified (``disk_id`` supersedes ``scsi_address``. scsi_address` Scsi address of the disk. ``disk_id`` or ``scsi_address`` needs to be specified (``disk_id`` supersedes ``scsi_address``. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_disk_partitions scsi_address='vmhaba0:C0:T0:L0' salt '*' vsphere.list_disk_partitions disk_id='naa.000000000000001' r� rF ru r� r� z1Listing disk partitions on disk '%s' in host '%s'c s g | ] }|j � j kr|�qS r3 )� partitionr �Z part_specr3 r4 r� s �z(list_disk_partitions.<locals>.<listcomp>r r� � )r� r. rY r� r� ZsectorsZsize_KB)r rs r� r7 r8 re r� r rY r� r� rI Zget_disk_partition_infor� r� ZlayoutZpartitionFormatr� Z endSectorZ startSector�end�block�startZ blockSizerU ) r� r� rb r� r� r� Zpartition_infor{ Z part_layoutZ part_dictr3 r� r4 �list_disk_partitions� sX ��� � ����� r� c C sn t |�}td � d }t�d|� | sdnd}g }tjj�|| |�D ]}|�|j j dd� |j D �d�� q"|S ) a� 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. cache_disk_ids: List of cache disk canonical names of the disk groups to be retrieved. Default is None. use_proxy_details Specify whether to use the proxy minion's details instead of the arguments service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.list_diskgroups salt '*' vsphere.list_diskgroups cache_disk_ids='[naa.000000000000001]' rF ru zListing diskgroups in '%s'TFc S r� r3 r� r� r3 r3 r4 r� K r� z#list_diskgroups.<locals>.<listcomp>)� cache_disk�capacity_disks) rs r� r� rI r7 r8 re �get_diskgroupsrU �ssdr� ZnonSsd)�cache_disk_idsrb r� r� Zget_all_diskgroupsr{ �dgr3 r3 r4 �list_diskgroups" s ���r� c s@ t �d� t�� }zt�d� �d�gi|� W n tjjy) } zt|��d}~ww t |�}t d � d }|rJt j j �|� g�}|rJtd�� |����dd� } | �d� � t j j j|| d �} | D ]��fd d �| D �swtd �� d |� d���qa� fdd �| D �d } �fdd �| D �} t j j�|�} t j j�|| || | �}dS )a7 Creates disk group on an ESXi host with the specified cache and capacity disks. cache_disk_id The canonical name of the disk to be used as a cache. The disk must be ssd. capacity_disk_ids A list containing canonical names of the capacity disks. Must contain at least one id. Default is True. safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task. Default value is True. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.create_diskgroup cache_disk_id='naa.000000000000001' capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' �Validating diskgroup input� diskgroups�Zcache_idZ capacity_idsNrF ru z?Diskgroup with cache disk id '{}' already exists ESXi host '{}'r r� c r� r3 r� r� r r3 r4 r� � r� z$create_diskgroup.<locals>.<listcomp>zNo disk with id 'z' was found in ESXi host 'rJ c r� r3 r� r� )� cache_disk_idr3 r4 r� � r� c � g | ] }|j � v r|�qS r3 r� r� ��capacity_disk_idsr3 r4 r� � r� T)r� rI r r� r� r� r� r� r rs r� r7 r8 re r� r rY �insertr� r r: � get_vsan_disk_management_system�create_diskgroup)r� r� r� rb r� r� r� r� r� r� r� r� r� �vsan_disk_mgmt_systemr� r3 )r� r� r r4 r� Q sR #������ ��� �r� c s t �d� t�� }zt�d| |d�gi|� W n tjjy) } zt|��d}~ww t |�}t d � d }t j j j||d�}|rV|D ]� � fdd �|D �sUtd �� |���qBt j j j|| gd �} | sjtd �| |���t j j�|�} t j j�|| || d |� dS )a� Adds capacity disks to the disk group with the specified cache disk. cache_disk_id The canonical name of the cache disk. capacity_disk_ids A list containing canonical names of the capacity disks to add. safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task. Default value is True. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.add_capacity_to_diskgroup cache_disk_id='naa.000000000000001' capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' r� r� r� NrF ru r� c r� r3 r� r� r r3 r4 r� � r� z-add_capacity_to_diskgroup.<locals>.<listcomp>�0No disk with id '{}' was found in ESXi host '{}'�r� �@No diskgroup with cache disk id '{}' was found in ESXi host '{}'r T)r� rI r r� r� r� r� r� r rs r� r7 r8 re r� r rY r� r: r� �add_capacity_to_diskgroup) r� r� r� rb r� r� r� r� r� r� r� r3 r r4 r� � sT !�������������r� c s t �d� t�� }zt�d| � d�gi|� W n tjjy+ } ztt |���d}~ww t |�}t d � d }t j jj|� d�} |rX� D ]��fdd �| D �sWtd ��|���qDt j jj|| gd �} | sltd �| |���t �d |� t j jj||| d � fdd �| D �|d� dS )a� Remove capacity disks from the disk group with the specified cache disk. cache_disk_id The canonical name of the cache disk. capacity_disk_ids A list containing canonical names of the capacity disks to add. data_evacuation Specifies whether to gracefully evacuate the data on the capacity disks before removing them from the disk group. Default value is True. safety_checks Specify whether to perform safety check or to skip the checks and try performing the required task. Default value is True. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.remove_capacity_from_diskgroup cache_disk_id='naa.000000000000001' capacity_disk_ids='[naa.000000000000002, naa.000000000000003]' r� r� r� NrF ru r� c r� r3 r� r� r r3 r4 r� # r� z2remove_capacity_from_diskgroup.<locals>.<listcomp>r� r� r� zdata_evacuation = %sr c r� r3 r� r� r� r3 r4 r� 7 r� )r� �data_evacuationT)r� rI r r� r� r� r� r� r r5 rs r� r7 r8 re r� r rY r� r: � remove_capacity_from_diskgroup) r� r� r� r� rb r� r� r� r� r� r� r3 )r� r r4 r� � sX )��� �������� �r� c C sr t �d� t|�}td � d }tjjj|| gd�}|s$td� | |���t �d|� tjj j |||d |d� d S ) a� Remove the diskgroup with the specified cache disk. cache_disk_id The canonical name of the cache disk. data_accessibility Specifies whether to ensure data accessibility. Default value is True. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.remove_diskgroup cache_disk_id='naa.000000000000001' r� rF ru r� r� zdata accessibility = %sr )�data_accessibilityT) r� rI rs r� r7 r8 re r� r rY r: �remove_diskgroup)r� r� rb r� r� r� r3 r3 r4 r� = s" ��� �r� c C s` i }t | �}td � d }tjj�|�}|s"t�d|� d|d< |S dd|jj i|j � d�d �S ) a Returns the host cache configuration on the proxy host. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.get_host_cache rF ru z&Host cache not configured on host '%s'Fr� Tr@ ZMiB)r� r, Z swap_size) rs r� r7 r8 re �get_host_cacher� r� r� r@ ZswapSize)rb r� r� r� Zhcir3 r3 r4 r� i s �r� c C s� t �d� t�� }z t�| ||d�|� W n tjjy' } zt|��d}~ww | s.td��ddi}t |�}t d � d }|r[t j j j|||gd �} | sWtd |� d |� d ���| d } t j j �|| |� dS )a� Configures the host cache on the selected host. enabled Boolean flag specifying whether the host cache is enabled. datastore Name of the datastore that contains the host cache. Must be set if enabled is ``true``. swap_size_MiB Swap size in Mibibytes. Needs to be set if enabled is ``true``. Must be smaller than the datastore size. service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.configure_host_cache enabled=False salt '*' vsphere.configure_host_cache enabled=True datastore=ds1 swap_size_MiB=1024 zValidating host cache input)r� r� � swap_size_MiBNz)Disabling the host cache is not supportedr� FrF ru r( r* z' was not found on host 'rJ r T)r� r� r r� r� r� r� r� r rs r� r7 r8 re r+ r �configure_host_cache) r� r, r� rb r� r� r� r� r� r. r1 r3 r3 r4 r� � s< #������r� c C s: |st | |�}|r|g}|S td��t|t�std��|S )ag Helper function that checks to see if the host provided is a vCenter Server or an ESXi host. If it's an ESXi host, returns a list of a single host_name. If a host reference isn't found, we're trying to find a host object for a vCenter server. Raises a CommandExecutionError in this case, as we need host references to check against. zdNo host reference found. If connecting to a vCenter Server, a list of 'host_names' must be provided.z 'host_names' must be a list.)r� r r| rg )rb rK r� r� r3 r3 r4 r� � s �� r� c C s� i }| d � � D ]Z}|�� �� }|�d�r,|�d�}d|d v r%d|d< nd|d< |S |�d �r>|�d�}|d �� |d < |�d �rP|�d�}|d �� |d < |�d �rb|�d�}|d �� |d< q|S )z� Helper function to format the stdout from the get_coredump_network_config function. cmd_ret The return dictionary that comes from a cmd.run_all call. ry zenabled:r� �truer� Tr� Fz host vnic:r� znetwork server ip:�ipznetwork server port:rO )� splitlinesr� �lower� startswithr� )�cmd_retr� �liner� r� r� Zip_portr3 r3 r4 r� � s* � �r� c C sX di d�}| d � � D ] }|�d�rq |�d�rq |�� }t|d �|d |d < q |S ) z� Helper function to format the stdout from the get_firewall_status function. cmd_ret The return dictionary that comes from a cmd.run_all call. T)r� r� ry �Namez---r� r� r )r� r r� �bool)r r� r Zruleset_statusr3 r3 r4 r� s r� c C st d| d dki}| d dkr| d |d< |S | d � � D ]}|�� }|�d�}|d �� }|d �� }|||< q |S )z� Helper function to format the stdout from the get_syslog_config function. cmd_ret The return dictionary that comes from a cmd.run_all call. r� rw r ry r� r! r� )r� r� r� )r r� r Zcfgvarsr� r� r3 r3 r4 r� s � r� c C � | j jS )z? Helper function that returns a dateTimeManager object )r� r� ��host_referencer3 r3 r4 r� 0 � r� c C sL t jj�| �j}|r|j|dd�}n|j|dd�}|du r$|j|dd�}|S )a, Helper function that returns a host object either from the host location or the host_name. If host_name is provided, that is the host_object that will be returned. The function will first search for hosts by DNS Name. If no hosts are found, it will try searching by IP Address. F)ZdnsName�vmSearchN)r� r )r7 r8 re r� Z searchIndexZ FindByDnsNameZFindByIp)rb rK r� Z search_indexr� r3 r3 r4 r� 7 s r� c C � t | ��d�S )zN Helper function that returns a list of ssd objects for a given host. �SSDs��_get_host_disksrD r r3 r3 r4 r N � r c C r )zR Helper function that returns a list of Non-SSD objects for a given host. �Non-SSDsr r r3 r3 r4 r U r r c C sh | j j}|jj}g }g }|D ] }z|j}W n ty d}Y nw |r)|�|� q|�|� q||d�S )z_ Helper function that returns a dictionary containing a list of SSD and Non-SSD disks. F)r r )r� Z storageSystemZstorageDeviceInfoZscsiLunr� �AttributeErrorrU )r r� r� ZssdsZnon_ssdsr� Z has_ssd_attrr3 r3 r4 r \ s � r c C r )zY Helper function that returns a service manager object from a given host object. )r� r� r r3 r3 r4 r r r r c C s i }|D ]y}t | ||d�}|jj}|du r)d�|�}t�|� |�|d|ii� qg }|�� } | D ] } | jdkr=|� | � q1|sTd�|�}t� |� |�|d|ii� qt |�t |� } g } | D ]} |D ]}| j |jj krr| � | � qdq`|�|d| ii� q|S )a Helper function that returns a dictionary of host_name keys with either a list of eligible disks that can be added to VSAN or either an 'Error' message or a message saying no eligible disks were found. Possible keys/values look like: return = {'host_1': {'Error': 'VSAN System Config Manager is unset ...'}, 'host_2': {'Eligible': 'The host xxx does not have any VSAN eligible disks.'}, 'host_3': {'Eligible': [disk1, disk2, disk3, disk4], 'host_4': {'Eligible': []}} r� Nr0 rx r7 z4The host '{}' does not have any VSAN eligible disks.r� )r� r� r3 rY r� r� r} ZQueryDisksForVsan�staterU �warningr r r� r� )rb rK r� r= r� r� r6 r� Zsuitable_disksr� �itemr� Zmatchingr� Z suitable_diskr3 r3 r4 r� y sD � �� ��r� c C s� i } d} t |t�s |g}|D ]H} | |v rDtjjj| |||| |||| d�} i | | < | d dk| | d< | d dkrCd} | d | | d< qd} i | | < d| | d< d | | d< q| | d< | S ) zm Helper function for reset_syslog_config that resets the config and populates the return dictionary. Trt rw r r� Fry r� z&Invalid syslog configuration parameter)r| rg r7 r8 re r+ )rK rL rM r� r� r� rN rO ru rv r� Z all_successZ reset_paramr= r3 r3 r4 r� � s8 � � r� c C s� d|� d|� �} i } g d�} || vr | � dd|� d�d�� | S tjjj| ||| |||| d�} | d d krB| � |d| d d�i� n | � |d d ii� |rr|rU|}|g}n| }t| |||||| d��|�} | � dd | d d kii� | S )zi Helper function for set_syslog_config that sets the config and populates the return dictionary. zsystem syslog config set --� r� FrJ z!' is not a valid config variable.)r� r� rt rw r ry r� T)rN rO r~ rv Zsyslog_restart)r} r7 r8 re r+ r� rD )rK rL rM r� r� rN rO r� ru rv r� r� r� r r� r3 r3 r4 r� � sV ��� ��� r� c ) s� i } d| d< g | d< t jjj| |||| | d�} t jj�| |�}|s/| d �d|� �� d| d< t jj�||�}|sG| d �d|� �� d| d< t jj�||�}|s_| d �d|� �� d| d< | d re| S |jj }zt | | | �} W n t y� } zd |j � �| d< | W Y d }~S d }~ww | D �]�}i | |< | | � d||� �|d �� t| | |�}|s�| | � dd �|�i� d| d< q�tjjj|d �}tjj|d�}t jj�|�}�fdd�|D �}|s�| | � dd� � d�i� d| d< q�t jj�|�}� fdd�|D �}|�s| | � dd�� d�i� d| d< q�t jj�|�}|�s.| | � ddi� d| d< q�tjjj�|jd�} tjjj| gd�} tjjj|dd�} tj|jj | gd�} |j | d�} z t jjj | |d d d � W nE t �y� } z8t |d��r�t |j!d ��r�||j!j v �r�d |j!j v �s�d| d< | | � d|j!j i� W Y d }~q�n� W Y d }~nd }~ww |j"j#}!d }"|jj$j%D ]}#|#j&j'|d! j%k�r�|#}" n�q�|"�s�| | � dd"i� d| d< q�tj(d#|d! j)|"j&j'tj*tj+|j|jj,j d$�d%�d&�}$|jj$j-d! j.}%tj/d#d'tj0|%d(�d)�}&tj1d#|tj2| d*�d+�}'tj3|&g|'gtj4d,|"j&d-�g|$gd.�}(z|!j5d/|(d0� | | � d1di� W q� t �yc } zt |d ��r^| | � dd2|j � d3�i� W Y d }~q�� d }~ww | S )4a� Adds an ESXi host to a vSphere Distributed Virtual Switch and migrates the desired adapters to the DVS from the standard switch. host The location of the vCenter server. username The username used to login to the vCenter server. password The password used to login to the vCenter server. vmknic_name The name of the virtual NIC to migrate. vmnic_name The name of the physical NIC to migrate. dvs_name The name of the Distributed Virtual Switch. target_portgroup_name The name of the distributed portgroup in which to migrate the virtual NIC. uplink_portgroup_name The name of the uplink portgroup in which to migrate the physical NIC. protocol Optionally set to alternate protocol if the vCenter server or ESX/ESXi host is not using the default protocol. Default protocol is ``https``. port Optionally set to alternate port if the vCenter server or ESX/ESXi host is not using the default port. Default port is ``443``. host_names: An array of VMware host names to migrate verify_ssl Verify the SSL certificate. Default: True CLI Example: .. code-block:: bash salt some_host vsphere.add_host_to_dvs host='vsphere.corp.com' username='administrator@vsphere.corp.com' 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: .. code-block:: yaml 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: .. code-block:: xml <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. Tr� r� r� z.No Distributed Virtual Switch found with name Fz$No target portgroup found with name z$No uplink portgroup found with name zError retrieving hosts: N)r� Zuplinkr� ZvmknicZvmnicr} zHost {1} not found)rK r c r� r3 �r. �r� �x)� vmnic_namer3 r4 r� * r� z#add_host_to_dvs.<locals>.<listcomp>z Physical nic z not foundc r� r3 r r )� vmknic_namer3 r4 r� 1 r� z Virtual nic z-Unable to get the host's virtual nic manager.)Z pnicDeviceZuplinkPortgroupKey)ZpnicSpec�add)rK rU )r� rK )r� zAdding host to the DVSr1 r2 r� zalready existsr z$No matching portgroup on the vSwitch�edit�� portgroupKeyZ switchUuid)ZdistributedVirtualPort)�changeOperationr. r� r� ZvSwitch0)r� )r r@ r� )�backing)r ry r� �remove)r r� )�vswitchZ proxySwitchr� Zvnicr� )Z changeModer� r� z Failed to migrate adapters (�))6r7 r8 re rf Z_get_dvsrU Z_get_dvs_portgroupZ_get_dvs_uplink_portgroupr� ry r� r r� r} r� rY r r} Z HostMemberr; Z _get_pnicsZ _get_vnicsZ_get_vnic_managerZPnicSpecr� Z PnicBacking� ConfigSpecZ DVSConfigSpecr� ZReconfigureDvs_Taskr4 ri ry r� r� Z networkSystem�networkr� r� r@ ZHostVirtualNicConfigr. ZHostVirtualNicSpecZ&DistributedVirtualSwitchPortConnection�distributedVirtualSwitchr" r� ZHostVirtualSwitchConfigZHostVirtualSwitchSpecZHostProxySwitchConfigZHostProxySwitchSpecZHostNetworkConfigZHostPortGroupConfigZUpdateNetworkConfig))rK rL rM r r rQ Ztarget_portgroup_nameZuplink_portgroup_namerN rO r� rS r= rb r} Ztarget_portgroupZuplink_portgroupZdvs_uuidrl r� r� Zdvs_hostmember_configZdvs_hostmemberZp_nicsZp_nicZv_nicsZv_nicZ v_nic_mgrZ dvs_pnic_specZ pnic_backingZdvs_hostmember_config_specrR r8 Znetwork_systemZsource_portgroupZpgZvirtual_nic_configZcurrent_vswitch_portsZvswitch_configZproxyswitch_configZhost_network_configr3 )r r r4 �add_host_to_dvs0 sF 9������� �� ��� � � � ��� ���� � ���� � � �� r' c C s t � }tjj�| �std��d}|dkr2t� \ }}}}}}} } } } tjj�| | �} tjj�| | �}nP|dkrKt � \ }}}}}}} } } tjj�| | �}n7|dkrWtjj� | �}n+|dkr�t d � }d|vrht d��tjjj | |d d �}|s~td �|d ���|d }t�d |� |S )z� Returns the target object of a proxy. If the object doesn't exist a VMwareObjectRetrievalError is raised service_instance Service instance (vim.ServiceInstance) of the vCenter/ESXi host. zB'_get_proxy_target' not supported when connected via the ESXi hostNr- r. r/ r, rF z:Proxies connected directly to ESXi hosts are not supportedru )r� z ESXi host '{}' was not foundr zreference = %s)rE r7 r8 re r� r � _get_esxcluster_proxy_detailsrt ru � _get_esxdatacenter_proxy_detailsZget_root_folderr� r r� r rY r� rI )rb r[ r� rK rL rM rN rO rP rQ rR rm rt r| rW Z referencesr3 r3 r4 rs � sh � � � �� � rs c C sV t d � } | �d�| �d�| �d�| �d�| �d�| �d�| �d�| �d �| �d �f S ) z; Returns the running esxdatacenter's proxy details rH r/ rL rM rN rO rP rQ rR rm �rT rD ��detr3 r3 r4 r) � s �r) c C s^ t d � } | �d�| �d�| �d�| �d�| �d�| �d�| �d�| �d �| �d �| �d �f S ) z8 Returns the running esxcluster's proxy details rG r/ rL rM rN rO rP rQ rR rm rt r* r+ r3 r3 r4 r( � s �r( c C s~ t d � } | �d�}| �d�r| d }d}| �d�r | d g}|| �d�| �d�| �d�| �d �| �d �| �d �| �d �|f S ) z2 Returns the running esxi's proxy details rF rK r/ Nru rL rM rN rO rP rQ rR )r� rD )r, rK r~ r3 r3 r4 �_get_esxi_proxy_details! s" �r- c C s t jjj|| ||||d�}|S )a� Returns vm object properties. name Name of the virtual machine. datacenter Datacenter name vm_properties List of vm properties. traversal_spec Traversal Spec object(s) for searching. parent_ref Container Reference object for searching under a given object. service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. )rm � vm_properties�traversal_specr� )r7 r8 re �get_vm_by_property)r@ rm r. r/ r� rb �virtual_machiner3 r3 r4 �get_vm ! s !�r2 c C s� t jj�� }| }t jj�� g|_tjj� ||�}d|v r'tjj� ||d �}n tjjj |||d gd�} | sAtj � d�|d ���| d }tjj�|||g||�} | rbt| d j�dkrbtj �d��| rm| d jrm| d S dS ) a� Queries the virtual machine config file and returns vim.host.DatastoreBrowser.SearchResults object on success None on failure name Name of the virtual machine datacenter Datacenter name datastore Datastore where the virtual machine files are stored service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. rt rK �r6 r� �"ESXi host named '{}' wasn't found.r r� zEMultiple configuration files found in the same virtual machine folderN)r rK ZDatastoreBrowserZ SearchSpecZ VmConfigQueryr� r7 r8 re rt ru r� r� r rY Zget_datastore_filesrd �fileZVMwareMultipleObjectsError) r@ rm � placementr, rb Z browser_spec� directory�datacenter_object�container_objectZcontainer_objects�filesr3 r3 r4 �get_vm_config_fileI! s4 � � � ��r; r c C sZ t �d| � |dkr t �d| � tj�� }d|_| |_||_dS |dkr+t| �|_ dS dS )a� Specifies vm container version or schedules upgrade, returns True on change and False if nothing have been changed. hardware_version Hardware version string eg. vmx-08 config_spec Configuration spec object operation Defines the operation which should be used, the possibles values: 'add' and 'edit', the default value is 'add' z7Configuring virtual machine hardware version version=%sr z)Scheduling hardware version upgrade to %s�alwaysr N) r� rI r �vmZ ScheduledHardwareUpgradeInfoZ upgradePolicyZ versionKeyZ scheduledHardwareUpgradeInfor5 rY )Zhardware_versionr� rU Zscheduled_hardware_upgrader3 r3 r4 �_apply_hardware_version! s � �r> c C s� t �d|� d|v rt|d �| _d|v r t|d �| _d|v r)|d r)|d | _d|v r6|d r6|d | _d|v rE|d rG|d | _dS dS dS )z� Sets CPU core count to the given value config_spec vm.ConfigSpec object cpu_props CPU properties dict z5Configuring virtual machine CPU settings cpu_props=%s�count�cores_per_socket�nested�hotadd� hotremoveN)r� rI re ZnumCPUsZnumCoresPerSocketZnestedHVEnabledZcpuHotAddEnabledZcpuHotRemoveEnabled)r� Z cpu_propsr3 r3 r4 �_apply_cpu_config�! s �rD c C s� t �d|� d|v rSd|v rSz0|d �� dkr |d d }n |d �� dkr+|d }n|d �� dkr=tt|d �d �}W n ttfyO t|d �}Y nw || _d|v r\|d | _d |v rg|d | _ d S d S ) z� Sets memory size to the given value config_spec vm.ConfigSpec object memory Memory size and unit z5Configuring virtual machine memory settings memory=%s�size�unitZkbr� ZmbZgb�reservation_maxrB N) r� rI r re r� � TypeError� ValueErrorZmemoryMBZ memoryReservationLockedToMaxZmemoryHotAddEnabled)r� �memoryZ memory_mbr3 r3 r4 �_apply_memory_config�! s& �� �rK c C s t | |d|d�}|d S )a& Returns extra config parameters from a virtual machine advanced config list vm_name Virtual machine name datacenter Datacenter name where the virtual machine is available service_instance vCenter service instance for connection and configuration T�rm �objectsrb �advanced_configs)� get_vm_config)�vm_namerm rb �current_configr3 r3 r4 �get_advanced_configs�! s �rR c C s~ t �d|� t|t�rtj�d��|�� D ]'\}}|r.|D ]}|j|kr,|j t|�kr,q q qt j j ||d�}| j �|� qdS )z� Sets configuration parameters for the vm config_spec vm.ConfigSpec object advanced_config config key value pairs vm_extra_config Virtual machine vm_ref.config.extraConfig object z0Configuring advanced configuration parameters %s�cThe specified 'advanced_configs' configuration option cannot be parsed, please check the parametersrE N)r� rI r| r5 r7 r� r r� r� r� r r] rx � extraConfigrU )r� �advanced_config�vm_extra_configr� r� r] r3 r3 r4 �_apply_advanced_config�! s ����rW c C s� t | |d|d�}t| |d�|�}tjj�||�}tjjj|tj| d|d�}tj � � }|d j } t ||d j |jj� | rDtjj�||� d| iS )au Appends extra config parameters to a virtual machine advanced config list vm_name Virtual machine name datacenter Datacenter name where the virtual machine is available advanced_configs Dictionary with advanced parameter key value pairs service_instance vCenter service instance for connection and configuration TrL )r@ rN r@ �Z property_nameZ container_refrN Zadvanced_config_changes)rO �compare_vm_configsr7 r8 re rt �get_mor_by_propertyr �VirtualMachiner= r$ �diffsrW � new_valuesr� rT � update_vm) rP rm rN rb rQ r\ �datacenter_ref�vm_refr� �changesr3 r3 r4 �set_advanced_configs" s, � �� �rb c C sn t �d|� t|t�rtj�d��g }|D ] }|D ]}|j|kr3tj j |dd�}| j � |� |� |� qq|S )z� Removes configuration parameters for the vm config_spec vm.ConfigSpec object advanced_config List of advanced config keys to be deleted vm_extra_config Virtual machine vm_ref.config.extraConfig object z-Removing advanced configuration parameters %srS � rE ) r� rI r| r5 r7 r� r r� r r] rx rT rU )r� rU rV �removed_configsr� r] r3 r3 r4 �_delete_advanced_config." s � ��re c C s` t jj�||�}t jjj|tj| d|d�}tj�� }t |||j j �}|r,t jj� ||� d|iS )a\ Removes extra config parameters from a virtual machine vm_name Virtual machine name datacenter Datacenter name where the virtual machine is available advanced_configs List of advanced config values to be removed service_instance vCenter service instance for connection and configuration r@ rX rd ) r7 r8 re rt rZ r r[ r= r$ re r� rT r^ )rP rm rN rb r_ r` r� rd r3 r3 r4 �delete_advanced_configsK" s � �rf c s4 � �fdd��D �}|st j�d� � d���|d S )z� Returns key number of the SCSI controller keys bus_number Controller bus number from the adapter scsi_ctrls List of SCSI Controller objects (old+newly created) c s g | ] }�r|j � kr|j�qS r3 )� busNumberr� )r� Zctrl�� bus_number� scsi_ctrlsr3 r4 r� " s �z,_get_scsi_controller_key.<locals>.<listcomp>zSCSI controller number z doesn't existr )r7 r� ZVMwareVmCreationError)ri rj r� r3 rh r4 �_get_scsi_controller_keyr" s � �rk �GBc C sF t �d||||||| | � tjj�� } tjj�� | _|| j_| | j_t� � | j_ |r8t j j �||�} | d | j_|r?|| jj _|dusG|durUtjjj�� | j_d| jj_|dur^|| jj_|durk|dkrk|| jj_|rq|| j_|dkr�tjjjjj| _d�t j j �| �| �| jj_ tjjjj j | _ | S |dkr�tjjjjj | _| S ) a� Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit a virtual disk device unit_number Add network adapter to this address key Device key number operation Action which should be done on the device add or edit disk_label Label of the new disk, can be overridden size Size of the disk unit Unit of the size, can be GB, MB, KB controller_key Unique umber of the controller key thin_provision Boolean for thin provision eagerly_scrub Boolean for eagerly scrubbing datastore Datastore name where the disk will be located filename Full file name of the vm disk z|Configuring hard disk %s size=%s, unit=%s, controller_key=%s, thin_provision=%s, eagerly_scrub=%s, datastore=%s, filename=%srE NZ persistent�Noner z[{}] {}r )!r� rI r r= r. �VirtualDeviceSpec� VirtualDiskr� � unitNumber� Description� deviceInfor7 r8 re � convert_to_kb� capacityInKB�labelZFlatVer2BackingInfor ZdiskMode�thinProvisioned� eagerlyScrub� controllerKey� Operationr rU rY r3 �fileNameZ FileOperation�createZ fileOperationr ) � unit_numberr� rU � disk_labelrE rF �controller_key�thin_provision� eagerly_scrubr, �filename� disk_specZ convert_sizer3 r3 r4 �_apply_hard_disk�" sP 2� ��r� rc c C s� t �d|� |dv r9tjj�|�}t| t|��r | }|S | r7t �d| jj t| �j � dd�d dd� � � |� |S | rJ|rFt � d| jj |� | }|S |sRt �d |� tjj�� }|S ) a Returns a vim.vm.device.VirtualEthernetCard object specifying a virtual ethernet card information network_adapter None or VirtualEthernet object adapter_type String, type of adapter network_adapter_label string, network adapter name z;Configuring virtual machine network adapter adapter_type=%s)ZvmxnetZvmxnet2Zvmxnet3Ze1000Ze1000ez'Changing type of '%s' from '%s' to '%s'r� r� r Nz5Cannot change type of '%s' to '%s'. Not changing typezKThe type of '%s' has not been specified. Creating of default type 'vmxnet3')r� rI r7 r8 re Zget_network_adapter_typer| r� rr ru rZ �rsplitr r� r r= r. ZVirtualVmxnet3)Znetwork_adapter� adapter_type�network_adapter_labelZedited_network_adapterr3 r3 r4 �_create_adapter_type�" sD �� � ��� �� r� c C s� t �d| |tjj�|�� i }| rr|dkr>tjjj|| gd�}|s+tj�d| � d���|d }t j j j � � }| |_||_|S |dkrrtjjj|| gd�}|sXtj�d | � d���|d }t jj|j|jjjd �}t j j j �� }||_|S ) a Returns a vim.vm.device.VirtualDevice.BackingInfo object specifying a virtual ethernet card backing information network_name string, network name switch_type string, type of switch parent_ref Parent reference to search for network zTConfiguring virtual machine network backing network_name=%s switch_type=%s parent=%s�standard)Z network_namesz The network 'z' could not be retrieved.r � distributedr� zThe port group 'r )r� rI r7 r8 re r3 Z get_networksr� r r r= r. �VirtualEthernetCard�NetworkBackingInfoZ deviceNamer% r� r} ZPortConnectionr� r� r& ry �!DistributedVirtualPortBackingInforO )� network_name� switch_typer� r Znetworks� network_refZdvs_port_connectionr3 r3 r4 �_create_network_backing# sL �� ��� �� �r� c C s |� � �� |� � �� t�d|||||� tjj�� } t| j||d�| _t� � | j_ |dkr8tjjjj j | _ n |dkrDtjjjj j| _ |rU|rUt|||�| j_|| jj _| r[| | j_|rb|| jj _|rl|| j_d| j_d| j_|r�tjjj�� | j_|d | jj_|d | jj_| S ) ac Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit a network device network_adapter_label Network adapter label key Unique key for device creation network_name Network or port group name adapter_type Type of the adapter eg. vmxnet3 switch_type Type of the switch: standard or distributed operation Type of operation: add or edit connectable Dictionary with the device connection properties mac MAC address of the network adapter parent Parent object reference zzConfiguring virtual machine network adapter network_adapter_label=%s network_name=%s adapter_type=%s switch_type=%s mac=%s)r� r r ZManualT�start_connected�allow_guest_control) r� r r� rI r r= r. rn r� rq rr ry r rU r r� r r r� ru � macAddressZ addressTypeZwakeOnLanEnabled� VirtualDevice� ConnectInfo� connectable�startConnected�allowGuestControl) r� r� r� r� r� rU r� �mac�parent� network_specr3 r3 r4 � _apply_network_adapter_configQ# sN * � � � �r� c C sJ t �d| ||||� tjj�� }|dkr d}tjj�� |_n)|dkr,d}tjj�� |_n|dkr:d}tjj�� |_n |dkrGd }tjj� � |_|d krTtjjjj j |_ n |d kr`tjjjj j |_ ||j_||j_t�� |j_| |jj_||jj_|d kr�tjjjjj|j_|S |d kr�tjjjjj|j_|S |dkr�tjjjjj|j_|S )a� Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit a SCSI controller adapter SCSI controller adapter name adapter_type SCSI controller adapter type eg. paravirtual bus_sharing SCSI controller bus sharing eg. virtual_sharing key SCSI controller unique key bus_number Device bus number property operation Describes the operation which should be done on the object, the possibles values: 'add' and 'edit', the default value is 'add' .. code-block:: bash scsi: adapter: 'SCSI controller 0' type: paravirtual or lsilogic or lsilogic_sas bus_sharing: 'no_sharing' or 'virtual_sharing' or 'physical_sharing' zZConfiguring scsi controller adapter=%s adapter_type=%s bus_sharing=%s key=%s bus_number=%s�lsilogicz LSI Logic� lsilogic_sasz LSI Logic Sas� paravirtualzVMware paravirtual SCSI�buslogicz Bus Logicr r �virtual_sharing�physical_sharing� no_sharing)r� rI r r= r. rn �VirtualLsiLogicController� VirtualLsiLogicSASController�ParaVirtualSCSIController�VirtualBusLogicControllerry r rU r r� rg rq rr ru r �VirtualSCSIControllerZSharing�virtualSharing� sharedBus�physicalSharing� noSharing)�adapterr� � bus_sharingr� ri rU � scsi_specr r3 r3 r4 �_apply_scsi_controller�# sT !� � � �� �r� c C sf g }t ddd�}| r1dd� | D �}t�d|� t| |�D ]\}}|�t|d d|t|d ��� q |S ) z� Returns a list of vim.vm.device.VirtualDeviceSpec objects representing IDE controllers ide_controllers IDE properties i8���i���rw c S � g | ]}|d �qS �r� r3 )r� �ider3 r3 r4 r� $ r� z+_create_ide_controllers.<locals>.<listcomp>zCreating IDE controllers %sr� r r� )r� r� rI �ziprU � _apply_ide_controller_config�abs)�ide_controllersZ ide_ctrlsr� �devsr� r� r3 r3 r4 �_create_ide_controllers�# s �r� c C s� t �d| � tjj�� }tjj�� |_|dkr tjjjjj|_ |dkr+tjjjjj |_ ||j_ ||j_ | rEt� � |j_| |jj_| |jj_|S )a@ Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit an IDE controller ide_controller_label Controller label of the IDE adapter operation Type of operation: add or edit key Unique key of the device bus_number Device bus number property z2Configuring IDE controller ide_controller_label=%sr r )r� rI r r= r. rn ZVirtualIDEControllerry r rU r r� rg rq rr ru r )Zide_controller_labelrU r� ri Zide_specr3 r3 r4 r� $ s � r� c C sb g }t ddd�}| r/dd� | D �}t�d|� t| |�D ]\}}|�t|d d||d �� q |S ) z� Returns a list of vim.vm.device.VirtualDeviceSpec objects representing SATA controllers sata_controllers SATA properties ih��i6��rw c S r� r� r3 )r� �satar3 r3 r4 r� <$ r� z,_create_sata_controllers.<locals>.<listcomp>z Creating SATA controllers %sr� r ri )r� r� rI r� rU � _apply_sata_controller_config)�sata_controllersZ sata_ctrlsr� r� r� r� r3 r3 r4 �_create_sata_controllers1$ s ��r� c C s� t �d| � tjj�� }tjj�� |_|dkr tjjjjj|_ n |dkr,tjjjjj |_ ||j_ d|j_ ||j_ | rJt�� |j_| |jj_| |jj_|S )aB Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit a SATA controller sata_controller_label Controller label of the SATA adapter operation Type of operation: add or edit key Unique key of the device bus_number Device bus number property z4Configuring SATA controller sata_controller_label=%sr r �d )r� rI r r= r. rn ZVirtualAHCIControllerry r rU r r� rx rg rq rr ru r )Zsata_controller_labelrU r� ri Z sata_specr3 r3 r4 r� G$ s" � r� r� c C s� t �d| |||� tjj�� } tjj�� | _t�� | j_|dkr)tjjjj j | _ n |dkr5tjjjj j | _ |dkr{tjjj� � | j_|d | jj_|d �d�d �d�d } tjjjtjj�|�|| gd �d } | rp| | jj_d �|d �| jj_n#|d kr�|d dkr�tjjj�� | j_n|d dkr�tjjj�� | j_|| j_ | | jj_ || j_ tjjj � � | j_!|r�|d | jj!_"|d | jj!_#| S )a� Returns a vim.vm.device.VirtualDeviceSpec object specifying to add/edit a CD/DVD drive drive_label Leble of the CD/DVD drive key Unique key of the device device_type Type of the device: client or iso operation Type of operation: add or edit client_device Client device properties datastore_iso_file ISO properties connectable Connection info for the device controller_key Controller unique identifier to which we will attach this device parent_ref Parent object .. code-block:: bash cd: adapter: "CD/DVD drive 1" device_type: datastore_iso_file or client_device client_device: mode: atapi or passthrough datastore_iso_file: path: "[share] iso/disk.iso" connectable: start_connected: True allow_guest_control: z]Configuring CD/DVD drive drive_label=%s device_type=%s client_device=%s datastore_iso_file=%sr r �datastore_iso_file�path�[rw �]r r( z{}� client_device�mode� passthrough�atapir� r� )$r� rI r r= r. rn � VirtualCdromrq rr ry r rU r �IsoBackingInfor rz r� � rpartitionr7 r8 re r+ rb r, rY r � RemotePassthroughBackingInfo�RemoteAtapiBackingInfor� ru rx r� r� r� r� r� ) Z drive_labelr� � device_typerU r� r� r� r~ r� Z drive_specr, �datastore_objectr3 r3 r4 �_apply_cd_drivek$ sZ 7� �� � � �r� c C sp t jj�� }||_t jj�� |_| r| |j_|r ||j_|r.t jjj |d�|j_ ||j_ |S t jj� � |j_ |S )a4 Returns a vim.vm.customization.AdapterMapping object containing the IP properties of a network adapter card domain Domain of the host gateway Gateway address ip_addr IP address subnet_mask Subnet mask mac MAC address of the guest )Z ipAddress) r r= Z customizationZAdapterMappingr� Z IPSettingsr� Z dnsDomain�gatewayZFixedIpr� Z subnetMaskZDhcpIpGenerator)rR r� �ip_addr� subnet_maskr� �adapter_mappingr3 r3 r4 � _set_network_adapter_mapping�$ s �r� c C s� t �d| d | d | d | d � tjj�� }tjj�� |_|dkr+tjjjjj|_ n |dkr7tjjjjj |_ tjjj � � }d}| d d kr�tjjj� � }d | d �� vrYtd ��d | d �� vretd ��d| d �� vrqtd��| d d |_| d d |_| d d |_| d dkr�tjjj�� }| d dkr�tjjj�� }| d dkr�tjjj�� }| d d |_| d d |_||j_||j_d|j_||j_| d |j_ |S )ap Returns a vim.vm.device.VirtualSerialPort representing a serial port component serial_device_spec Serial device properties key Unique key of the device operation Add or edit the given device .. code-block:: bash serial_ports: adapter: 'Serial port 1' backing: type: uri uri: 'telnet://something:port' direction: <client|server> filename: 'service_uri' connectable: allow_guest_control: True start_connected: True yield: False z?Creating serial port adapter=%s type=%s connectable=%s yield=%sr� r� r� �yieldr r Nr% �urir z&vSPC proxy URI not specified in configz&vSPC Direction not specified in configr� z%vSPC Filename not specified in config� direction�piper5 r. r� r� r� ) r� rI r r= r. rn �VirtualSerialPortry r rU r r� r� �URIBackingInfor� rI �proxyURIr� � serviceURI�PipeBackingInfo�FileBackingInfo�DeviceBackingInfor� r� r r� rp r� � yieldOnPoll)Zserial_device_specr� rU � device_specZ connect_infoZ type_backingr3 r3 r4 �_apply_serial_port�$ sT � � r� c C s� g }t ddd�}|rdd� |D �}t�d|� t||�D ]�\}}d\} } } t|d �} d } d |v rI|d �d �\}}t|�}t|�}t||d �} n"d |v rk|D ]}|d |d kr_|d } n qOtj � d� |d ���d|v r�tj j j| ||d gd�d } |d } d|v r�|d } | s�| s�| r�| s�tj �d� | | ���t|||d | |d | d|d d|v r�|d nd| | d � }|�|� |d 7 }q |S ) a� Returns a list of disk specs representing the disks to be created for a virtual machine service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. disks List of disks with properties scsi_controllers List of SCSI controllers parent Parent object reference .. code-block:: bash disk: 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' i0���i����rw c S r� r� r3 �r� r� r3 r3 r4 r� a% r� z!_create_disks.<locals>.<listcomp>zCreating disks %s�NNNrE i� �addressr� )rj � controllerru r� z'The given controller does not exist: {}r, r( r r� ziYou must specify both filename and datastore attributes to place your disk to a specific datastore {}, {}r� rF r r r� N) r} rE rF r~ rU r r� r, r� r� )r� r� rI r� r� r� re rk r7 r� �VMwareObjectNotFoundErrorrY r8 re r+ r r� rU )rb r� �scsi_controllersr� � disk_specsr� r� r� r� r� r, Z datastore_refrE r~ Zcontroller_bus_numberr| Zcontrr� r3 r3 r4 � _create_disks?% sn �� � ���� r� c C sr t ddd�}g }| r7dd� | D �}t�d|� t|| �D ]\}}t|d |d |d ||d d �}|�|� q |S ) z� Returns a list of vim.vm.device.VirtualDeviceSpec objects representing SCSI controllers scsi_devices: List of SCSI device properties i���i��rw c S r� r� r3 �r� Zscsir3 r3 r4 r� �% r� z(_create_scsi_devices.<locals>.<listcomp>zCreating SCSI devices %sr� r� r� ri r )r� r� rI r� r� rU )� scsi_devicesr� � scsi_specsr� r� Zscsi_controllerr� r3 r3 r4 �_create_scsi_devices�% s � r� c C s� g }g }t ddd�}| rjdd� | D �}t�d|� t| |�D ]K\}}t||d |d |d |d d d |v r9|d nd |d |d� }|�|� d|v rit|d d |d d |d d |d d |d �} |�| � q ||fS )a Returns a list of vim.vm.device.VirtualDeviceSpec objects representing the interfaces to be created for a virtual machine network_interfaces List of network interfaces and properties parent Parent object reference .. code-block:: bash 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' i`�i.�rw c S r� r� r3 �r� Zinterr3 r3 r4 r� �% r� z,_create_network_adapters.<locals>.<listcomp>z Creating network interfaces %sr@ r� r� r� r r� Nr� )r� rU r� r� r� �mappingrR r� r� r� )r� r� rI r� r� rU r� ) Znetwork_interfacesr� Z network_specsZ nics_settingsr� r� � interfacer� r� r� r3 r3 r4 �_create_network_adapters�% s< � � �r� c C s\ g }t ddd�}| r,dd� | D �}t�d|� t| |�D ]\}}t||d�}|�|� q |S )z� Returns a list of vim.vm.device.VirtualDeviceSpec objects representing the serial ports to be created for a virtual machine serial_ports Serial port properties i���i���rw c S r� r� r3 �r� �serialr3 r3 r4 r� �% r� z(_create_serial_ports.<locals>.<listcomp>zCreating serial ports %sr )r� r� rI r� r� rU )� serial_portsZportsr� r� rO r� Zserial_port_devicer3 r3 r4 �_create_serial_ports�% s r� c C s� g }t ddd�}| r[dd� | D �}t�d|� t| |�D ]>\}}d}|r.t||d �} | j}|�t|d ||d d d |v rA|d nd d|v rJ|d nd d|v rS|d nd ||d� � q |S )a' Returns a list of vim.vm.device.VirtualDeviceSpec objects representing the CD/DVD drives to be created for a virtual machine cd_drives CD/DVD drive properties controllers CD/DVD drive controllers (IDE, SATA) parent_ref Parent object reference iH�i�rw c S r� r� r3 )r� Zdvdr3 r3 r4 r� & r� z%_create_cd_drives.<locals>.<listcomp>zCreating cd/dvd drives %sr� r� r� r� r r� Nr� r� �r� r� r� r~ r� )r� r� rI r� �_get_device_by_labelr� rU r� ) � cd_drives� controllersr� �cd_drive_specsr� r� �driver� r~ r� r3 r3 r4 �_create_cd_drives & s4 ���r� c �2 � fdd�| D �}|r|d S t j�d� � d���)z� Returns the device with the given key, raises error if the device is not found. devices list of vim.vm.device.VirtualDevice objects key Unique key of device c r� r3 r� r� r� r3 r4 r� >& r� z&_get_device_by_key.<locals>.<listcomp>r z'Virtual machine device with unique key � does not exist�r7 r� r� )�devicesr� Z device_keysr3 r� r4 �_get_device_by_key3& � �r c r� )z� Returns the device with the given label, raises error if the device is not found. devices list of vim.vm.device.VirtualDevice objects key Unique key of device c s g | ] }|j j� kr|�qS r3 )rr ru r� �ru r3 r4 r� R& s z(_get_device_by_label.<locals>.<listcomp>r z"Virtual machine device with label r� r� )r ru Z device_labelsr3 r r4 r� G& r r� c C sD | r | D ]}d|v r d|v r |� tjj�|d |d �� qdS dS )z Updates the size and unit dictionary values with the new unit values devices List of device data objects rF rE FT)r} r7 r8 re rs )r r. r3 r3 r4 �_convert_units[& s ���r c C s( i }t | �� �}|�d� |�d� |�d� dD ] }||v r8t||| i|| | i�}|jr3|||< |�|� qd|v rR|�d� t|d | d �}|jrR||d< d|v ry|�d� t|d g� t| d g� t|d | d �}|jry||d< d|v r�|�d� d}t|| | | �} | jr�| ||< d|v r�|�d� t|d � t| d � t|d | d d �} | jd d � | jd d � | jd d � | jr�| |d< d|v r�|�d� t|d | d d�} | jd d � | jr�| |d< |D ]#}||vs�|| vr�t d� |���t|| | | d �} | j�r| ||< q�|S )a� 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 new_config: New config dictionary with every available parameter current_config Currently deployed configuration r@ rm r, )rY �image�cpurJ rN r� r� r� )�diff_keyr� r� � interfacesr� zdA general device {} configuration was not supplied or it was not retrieved from remote configuration) r� r� �discardr r\ r! r r � remove_diffrI rY ) Z new_configrQ r\ r� Z property_keyZsingle_value_diffZcpu_diffZ memory_diffr� Z advanced_diffZ disk_diffsZinterface_diffsZ device_diffsr3 r3 r4 rY m& s| � � � ��rY c C sj g d�}t jjj|| ||d�}t jjj||d�}d| i}|d |d |d |d |d d �|d < |d d |d |d d�|d< |d |d< |d |d< i |d< |d D ] }z t|j�|d |j< W qS tyr |j|d |j< Y qSw g |d< g |d< g |d< g |d< g |d < g |d < |d D �]�} t | t j j j ��ri } | jj| d < | j| d < | j} | d!kr�d"| d#< n| d$kr�d%| d#< n| d&kr�d'| d#< t | t j j j�r�d(| d)< n&t | t j j j�r�d*| d)< nt | t j j j�r�d+| d)< n t | t j j j�r�d,| d)< |�r | j | d-< | j| d.< | | d/< |d �| � t | t j j j��ri } | jj| d < | j| d0< d1| d2< t|d | j�} | jj| d3< t| j�d4 t| j � | d5< t jj� | j j �| d6< | j j | d7< | j j!| d8< |�rx| j| d.< | j | d9< | j| d < | j| d:< | | d/< |d �| � t | t j j j"��r�i } | jj| d < t jj�#| �| d;< | j$j%| j$j&| j$j'd<�| d=< | j(| d>< t | j t j j j"j)��r�d?| d@< | j j*j+}t jjj,|t j-|d.|dA�}nt | j t j j j"j.��r�dB| d@< | j j/}t jj� |�| d< |�r�| j| d.< | | d/< |d �| � t | t j j j0��r�i }| jj|d < t|d | j�} | jj|d3< t | j t j j j0j1��r1dC|dD< dEdFi|dC< t | j t j j j0j2��rFdC|dD< dEdGi|dC< t | j t j j j0j3��r]dH|dD< dI| j j4i|dH< | j$j%| j$j&| j$j'd<�|d=< |�r|| j|d.< | j|d:< | |d/< |d �|� t | t j j j5��ri }| jj|d < t | j t j j j5j6��r�dJ|d)< | j j7| j j8| j j9dK�|dL< t | j t j j j5j:��r�dM|d)< t | j t j j j5j;��r�dN|d)< t | j t j j j5j<��r�d-|d)< | j=|dO< | j$j%| j$j&| j$j'd<�|d=< |�r�| j|d.< | |d/< |d �|� t | t j j j>��r2i }| jj|d < | j|d < |�r+| j |d-< | j|d.< | |d/< |d �|� q�|S )Pa� 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. name Name of the virtual machine datacenter Datacenter's name where the virtual machine is available objects Indicates whether to return the vmware object properties (eg. object, key) or just the properties which can be set service_instance vCenter service instance for connection and configuration ) �config.hardware.device�config.hardware.numCPU�!config.hardware.numCoresPerSocket�config.nestedHVEnabled�config.cpuHotAddEnabled�config.cpuHotRemoveEnabled�config.hardware.memoryMB�#config.memoryReservationLockedToMax�config.memoryHotAddEnabled�config.version�config.guestId�config.extraConfigr@ )r. rm )rb r6 r@ r r r r r )r? r@ rA rB rC r r ZMBr r )rE rF rG rB rJ r r r rY rN r r� r� r r� r� r� r r� ri r� r� r� r� r� r� r� r� r� r� r� r� r. r� �objectrE ZKBrF r� r� r� r, r r� r| r~ r� )r� � connectedr� r� r� r� r� rX r� r� r� r� r� r� r� r� r% )r� r� r� r r� r5 r� )?r7 r8 re r0 rt re r� r� rI r| r r= r. r� rr ru rg r� r� r� r� r� rU ro rt r rx r5 rp r3 r r, rv rw r� Z get_network_adapter_object_typer� r� r r� r� r� rO r rZ ZDistributedVirtualPortgroupr� r% r� r� r� r� rz r� r� r� r� r� r� r� r� r� ZVirtualSATAController)r@ rm rM rb r9 r1 r� rQ Z extra_confr. r� r� r� r� Zpg_keyr� r� rO r� r3 r3 r4 rO �& st �� � � � � � � � � �� � � � � � ���� � �rO c C s� g }| rwdd� | D �}t �d|� | D ]c}|d }|d }t||�}d|_|�� rv|d |d k rEtj�d�|d |d |d |d ���t �d |d |d |d |d � t |d |d d|d |d |d d�}|d j |j _ |� |� q|S )aC Changes the disk size and returns the config spec objects in a list. The controller property cannot be updated, because controller address identifies the disk by the unit and bus number properties. disks_diffs List of old and new disk properties, the properties are dictionary objects c S � g | ]}|d d �qS )�oldr� r3 r� r3 r3 r4 r� �' � z!_update_disks.<locals>.<listcomp>zUpdating disks %sr �newFrE zIDisk cannot be downsized size={} unit={} controller_key={} unit_number={}rF r~ r| zUVirtual machine disk will be updated size=%s unit=%s controller_key=%s unit_number=%sr� r )rE rF r~ r ) r� rI r �ignore_unset_values�changedr7 r� r rY r� r r. rU )Z disks_old_new� disk_changesr� r � current_diskZ next_disk� difference�device_config_specr3 r3 r4 � _update_disks�' sN �� �� �r# c C sR g }| r�dd� | D �}t �d|� | D ]�}|d }|d }t||�}d|_|�� r�t �d|d |d |d |d � |d |d kr�|�t|d �� |�t|d |d |d |d |d d�� g }|d D ]} dd� |D �} |�t| | �� qg|D ]} t j j � � } | | _ d| _ |�| � q{q|�t|d |d |d |d |d d�� q|S )z� Returns a list of vim.vm.device.VirtualDeviceSpec specifying the scsi properties as input the old and new configs are defined in a dictionary. scsi_diffs List of old and new scsi properties c S r �r r� r3 r� r3 r3 r4 r� �' r z(_update_scsi_devices.<locals>.<listcomp>z Updating SCSI controllers %sr r FzWVirtual machine scsi device will be updated key=%s bus_number=%s type=%s bus_sharing=%sr� ri r� r� r r� r r. c S r� �r r3 r� r3 r3 r4 r� ( r� r )r� rI r r r rU �_delete_devicer� r r r= r. rn rU ) Z scsis_old_newZ current_disksZdevice_config_specsr� r Z next_scsiZ current_scsir! Zdisks_to_updateZdisk_keyZ disk_objectsr r� r3 r3 r4 �_update_scsi_devices�' sj ��� � ���� r' c C s� g }| rUdd� | D �}t �d|� | D ]A}|d }|d }t||�}d|_|�� rTt �d|d |d |d |d � t|d |d |d |d d |d |d�}|�|� q|S )a� Returns a list of vim.vm.device.VirtualDeviceSpec specifying configuration(s) for changed network adapters, the adapter type cannot be changed, as input the old and new configs are defined in a dictionary. interface_old_new Dictionary with old and new keys which contains the current and the next config for a network device parent Parent managed object reference c S r )r r� r3 r� r3 r3 r4 r� D( r z,_update_network_adapters.<locals>.<listcomp>z Updating network interfaces %sr r Fz]Virtual machine network adapter will be updated switch_type=%s name=%s adapter_type=%s mac=%sr� r@ r� r� r� r )rU r� r� )r� rI r r r r� rU ) Zinterface_old_newr� �network_changesr� r Zcurrent_interfaceZnext_interfacer! r" r3 r3 r4 �_update_network_adapters5( s: �� �r) c C sr g }| r7dd� | D �}t �d|� | D ]!}|d }|d }t||�}d|_|�� r4|�t||d d�� q|S d S ) a Returns a list of vim.vm.device.VirtualDeviceSpec specifying to edit a deployed serial port configuration to the new given config serial_old_new Dictionary with old and new keys which contains the current and the next config for a serial port device c S r r$ r3 r� r3 r3 r4 r� l( r z(_update_serial_ports.<locals>.<listcomp>zUpdating serial ports %sr r Fr� r N)r� rI r r r rU r� )Zserial_old_new�serial_changesr� r Zcurrent_serialZ next_serialr! r3 r3 r4 �_update_serial_portsa( s ���r+ c C s� g }| rcdd� | D �}t �d|� | D ]O}|d }|d }t||�}d|_|�� rb|r6t||d �} | j} n|d } |�t|d |d |d d d |v rO|d ndd|v rX|d nd|d | |d� � q|S )a� Returns a list of vim.vm.device.VirtualDeviceSpec specifying to edit a deployed cd drive configuration to the new given config drives_old_new Dictionary with old and new keys which contains the current and the next config for a cd drive controllers Controller device list parent Managed object reference of the parent object c S r r$ r3 )r� r� r3 r3 r4 r� �( r z%_update_cd_drives.<locals>.<listcomp>zUpdating cd/dvd drives %sr r Fr� r~ r� r� r� r r� Nr� r� r� ) r� rI r r r r� r� rU r� ) Zdrives_old_newr� r� � cd_changesr� r Z current_driveZ new_driver! r� r~ r3 r3 r4 �_update_cd_drivesz( sF ������r- c C s6 t �dt| �� tjj�� }tjjjjj|_ | |_|S )z� Returns a vim.vm.device.VirtualDeviceSpec specifying to remove a virtual machine device device Device data type object z Deleting device with type %s) r� rI r� r r= r. rn ry r! rU )r. r� r3 r3 r4 r& �( s r& c C s� d}| r|r|st d � }|d } |d }|d }|du r2|du r&t d � }|�dd�}|du r2d}|du rE|du r?t d � }|�dd�}|d u rT|durTt�d � d S |r_tjj�d|i�}tjjj | ||||d �}|S ) aJ Establish client through proxy or with user provided credentials. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :returns: vSphere Client instance. :rtype: vSphere.Client NrI r/ rL rM rS T� ca_bundleFz5Cannot set verify_ssl to False and ca_bundle together)r� rL rM rS r. ) rT rD r� r� r7 r8 r� Z get_ca_bundlere Zget_vsphere_client)r� rL rM rS r. rW �clientr3 r3 r4 � _get_client�( s: �r0 c C �. d}t | ||||d�}|r|jj�� }d|iS )a� List existing categories a user has access to. CLI Example: .. code-block:: bash salt vm_minion vsphere.list_tag_categories :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :returns: Value(s) of category_id. :rtype: list of str N�rS r. Z Categories)r0 �taggingr rg )r� rL rM rb rS r. � categoriesr/ r3 r3 r4 �list_tag_categories�( � $ � r5 c C r1 )a� List existing tags a user has access to. CLI Example: .. code-block:: bash salt vm_minion vsphere.list_tags :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :return: Value(s) of tag_id. :rtype: list of str Nr2 ZTags)r0 r3 r! rg )r� rL rM rb rS r. �tagsr/ r3 r3 r4 � list_tags*) r6 r8 �ClusterComputeResourcec C sn d} t |||||d�} | r3t|| d�} z| jjj|| d�} W d| iS ty2 t�d� Y d| iS w d| iS )a� Attach an existing tag to an input object. The tag needs to meet the cardinality (`CategoryModel.cardinality`) and associability (`CategoryModel.associable_types`) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this method is a no-op and an error will not be thrown. To invoke this method, you need the attach tag privilege on the tag and the read privilege on the object. CLI Example: .. code-block:: bash salt vm_minion vsphere.attach_tag domain-c2283 urn:vmomi:InventoryServiceTag:b55ecc77-f4a5-49f8-ab52-38865467cfbe:GLOBAL :param str object_id: The identifier of the input object. :param str tag_id: The identifier of the tag object. :param str managed_obj: Classes that contain methods for creating and deleting resources typically contain a class attribute specifying the resource type for the resources being created and deleted. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :return: The list of all tag identifiers that correspond to the tags attached to the given object. :rtype: list of tags :raise: Unauthorized if you do not have the privilege to read the object. :raise: Unauthenticated if the user can not be authenticated. Nr2 �r� r )�tag_id� object_idzMUnable to attach tag. Check user privileges and object_id (must be a string).z Tag attached)r0 r) r3 r" �attach�vsphere_errorsr� r ) r< r; � managed_objr� rL rM rb rS r. Z tag_attachedr/ � dynamic_idr3 r3 r4 � attach_tagX) s$ < � � ���rA c C sj d}t |||||d�} | r1t|| d�} z | jj�| �}W d|iS ty0 t�d� Y d|iS w d|iS )a� List existing tags a user has access to. CLI Example: .. code-block:: bash salt vm_minion vsphere.list_attached_tags domain-c2283 :param str object_id: The identifier of the input object. :param str managed_obj: Classes that contain methods for creating and deleting resources typically contain a class attribute specifying the resource type for the resources being created and deleted. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :return: The list of all tag identifiers that correspond to the tags attached to the given object. :rtype: list of tags :raise: Unauthorized if you do not have the privilege to read the object. :raise: Unauthenticated if the user can not be authenticated. Nr2 r: zUUnable to list attached tags. Check user privileges and object_id (must be a string).z Attached tags)r0 r) r3 r" �list_attached_tagsr> r� r ) r< r? r� rL rM rb rS r. Z attached_tagsr/ r@ r3 r3 r4 rB �) s 1 � ���rB c C s� d} t |||||d�} | rT|dkrtjj}n |dkr tjj}nd}| jj�� } | | _|| _ || _ t � } | | _ z | jj� | �} W d| iS tyS t�d� Y d| iS w d| iS )a� Create a category with given cardinality. CLI Example: .. code-block:: bash salt vm_minion vsphere.create_tag_category :param str name: Name of tag category to create (ex. Machine, OS, Availability, etc.) :param str description: Given description of tag category. :param str cardinality: The associated cardinality (SINGLE, MULTIPLE) of the category. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :return: Identifier of the created category. :rtype: str :raise: AlreadyExists if the name` provided in the create_spec is the name of an already existing category. :raise: InvalidArgument if any of the information in the create_spec is invalid. :raise: Unauthorized if you do not have the privilege to create a category. Nr2 �SINGLE�MULTIPLEzOUnable to create tag category. Check user privilege and see if category exists.zCategory created)r0 r Z CardinalityrC rD r3 r � CreateSpecr@ rC � cardinalityr� �associable_typesr{ r> r� r ) r@ rC rF r� rL rM rb rS r. Zcategory_createdr/ � create_specrG r3 r3 r4 �create_tag_category�) s4 4 � ���rI c C �^ d}t |||||d�}|r+z |jj�| �}W d|iS ty* t�d� Y d|iS w d|iS )a� Delete a category. CLI Example: .. code-block:: bash salt vm_minion vsphere.delete_tag_category :param str category_id: The identifier of category to be deleted. The parameter must be an identifier for the resource type: ``com.vmware.cis.tagging.Category``. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :raise: NotFound if the tag for the given tag_id does not exist in the system. :raise: Unauthorized if you do not have the privilege to delete the tag. :raise: Unauthenticated if the user can not be authenticated. Nr2 zOUnable to delete tag category. Check user privilege and see if category exists.zCategory deleted)r0 r3 r �deleter> r� r ) � category_idr� rL rM rb rS r. Zcategory_deletedr/ r3 r3 r4 �delete_tag_categoryI* s + � ���rM c C s| d} t |||||d�} | r:| jj�� } | | _|| _|| _z | jj�| �} W d| iS ty9 t � d� Y d| iS w d| iS )aa Create a tag under a category with given description. CLI Example: .. code-block:: bash salt vm_minion vsphere.create_tag :param basestring server: Target DNS or IP of vCenter client. :param basestring username: Username associated with the vCenter client. :param basestring password: Password associated with the vCenter client. :param str name: Name of tag category to create (ex. Machine, OS, Availability, etc.) :param str description: Given description of tag category. :param str category_id: Value of category_id representative of the category created previously. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :return: The identifier of the created tag. :rtype: str :raise: AlreadyExists if the name provided in the create_spec is the name of an already existing tag in the input category. :raise: InvalidArgument if any of the input information in the create_spec is invalid. :raise: NotFound if the category for in the given create_spec does not exist in the system. :raise: Unauthorized if you do not have the privilege to create tag. Nr2 zFUnable to create tag. Check user privilege and see if category exists.z Tag created) r0 r3 r! rE r@ rC rL r{ r> r� r ) r@ rC rL r� rL rM rb rS r. Z tag_createdr/ rH r3 r3 r4 � create_tag�* s& 7 � ���rN c C rJ )a Delete a tag. CLI Example: .. code-block:: bash salt vm_minion vsphere.delete_tag :param str tag_id: The identifier of tag to be deleted. The parameter must be an identifier for the resource type: ``com.vmware.cis.tagging.Tag``. :param basestring server: Target DNS or IP of vCenter center. :param basestring username: Username associated with the vCenter center. :param basestring password: Password associated with the vCenter center. :param boolean verify_ssl: Verify the SSL certificate. Default: True :param basestring ca_bundle: Path to the ca bundle to use when verifying SSL certificates. :raise: AlreadyExists if the name provided in the create_spec is the name of an already existing category. :raise: InvalidArgument if any of the information in the create_spec is invalid. :raise: Unauthorized if you do not have the privilege to create a category. Nr2 zJUnable to delete category. Check user privileges and that category exists.z Tag deleted)r0 r3 r! rK r> r� r ) r; r� rL rM rb rS r. Z tag_deletedr/ r3 r3 r4 � delete_tag�* s , � ���rO c " C sJ t jj�||�}t jjj|||d�\}}t jj�|||�}tj�� }| |_ ||_ tj� � |_ t jjj |||gd�d }|sGt j�d|� d���z*t jj�|d�}d|v rh|d dkrht�d� d |� d �|j _nd �|| �|j _W n t jjy� d �|| �|j _Y nw g }|r�t||d � |r�t||� |r�t||� | r�t| �}|j�|� | r�d d� |D �}t || ||d�}|j�|� |r�t ||d�\} } |j�| � | r�t | �} |j�| � | r�t | �} |j�| � |�| � | r�t | �} |j�| � |�| � |�rt!|||d�}!|j�|!� |�rt"||� t jj�#| ||||� ddiS )a� Creates a virtual machine container. CLI Example: .. code-block:: bash salt vm_minion vsphere.create_vm vm_name=vmname cpu='{count: 2, nested: True}' ... vm_name Name of the virtual machine cpu Properties of CPUs for freshly created machines memory Memory size for freshly created machines image Virtual machine guest OS version identifier VirtualMachineGuestOsIdentifier version Virtual machine container hardware version datacenter Datacenter where the virtual machine will be deployed (mandatory) datastore Datastore where the virtual machine files will be placed placement Resource pool or cluster or host or folder where the virtual machine will be deployed devices interfaces .. code-block:: bash 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 .. code-block:: bash 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 .. code-block:: bash scsi_devices: controller: 'SCSI controller 0' type: paravirtual bus_sharing: no_sharing serial_ports .. code-block:: bash 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 .. code-block:: bash 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 advanced_config Advanced config parameters to be set for the virtual machine )r6 r( r zSpecified datastore: 'z' does not exist.z summary.typer: zIThe vmPathName should be the datastore name if the datastore type is vsanr� r� z[{0}] {1}/{1}.vmxr c S r� r3 r )r� r� r3 r3 r4 r� �+ r� z create_vm.<locals>.<listcomp>�r� r� )r� �r� r� � create_vmT)$r7 r8 re rt � get_placementZ get_folderr r= r$ r@ �guestIdZFileInfor: r+ r� r rv r� rI Z vmPathNamerY r r> rD rK r� � deviceChanger� r� r� r� r� r� r� rW rR )"rP r rJ r rY rm r, r6 r r� r� r� r� r� r� rN rb r9 �resourcepool_object�placement_objectZ folder_objectr� r� Z ds_summaryZcd_controllersr� r� r� Zinterface_specsZ nic_settingsZserial_port_specsZ ide_specs� sata_specsr� r3 r3 r4 rR + s� �� �� ������ � � � �rR c % C s^ t | | d|d�}t| ||||||||| | | | | d�|�}tj�� }tjj�|| �}tjjj |tj | d|d�}|� � }d|v rO|d � � t � krOt||d j� d|v rd|d � � t � krdt||d j� d|v rst||d j|jj� d |v r}t||d � d |v r�||_g }d |v r�d |v r�g }|�t|d j|d �� |d jD ] }|�t |d �� q�t |d j �}|�|� |j �|� d |v �r g }|�t |d j�� |d jD ] }|�t |d �� q�dd� |d D �}|�dd� |D �� |�t!||d j ||d�� |j �|� d|v �rBg }|�t"|d j|�� |d jD ] }|�t |d �� �q t#|d j |�\}} |�|� |j �|� d|v �rug } | �t$|d j�� |d jD ] }| �t |d �� �qX| �t%|d j �� |j �| � g } d|v �r�t&|d j �} |d jD ] }| �t |d �� �q�| �| � |j �| � d|v �r�g } dd� |d D �}!|!�dd� | D �� | �t'|d j|!|d�� |d jD ] }| �t |d �� �q�| �t(|d j |!|d�� |j �| � |�r�tjj�)||� i }"|�*� D ]/\}#}$t+|$tjj,j-��r&|$j.ddd � |$j.d dd � |$j.dd d � |$j.d d d � |$j/|"|#< �q�|"S ) a Updates the configuration of the virtual machine if the config differs vm_name Virtual Machine name to be updated cpu CPU configuration options memory Memory configuration options version Virtual machine container hardware version image Virtual machine guest OS version identifier VirtualMachineGuestOsIdentifier interfaces Network interfaces configuration options disks Disks configuration options scsi_devices SCSI devices configuration options serial_ports Serial ports configuration options datacenter Datacenter where the virtual machine is available datastore Datastore where the virtual machine config files are available cd_dvd_drives CD/DVD drives configuration options advanced_config Advanced config parameters to be set for the virtual machine service_instance vCenter service instance for connection and configuration TrL )r@ r rJ r rY r r� r� r� rm r, r� r� rN r@ rX r rJ rN rY r r r� r� r c S r� r% r3 �r� �devr3 r3 r4 r� n, r� z update_vm.<locals>.<listcomp>c S r� r3 r �r� r� r3 r3 r4 r� p, r� rP r r� r� r� c S r� r% r3 rY r3 r3 r4 r� �, r� c S r� r3 r r[ r3 r3 r4 r� �, r� )r� r� rQ � intersect)r Z diff_listr� �removed)0rO rY r r= r$ r7 r8 re rt rZ r[ r� r r� rD Z current_dictrK rW r] r� rT r> rT r� r' r\ r] rU r& r� ZaddedrU r# r� r) r� r+ r� r� r- r� r^ r� r| Z listdifferZListDictDifferr r\ )%rP r rJ r rY r r� r� r� rm r, Z cd_dvd_drivesr� rN rb rQ r\ r� r_ r` Zdifference_keysZnew_scsi_devicesZ scsi_changesr r r� r( ZadaptersZnicsr* Znew_controllersrX r, r� ra r� r9 r3 r3 r4 r^ �+ s C��� �� �� ��� � � ���� r^ c C sT t �d|||� tjj�||�}d|v rBtjj�||d �}tjjj|dgd�}d|v r1|d }ntj� d��tjj� || ||� n_d|v r�tjjj |||d gd�} | s`tj� d� |d ���| d } tjjj| d gd�} d | v r�| d } tjjj| d gd�} d | v r�| d }n tj� d ��tj� d ��tjjj || ||| d � dddid�}|S )a� Registers a virtual machine to the inventory with the given vmx file. Returns comments and change list name Name of the virtual machine datacenter Datacenter of the virtual machine placement Placement dictionary of the virtual machine, host or cluster vmx_path: Full path to the vmx file, datastore name should be included service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. zTRegistering virtual machine with properties datacenter=%s, placement=%s, vmx_path=%srt Z resourcePoolr8 z:The cluster's resource pool object could not be retrieved.rK r3 r4 r r� z7The host parent's parent object could not be retrieved.z0The host's parent object could not be retrieved.)Z host_objectz-Virtual machine registration action succeeded� register_vmT�Zcommentra ) r� rI r7 r8 re rt ru rv r� r r^ r� rY )r@ rm r6 Zvmx_pathrb r8 Z cluster_objZ cluster_propsZ resourcepoolr� Zhost_objZ host_propsZ host_parentr� r� r3 r3 r4 r^ �, sh ��� � � ��� �� ��r^ c C �p t �d| � ddg}tjjj|| ||d�}|d dkr$dddid �}|S tjjj|d d d � d ddid �}|S )ap Powers on a virtual machine specified by its name. name Name of the virtual machine datacenter Datacenter of the virtual machine service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.power_on_vm name=my_vm z Powering on virtual machine %sr@ �summary.runtime.powerState�rm r. Z poweredOnz%Virtual machine is already powered onZpower_onTr_ r �on��actionz)Virtual machine power on action succeeded�r� rI r7 r8 re r0 Zpower_cycle_vm�r@ rm rb r. r1 r� r3 r3 r4 � power_on_vm- � � ��rh c C r` )ar Powers off a virtual machine specified by its name. name Name of the virtual machine datacenter Datacenter of the virtual machine service_instance Service instance (vim.ServiceInstance) of the vCenter. Default is None. CLI Example: .. code-block:: bash salt '*' vsphere.power_off_vm name=my_vm z Powering off virtual machine %sr@ ra rb Z poweredOffz&Virtual machine is already powered off� power_offTr_ r Zoffrd z*Virtual machine power off action succeededrf rg r3 r3 r4 � power_off_vm>- ri rk c C s� i }|rt jj�|||�\}}nt jj�||�}|r$t| ||� d|d< t jjj|tj| d|d�}|s=t j � d� | |���||fS )a9 Helper function to remove a virtual machine name Name of the virtual machine service_instance vCenter service instance for connection and configuration datacenter Datacenter of the virtual machine placement Placement information of the virtual machine TZ powered_offr@ rX z<The virtual machine object {} in datacenter {} was not found) r7 r8 re rS rt rk rZ r r[ r� r rY ) r@ rm rb r6 rj �resultsrV rW r` r3 r3 r4 � _remove_vmj- s2 �� ���rm c C �z i }t �� }z t�| ||d�|� W n tjjy$ } zt|��d}~ww t| ||||d�\}}tj j � |� d|d< |S )a� Deletes a virtual machine defined by name and placement name Name of the virtual machine datacenter Datacenter of the virtual machine placement Placement information of the virtual machine service_instance vCenter service instance for connection and configuration CLI Example: .. code-block:: bash salt '*' vsphere.delete_vm name=my_vm datacenter=my_datacenter �r@ rm r6 N�rb r6 rj TZ deleted_vm) r r� r� r� r� r� r rm r7 r8 re � delete_vm� r@ rm r6 rj rb rl r� r� r` r3 r3 r4 rq �- s( ��� �rq c C rn )a� Unregisters a virtual machine defined by name and placement name Name of the virtual machine datacenter Datacenter of the virtual machine placement Placement information of the virtual machine service_instance vCenter service instance for connection and configuration CLI Example: .. code-block:: bash salt '*' vsphere.unregister_vm name=my_vm datacenter=my_datacenter ro Nrp TZunregistered_vm) r r� r� r� r� r� r rm r7 r8 re � unregister_vmrr r3 r3 r4 rs �- s( ��� �rs r1 )NNNNNNN)NNNN)NNr� r� NN)NNTTNN)NNNNNr� )NNNT)NNT)NNNr� T)T)NN)NT)TN)TTN)r )NNrl NNNNN)rc )Nr NNN)r )NNNr� N)NTN)NNNNNN)r9 NNNNNN)NNNNNNNNNNNNNN)NFN( �__doc__r% �loggingr� � functoolsr Zsalt.utils.argsr7 Zsalt.utils.dictupdater8 r� Zsalt.utils.httpZsalt.utils.pathZsalt.utils.pbmZsalt.utils.vmwareZsalt.utils.vsanZ salt.config.schemas.esxclusterr r Zsalt.config.schemas.esxir r r Zsalt.config.schemas.esxvmr r Zsalt.config.schemas.vcenterr Zsalt.exceptionsr r r r r r r r Zsalt.utils.decoratorsr r Zsalt.utils.dictdifferr Zsalt.utils.listdifferr � getLoggerrZ r� r� ZHAS_JSONSCHEMA� ImportErrorZpyVmomir r r r Z versionMap� version_infor� Z HAS_PYVMOMIZ com.vmware.cis.tagging_clientr r r! r" r# Z!com.vmware.vapi.std.errors_clientr$ r% r& r' r( Zcom.vmware.vapi.std_clientr) Zcom.vmware.vcenter_clientr* r> ZHAS_VSPHERE_SDKr� �whichZesx_cliZ HAS_ESX_CLIr2 Z__proxyenabled__r5 rA rE rX ra rp rq rh r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r r r r r r r r r r" r# r$ r' r) r- r/ r9 r> r? rS rV rZ rb rl r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r r! r# r& r/ r0 r4 r5 rr rv r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r� r� r� r' rs r) r( r- r2 r; r> rD rK rR rW rb re rf rk r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r� r rY rO r# r' r) r+ r- r& r0 r5 r8 rA rB rI rM rN rO rR r^ r^ rh rk rm rq rs r3 r3 r3 r4 �<module> s� 8 ( � � � �� ]�^�\�c�o�i�^�O� 9�Q�{�S�7�A�@� � �J�O�W�6�,*�+�+)�+))))*�C�J�]� � � � �K�G�J�U��a�a J &GP076 L64I($ 2)) " �. (X . _q �b�? ! #�2�6 �399K+�G�F�P' � > B�7�K � i D �)3 ( � #�\ 5<� V S #)� g#J \ 5 3 _ k 7 E,8;�*�*�R�E�N�7�F�8 � \ � R P ( (, + �
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings