File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/states/__pycache__/esxvm.cpython-310.pyc
o
�N�g<P � @ s
d Z ddlZddlZddlmZ ddlZddlmZ zddl Z dZ
W n e y- dZ
Y nw z
ddl m
Z
dZW n e yC dZY nw e�e�Zdd � Zd
d � Ze dd d
��Zedd� �Ze ddd��Ze ddd��Zeddd��ZdS )aw
Salt state to create, update VMware ESXi Virtual Machines.
.. Warning::
This module will be deprecated in a future release of Salt. VMware strongly
recommends using the
`VMware Salt extensions <https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/all.html>`_
instead of the ESX VSM module. Because the Salt extensions are newer and
actively supported by VMware, they are more compatible with current versions
of ESXi and they work well with the latest features in the VMware product
line.
Dependencies
============
- pyVmomi
- jsonschema
States
======
vm_configured
-------------
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
This state identifies the action which should be taken for the virtual machine
and applies that action via the create, update, register state functions.
Supported proxies: esxvm
Example:
1. Get the virtual machine ``my_vm`` status with an ``esxvm`` proxy:
Proxy minion configuration for ``esxvm`` proxy:
.. code-block:: yaml
proxy:
proxytype: esxvm
datacenter: my_dc
vcenter: vcenter.fake.com
mechanism: sspi
domain: fake.com
principal: host
State configuration:
.. code-block:: yaml
myvm_state:
esxvm.vm_configured:
- vm_name: my_vm
- cpu: {{ {'count': 4, 'cores_per_socket': 2} }}
- memory: {{ {'size': 16384, 'unit': 'MB'} }}
- image: rhel7_64Guest
- version: vmx-12
- interfaces: {{ [{
'adapter': 'Network adapter 1',
'name': 'my_pg1',
'switch_type': 'distributed',
'adapter_type': 'vmxnet3',
'mac': '00:50:56:00:01:02,
'connectable': { 'start_connected': true,
'allow_guest_control': true,
'connected': true}},
{
'adapter': 'Network adapter 2',
'name': 'my_pg2',
'switch_type': 'distributed',
'adapter_type': 'vmxnet3',
'mac': '00:50:56:00:01:03',
'connectable': { 'start_connected': true,
'allow_guest_control': true,
'connected': true}}
] }}
- disks: {{ [{
'adapter': 'Hard disk 1',
'unit': 'MB',
'size': 51200,
'filename': 'my_vm/sda.vmdk',
'datastore': 'my_datastore',
'address': '0:0',
'thin_provision': true,
'eagerly_scrub': false,
'controller': 'SCSI controller 0'},
{
'adapter': 'Hard disk 2',
'unit': 'MB',
'size': 10240,
'filename': 'my_vm/sdb.vmdk',
'datastore': 'my_datastore',
'address': '0:1',
'thin_provision': true,
'eagerly_scrub': false,
'controller': 'SCSI controller 0'}
] }}
- scsi_devices: {{ [{
'adapter': 'SCSI controller 0',
'type': 'paravirtual',
'bus_sharing': 'no_sharing',
'bus_number': 0}
] }}
- serial_ports: {{ [{
'adapter': 'Serial port 1',
'type': 'network',
'yield': false,
'backing': {
'uri': 'my_uri',
'direction': 'server',
'filename': 'my_file'},
'connectable': {
'start_connected': true,
'allow_guest_control': true,
'connected': true}}
] }}
- datacenter: {{ 'my_dc' }}
- datastore: 'my_datastore'
- placement: {{ {'cluster': 'my_cluster'} }}
- cd_dvd_drives: {{ [] }}
- advanced_configs: {{ {'my_param': '1'} }}
- template: false
- tools: false
- power_on: false
- deploy: false
vm_updated
----------
Updates a virtual machine to a given configuration.
vm_created
----------
Creates a virtual machine with a given configuration.
vm_registered
-------------
Registers a virtual machine with its configuration file path.
Dependencies
============
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.6,
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==6.0.0.2016.4
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against. To be able to connect through SSPI you must
use pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with
this version.
About
-----
This state module was written to be used in conjunction with Salt's
:mod:`ESXi Proxy Minion <salt.proxy.esxi>` For a tutorial on how to use Salt's
ESXi Proxy Minion, please refer to the
:ref:`ESXi Proxy Minion Tutorial <tutorial-esxi-proxy>` for
configuration examples, dependency installation instructions, how to run remote
execution functions against ESXi hosts via a Salt Proxy Minion, and a larger state
example.
� N��wraps)� ESXVirtualMachineConfigSchemaTF)� VmomiSupportc C s6 t sdS tsdS dtjv rtjdkrtjdk rdS dS )N)Fz/State module did not load: jsonschema not found)Fz,State module did not load: pyVmomi not foundz vim25/6.0)� � )r r � )FzaState module did not load: Incompatible versions of Python and pyVmomi present. See Issue #29537.T)�HAS_JSONSCHEMA� HAS_PYVMOMIr Z
versionMap�sys� version_info� r
r
�E/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/esxvm.py� __virtual__� s
r c s t � �� fdd��}|S )z>
Decorator wrapper to warn about azurearm deprecation
c s6 t jjjddtd� � | i t jjjdi |����}|S )NZArgonz�The 'esxvm' 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))�categoryr
)�salt�utilsZversionsZ
warn_until�
FutureWarning�argsZ clean_kwargs)r �kwargs�ret��functionr
r �wrapped� s � z%_deprecation_message.<locals>.wrappedr )r r r
r r �_deprecation_message� s r c C s$ | di dd�}t �d� t�� }t �d|� z?t�i d|�d|�d|�d |�d
|�d |�d |�d
|�d| �d|
�d|�d|
�d| �d| �d|�d|�d|�d|i�|� W n tjjyi } ztj� |��d}~ww t
d � }z t
d |dg|d� W nu tjj y� t
d ||
| | |d �}|r�t d r�|�
d d �|�i� t
d! |� | Y S t||
| ||d"�}| Y S t d r�|�
d d#�|�i� t
d! |� | Y S |r�t| �}| Y S t| ||||||||| |
| | |
||d$�}| Y S w t| ||||||||| |
| |
|||d%�}t
d! |� t �|� |S )&z�
Selects the correct operation to be executed on a virtual machine, non
existing machines will be created, existing ones will be updated if the
config differs.
N� ��name�result�changes�commentz(Validating virtual machine configurationz schema = %s�vm_name�cpu�memory�image�version�
interfaces�disks� scsi_devices� serial_ports�
cd_dvd_drives�sata_controllers�
datacenter� datastore� placement�template�tools�power_on�deploy�&vsphere.get_service_instance_via_proxyzvsphere.get_vmr )Z
vm_properties�service_instancezvsphere.get_vm_config_file�r4 �testr z*The virtual machine {} will be registered.�vsphere.disconnect)r1 z'The virtual machine {} will be created.)r* �advanced_configsr1 )r* r+ r8 r1 )�log�tracer Z serialize�
jsonschema�validate�
exceptionsZValidationErrorr ZInvalidConfigError�__salt__ZVMwareObjectRetrievalError�__opts__�update�format�
vm_registered� vm_cloned�
vm_created�
vm_updated)r r! r" r# r$ r% r& r' r( r) r, r- r. r* r+ r8 r/ r0 r1 r2 r Zschema�excr4 �vm_filer
r
r �
vm_configured s�
�������� �
� � �
������� ��
�
����
���� ���5�
rH c C s | di dd�}|S )zu
Clones a virtual machine from a template virtual machine if it doesn't
exist and a template is defined.
Tr r r
)r r r
r
r rC � s rC c C s� | di dd�}t d � }t d ||
d|d�}t d ||||||||| |
| | |
|d �|�}|s=|�d
i d |� d �d
�� |S td rbd�||
d�dd� |�� D ���}|�d|d�� t d |� |S zt d ||||||||| |
| | |
||d�}W n. tjjy� } z t �
d|� |r�t d |� |�dt |�d�� |W Y d}~S d}~ww |r�z t d ||
� W n. tjj y� } z t �
d|� |r�t d |� |�dt |�d�� |W Y d}~S d}~ww |�dd
i� t d |� | d
|d |� d�d�}|S )z|
Updates a virtual machine configuration if there is a difference between
the given and deployed configuration.
Nr r r3 zvsphere.get_vm_configF)r, Zobjectsr4 zvsphere.compare_vm_configs)r r" r# r$ r% r& r' r( r) r, r- � cd_drivesr+ r8 T�Virtual machine z is already up to date�r r r r6 zHState vm_updated will update virtual machine '{}' in datacenter '{}':
{}�
c S s g | ] \}}d � ||jg��qS )z:
)�joinZ changes_str)�.0�key�
differencer
r
r �
<listcomp>� s ��z vm_updated.<locals>.<listcomp>�r r r7 zvsphere.update_vm)r* r+ r8 r4 � Error: %s�vsphere.power_on_vmr1 z was updated successfully)
r> r@ r? rA rM �itemsr r= �CommandExecutionErrorr9 �error�str�VMwarePowerOnError)r r! r" r# r$ r% r& r' r( r) r, r- r* r+ r8 r1 r r4 Zcurrent_configZdiffsr r rF r
r
r rE � s�
���
������
� �� ��
�rE c C st | di dd�}t d rd|� d�|d< |S td � }ztd ||||||
| | |||| |
||||d
�}W n. tjjya } z t�d |� |rKtd |� |�d
t|�d�� |W Y d}~S d}~ww |r�z td ||
|d� W n. tjj y� } z t�d |� |r�td |� |�d
t|�d�� |W Y d}~S d}~ww ||d< ||d�}td |� | d|d|� d�d�}|S )zR
Creates a virtual machine with the given properties if it doesn't exist.
Nr r r6 rJ z will be createdr r3 zvsphere.create_vm)r) �ide_controllersr+ rI r8 r4 rS r7 FrR rT r5 r1 )r �infoTz created successfully)
r? r> r r= rV r9 rW r@ rX rY )r r! r" r# r$ r% r& r' r( r) r, r- r. rZ r+ r* r8 r1 r r4 r[ rF r r
r
r rD sn
� ��
� ��
�rD c
C s� | di dd�}|j � |jd j� �}t�d|� td � }z
td | ||||d� W n[ tjjyX } z t� d |� |rBtd
|� |�
d t |�d �� |W Y d}~S d}~w tjj y� } z t� d |� |rotd
|� |�
d t |�d �� |W Y d}~S d}~ww |r�z td
| ||d� W n. tjj
y� } z t� d |� |r�td
|� |�
d t |�d �� |W Y d}~S d}~ww td
|� |�
d| |d�d| � d�d�� |S )zc
Registers a virtual machine if the machine files are available on
the main datastore.
Nr r r z-Registering virtual machine with vmx file: %sr3 zvsphere.register_vmr5 rS r7 FrR rT T)r r1 rJ z registered successfullyrK )Z
folderPath�file�pathr9 r: r> r r= ZVMwareMultipleObjectsErrorrW r@ rX ZVMwareVmRegisterErrorrY ) r! r, r. rG r1 r Zvmx_pathr4 rF r
r
r rB o sX
� � ��
� ��
��rB )NNNNTFF)NNNF)NNNNF)F)�__doc__�loggingr � functoolsr Zsalt.exceptionsr Zsalt.config.schemas.esxvmr r; r � ImportErrorZpyVmomir r
� getLogger�__name__r9 r r rH rC rE rD rB r
r
r
r �<module> sb C � �
�
�| �R