Current File : //lib/python2.7/site-packages/salt/states/esxi.pyo
�
���^c @@ s] d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m Z d d l
Z d d l m
Z
m Z m Z m Z m Z m Z d d l m Z d d l m Z m Z y d d l Z e Z Wn e k
r� e Z n Xe j e � Z yo d d l m! Z! d e! j" k oAe j# d
d f k oAe j# d
d d f k r]e j$ d
� e � � n e Z% Wn e k
r}e Z% n Xd � Z& d d d � Z' d � Z( e) e) e e d � Z* d d � Z+ e d � Z, e) e) e) e e d � Z- e e e e) d � Z. e e% � e e � e d � � � Z/ e e% � e e � d e e d � � � Z0 d � Z1 d � Z2 d S( uK
Manage VMware ESXi Hosts.
.. versionadded:: 2015.8.4
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.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==5.5.0.2014.1.1
The 5.5.0.2014.1.1 is a known stable version that this original ESXi State
Module was developed against.
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 state module may depend on the
type of license attached to the ESXi host.
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 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.
i ( t absolute_importt print_functiont unicode_literalsN( t six( t CommandExecutionErrort InvalidConfigErrort VMwareObjectRetrievalErrort VMwareSaltErrort VMwareApiErrort ArgumentValueError( t depends( t DiskGroupsDiskScsiAddressSchemat HostCacheSchema( t VmomiSupportu vim25/6.0i i i uF pyVmomi not loaded: Incompatible versions of Python. See Issue #29537.c C@ s
d t k S( Nu esxi.cmd( t __salt__( ( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt __virtual__� s u vmk0id c C@ sZ i | d 6t d 6i d 6d d 6} d } d } t d d } t | d
� j | � } | j d � }
|
r� d j |
� | d <| S| j d
� } | j d � } | | k rai i | d 6| d 6d 6} t d sMt | d d | �j | � }
|
j d � }
|
rd j |
� | d <| S| sMt | d <| | d <| d j | � | Sn | d j | � n | st | d <| | d <| St } | j d � } | | k r�| d j i i | d 6| d 6d 6� t } n | j d � } | | k r| d j i i | d 6| d 6d 6� t } n | j d � } | t j | � k ru| d j i i | d 6t j | � d 6d 6� t } n t d r
| t k r
t | d d | d | d | �j | � }
|
j d � t k r
|
j d � } | s�|
j d � } n d j | � | d <| Sn t | d <| d i k r5d | d <| St d rVd" | d <d! | d <n | S(# u�
Ensures a host's core dump configuration.
name
Name of the state.
enabled
Sets whether or not ESXi core dump collection should be enabled.
This is a boolean value set to ``True`` or ``False`` to enable
or disable core dumps.
Note that ESXi requires that the core dump must be enabled before
any other parameters may be set. This also affects the ``changes``
results in the state return dictionary. If ``enabled`` is ``False``,
we can't obtain any previous settings to compare other state variables,
resulting in many ``old`` references returning ``None``.
Once ``enabled`` is ``True`` the ``changes`` dictionary comparisons
will be more accurate. This is due to the way the system coredemp
network configuration command returns data.
dump_ip
The IP address of host that will accept the dump.
host_vnic
Host VNic port through which to communicate. Defaults to ``vmk0``.
dump_port
TCP port to use for the dump. Defaults to ``6500``.
Example:
.. code-block:: yaml
configure-host-coredump:
esxi.coredump_configured:
- enabled: True
- dump_ip: 'my-coredump-ip.example.com'
u nameu resultu changesu u commentu esxi.cmduX ESXi requires that the core dump must be enabled before any other parameters may be set.u proxyu hostu get_coredump_network_configu Erroru
Error: {0}u Coredump Configu enabledu oldu newu testu coredump_network_enablet enabledu ipu dump_ipu host_vnicu portu dump_portu set_coredump_network_configt dump_ipt host_vnict dump_portu successu stderru stdoutu8 Core Dump configuration is already in the desired state.u$ Core dump configuration will change.N( t Falset
__pillar__R t gett formatt __opts__t Truet updateR t text_typet None( t nameR R R R t rett esxi_cmdt enabled_msgt hostt current_configt errort current_enabledt enabled_changest responset changest
current_ipt current_vnict current_portt msg( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt coredump_configured� s� )
c C@ s� i | d 6t d 6i d d 6d d 6d 6d d 6} d
} t d rX d | d <d | d <| Sy t | d
d | �Wn1 t k
r� } t | d <d j | � | d <| SX| S( u�
Ensures the given password is set on the ESXi host. Passwords cannot be obtained from
host, so if a password is set in this state, the ``vsphere.update_host_password``
function will always run (except when using test=True functionality) and the state's
changes dictionary will always be populated.
The username for which the password will change is the same username that is used to
authenticate against the ESXi host via the Proxy Minion. For example, if the pillar
definition for the proxy username is defined as ``root``, then the username that the
password will be updated for via this state is ``root``.
name
Name of the state.
password
The new password to change on the host.
Example:
.. code-block:: yaml
configure-host-password:
esxi.password_present:
- password: 'new-bad-password'
u nameu resultu unknownu oldu ********u newu changesu Host password was updated.u commentu esxi.cmdu testu Host password will change.u update_host_passwordt new_passwordu
Error: {0}N( R R R R R R R ( R t passwordR R t err( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt password_present s$
c C@ s� i | d 6t d 6i d 6d d 6} d } t d d } d } t | d
� j | � }
t | d d | �j | � } | j d
� } | r� d j | � | d <| S| j | � } | rNt | � t |
� k rNt d s%t | d d | �j | � }
|
j d
� } | r%d j | � | d <| Sn | d j i i |
d 6| d 6d 6� n | | k r5t d s | t k r�t | d d | �j | � }
|
j d
� } | r d j | � | d <| Sq t | d d | �j | � }
|
j d
� } | r d j | � | d <| Sn | d j i i | d 6| d 6d 6� n | r+t | d d | �j | � } | j d
� } | r�d j | � | d <| S| j | � } | | k r+t d s�t | d d | d | �j | � }
|
j d
� } | r�d j | � | d <| Sn | d j i i | d 6| d 6d 6� q+n | r�t d s�t | d � j | � }
|
j d
� } | r�d j | � | d <| Sn | d j i i d d 6d d 6d 6� n | r3t d s
t | d d | �j | � }
|
j d
� } | r
d j | � | d <| Sn | d j i i d d 6d d 6d 6� n t | d <| d i k r[d! | d <| St d r|d# | d <d" | d <n | S($ ur
Ensures a host's NTP server configuration such as setting NTP servers, ensuring the
NTP daemon is running or stopped, or restarting the NTP daemon for the ESXi host.
name
Name of the state.
service_running
Ensures the running state of the ntp daemon for the host. Boolean value where
``True`` indicates that ntpd should be running and ``False`` indicates that it
should be stopped.
ntp_servers
A list of servers that should be added to the ESXi host's NTP configuration.
service_policy
The policy to set for the NTP service.
.. note::
When setting the service policy to ``off`` or ``on``, you *must* quote the
setting. If you don't, the yaml parser will set the string to a boolean,
which will cause trouble checking for stateful changes and will error when
trying to set the policy on the ESXi host.
service_restart
If set to ``True``, the ntp daemon will be restarted, regardless of its previous
running state. Default is ``False``.
update_datetime
If set to ``True``, the date/time on the given host will be updated to UTC.
Default setting is ``False``. This option should be used with caution since
network delays and execution delays can result in time skews.
Example:
.. code-block:: yaml
configure-host-ntp:
esxi.ntp_configured:
- service_running: True
- ntp_servers:
- 192.174.1.100
- 192.174.1.200
- service_policy: 'on'
- service_restart: True
u nameu resultu changesu u commentu esxi.cmdu proxyu hostu ntpdu get_ntp_configu get_service_runningt service_nameu Erroru
Error: {0}u testu set_ntp_configt ntp_serversu oldu newu ntp_serversu
service_startu service_stopu service_runningu get_service_policyu set_service_policyt service_policyu service_policyu update_host_datetimeu Host datetime was updated.u update_datetimeu service_restartu NTP Daemon Restarted.u$ NTP is already in the desired state.u NTP state will change.N(
R R R R R t setR R R R ( R t service_runningR2 R3 t service_restartt update_datetimeR R R! t ntpdt
ntp_configt ntp_runningR# R& t current_service_policy( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt ntp_configuredF s� 7
c C@ s� i | d 6t d 6i d 6d d 6} d } t d d } t | d � j | � } | j d
� } | | k r?t d s| t k r� t | d d
| �j | � } | j d � } | rd j | � | d <| Sqt | d � j | � } | j d � } | rd j | � | d <| Sn | d j i i | d 6| d 6d 6� n t | d <| d i k rgd | d <| St d r�d | d <d | d <n | S( u�
Configures a host's VMotion properties such as enabling VMotion and setting
the device VirtualNic that VMotion will use.
name
Name of the state.
enabled
Ensures whether or not VMotion should be enabled on a host as a boolean
value where ``True`` indicates that VMotion should be enabled and ``False``
indicates that VMotion should be disabled.
device
The device that uniquely identifies the VirtualNic that will be used for
VMotion for the host. Defaults to ``vmk0``.
Example:
.. code-block:: yaml
configure-vmotion:
esxi.vmotion_configured:
- enabled: True
- device: sample-device
u nameu resultu changesu u commentu esxi.cmdu proxyu hostu get_vmotion_enabledu VMotion Enabledu testu vmotion_enablet deviceu Erroru
Error: {0}u vmotion_disableu oldu newu enabledu6 VMotion configuration is already in the desired state.u" VMotion configuration will change.N( R R R R R R R R R ( R R R= R R R! t current_vmotion_enabledR& R# ( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt vmotion_configured� sB
c C@ s� i | d 6t d 6i d 6d d 6} d } t d d } t | d � j | � } | j d
� } | r{ d j | � | d <| S| j d � } | | k ret d
s<| t k r� t | d � j | � } | j d
� } | r9d j | � | d <| Sq<t | d � j | � } | j d
� } | r<d j | � | d <| Sn | d j i i | d 6| d 6d 6� n | rRt | d � j | � } | j d
� } | r�d j | � | d <| S| j d � }
|
rRt |
t � rRt d
s&t | d � j | � } | j d
� } | r&d j | � | d <| Sn | d j i i d d 6|
d 6d 6� qRn t | d <| d i k rzd | d <| St d
r�d | d <d | d <n | S( u�
Configures a host's VSAN properties such as enabling or disabling VSAN, or
adding VSAN-eligible disks to the VSAN system for the host.
name
Name of the state.
enabled
Ensures whether or not VSAN should be enabled on a host as a boolean
value where ``True`` indicates that VSAN should be enabled and ``False``
indicates that VSAN should be disabled.
add_disks_to_vsan
If set to ``True``, any VSAN-eligible disks for the given host will be added
to the host's VSAN system. Default is ``False``.
Example:
.. code-block:: yaml
configure-host-vsan:
esxi.vsan_configured:
- enabled: True
- add_disks_to_vsan: True
u nameu resultu changesu u commentu esxi.cmdu proxyu hostu get_vsan_enabledu Erroru
Error: {0}u VSAN Enabledu testu vsan_enableu vsan_disableu oldu newu enabledu get_vsan_eligible_disksu Eligibleu vsan_add_disksu add_disks_to_vsanu3 VSAN configuration is already in the desired state.u VSAN configuration will change.N( R R R R R R R R t
isinstancet listR ( R R t add_disks_to_vsanR R R! t current_vsan_enabledR# R& t current_eligible_diskst disks( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt vsan_configured< sj
c C@ s i | d 6t d 6i d 6d d 6} d } t d d } d }
t | d
d |
�j | � } | j d � } | r� d
j | � | d <| S| j |
� } | | k r}t d sT| t k rt | d d |
�j | � }
|
j d � } | rQd
j | � | d <| SqTt | d d |
�j | � } | j d � } | rTd
j | � | d <| Sn | d j i i | d 6| d 6d 6� n d t } } | s�| r�t | d d | �} | j d � } | r�d
j | � | d <| S| j d � } | r�t | � j
d � } | sbd } t j j
j | d � �7 } x- | D]% } | j d � rKq0n | | } q0WWd QXn t | � j
d � } | d | d k s�| d | d k r�t } q�q�t } n | rJt d st | d d | d | d | �} | j d � } | rd
j | � | d <| Sn | d j i i | d 6| r8| n | d 6d 6� n | r@t | d! d |
�j | � } | j d � } | r�d
j | � | d <| S| j |
� } | | k r@t d st | d" d |
d# | �j | � } | j d � } | rd
j | � | d <| Sn | d j i i | d 6| d 6d$ 6� q@n | r�t d s�t | d% d |
�j | � } | j d � } | r�d
j | � | d <| Sn | d j i i d d 6d& d 6d% 6� n t | d <| d i k r�d' | d <| St d rd | d <d( | d <n | S() u�
Manage the SSH configuration for a host including whether or not SSH is running or
the presence of a given SSH key. Note: Only one ssh key can be uploaded for root.
Uploading a second key will replace any existing key.
name
Name of the state.
service_running
Ensures whether or not the SSH service should be running on a host. Represented
as a boolean value where ``True`` indicates that SSH should be running and
``False`` indicates that SSH should stopped.
In order to update SSH keys, the SSH service must be running.
ssh_key
Public SSH key to added to the authorized_keys file on the ESXi host. You can
use ``ssh_key`` or ``ssh_key_file``, but not both.
ssh_key_file
File containing the public SSH key to be added to the authorized_keys file on
the ESXi host. You can use ``ssh_key_file`` or ``ssh_key``, but not both.
service_policy
The policy to set for the NTP service.
.. note::
When setting the service policy to ``off`` or ``on``, you *must* quote the
setting. If you don't, the yaml parser will set the string to a boolean,
which will cause trouble checking for stateful changes and will error when
trying to set the policy on the ESXi host.
service_restart
If set to ``True``, the SSH service will be restarted, regardless of its
previous running state. Default is ``False``.
certificate_verify
If set to ``True``, the SSL connection must present a valid certificate.
Default is ``False``.
Example:
.. code-block:: yaml
configure-host-ssh:
esxi.ssh_configured:
- service_running: True
- ssh_key_file: /etc/salt/ssh_keys/my_key.pub
- service_policy: 'on'
- service_restart: True
- certificate_verify: True
u nameu resultu changesu u commentu esxi.cmdu proxyu hostu sshu get_service_runningR1 u Erroru
Error: {0}u testu
service_startu service_stopu oldu newu service_runningu get_ssh_keyt certificate_verifyu keyu u ru #Ni i u upload_ssh_keyt ssh_keyt ssh_key_fileu SSH Keyu get_service_policyu set_service_policyR3 u service_policyu service_restartu SSH service restarted.u, SSH service is already in the desired state.u SSH service state will change.( R R R R R R R R R t
_strip_keyt splitt saltt utilst filest fopent
startswith( R R5 RH RI R3 R6 RG R R R! t ssht ssh_runningR# t enablet disablet current_ssh_keyt ssh_key_changedt clean_current_keyt key_filet linet
clean_ssh_keyR& R; ( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt ssh_configured� s� =
(
c C@ s i | d 6t d 6i d 6d d 6} d } t d d } | r"| sK d } n t d
s� t | d d | �j | � } x� t j | � D]n \ }
} t | t � r� q� n | j d
� s� | j d � } | s� d j | � } n d j | � | d <| Sq� Wn | d j
i i d d 6| d 6d 6� n t | d � j | � }
|
j d � } | rgd j | � | d <| S|
j d � j d � }
|
| k r<t d
st | d d | d d �j | � } | j d � d k r| j d � } | j d � } d j | r�| n | � | d <| Sn | d j
i i |
d 6| d 6d 6� n t | d � j | � } xrt j | � D]a\ }
} y t |
� } Wn% t k
r�d j |
� | d <| SX| | } t j
| � t j
| � k ret d
skt | d! d |
d" | d# | d$ | �j | � } | j |
� j d
� } | sk| j |
� j d � } | sZd% j |
� } n | | d <| Sn | d j d& � s�| d j
i i d& 6� n | d d& j
i i | d 6| d 6|
6� qeqeWt | d <| d i k r�d' | d <| St d
rd) | d <d( | d <n | S(* u}
Ensures the specified syslog configuration parameters. By default,
this state will reset the syslog service after any new or changed
parameters are set successfully.
name
Name of the state.
syslog_configs
Name of parameter to set (corresponds to the command line switch for
esxcli without the double dashes (--))
Valid syslog_config values are ``logdir``, ``loghost``, ``logdir-unique``,
``default-rotate``, ``default-size``, and ``default-timeout``.
Each syslog_config option also needs a configuration value to set.
For example, ``loghost`` requires 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)
firewall
Enable the firewall rule set for syslog. Defaults to ``True``.
reset_service
After a successful parameter set, reset the service. Defaults to ``True``.
reset_syslog_config
Resets the syslog service to it's default settings. Defaults to ``False``.
If set to ``True``, default settings defined by the list of syslog configs
in ``reset_configs`` will be reset before running any other syslog settings.
reset_configs
A comma-delimited list of parameters to reset. Only runs if
``reset_syslog_config`` is set to ``True``. If ``reset_syslog_config`` is set
to ``True``, but no syslog configs are listed in ``reset_configs``, then
``reset_configs`` will be set to ``all`` by default.
See ``syslog_configs`` parameter above for a list of valid options.
Example:
.. code-block:: yaml
configure-host-syslog:
esxi.syslog_configured:
- syslog_configs:
loghost: ssl://localhost:5432,tcp://10.1.0.1:1514
default-timeout: 120
- firewall: True
- reset_service: True
- reset_syslog_config: True
- reset_configs: loghost,default-timeout
u nameu resultu changesu u commentu esxi.cmdu proxyu hostu allu testu reset_syslog_configt
syslog_configu successu messageuK There was an error resetting a syslog config '{0}'.Please check debug logs.u
Error: {0}u oldu newu get_firewall_statusu Erroru rulesetsu syslogu enable_firewall_rulesett ruleset_enablet ruleset_nameu retcodei u stderru stdoutu firewallu get_syslog_configu% '{0}' is not a valid config variable.u set_syslog_configt config_valuet firewallt
reset_serviceuH There was an error setting syslog config '{0}'. Please check debug logs.u
syslog_configu' Syslog is already in the desired state.u Syslog state will change.N( R R R R R R t iteritemsR@ t boolR R t _lookup_syslog_configt KeyErrorR R R ( R t syslog_configsR` Ra t reset_syslog_configt
reset_configsR R R! t resett keyt valR+ t current_firewallR# R R/ t outt current_syslog_configt
lookup_keyt current_valR& t success( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt syslog_configurede s� =
c ( C@ s~ t d � } | j d � s& | d n | d } t j d j | | � � i | d 6d= d 6i d 6d= d 6} t } t } g } i } d= }
y� t j d
� t j � } y" t
j i | d 6| d 6| � Wn% t
j j
k
r� } t | � � n Xt d
� }
t d d |
� }
|
s-t d j | � � � n d � |
D� } t j d j | � � t d d |
� } d � | D� } Wnu t k
r�} t j d j | � � |
r�t d |
� n | j i t d s�t n d= d 6t j | � d 6� | SXxt | � D]
\ } } | d | k rO| j d j | d � � t j | d � t } q�n | | d d } d j | d | � } g } g } g } xc | d D]W } | | k r�| j | � q�n | j | | d � | j d j | | d � � q�W| rP| j d j | d j g | D] } d! j | � ^ q� � � t j | d � t } q�n | j | � s�t j d" j | � � | rPt d r�| j d# j | | | d j g | D] } d$ j | � ^ q�� � � qPx, | g | D] } t d% d& | d |
� q�W| j d' j | | d j g | D] } d! j | � ^ q� � � t j | d � n t d r�| j d( j | | | d j g | D] } d! j | � ^ q|� � � t j | d � t } q�n y! t d) | | d* t d |
�WnF t k
r$} | j d+ j | | � � t j | d � t } q�n X| j d, j | � � t j | d � i i | d- 6| d. 6d/ 6| t j | � <t } q�n t j d0 j | | � � | j | � } g | d1 D]C } d j g |
D] } | d | k r�| d2 ^ q�d3 | � ^ q�} g } g } g }! g }" xx | D]p } | | d1 k rg |
D] } | d | k r8| d2 ^ q8d3 }# | j | � | j d j |# | � � qqWxx | d1 D]l } | | k r�g |
D] } | d | k r�| d2 ^ q�d3 }# |! j | � |" j d j |# | � � q�q�Wt j d4 j | | | |" � � |! r�| j d5 j d j g |" D] }$ d! j |$ � ^ qH� | � � t j | d � t } q�n | r�d j g | D] }$ d! j |$ � ^ q�� }% t d r�| j d6 j | |% | � � t j | d � t } q�n y! t d7 | | d* t d |
�WnI t k
rj} | j d8 j |% | | � � t j | d � t } q�n Xd9 j |% | � }& t j |& � | j |& � i i | d- 6| d. 6d/ 6i | d- 6| d. 6d: 6| t j | � <t } q�n d; j | � }% t j |% � | j |% � q�Wt d |
� | p$ | s- t n t d r= d= n | rI t n t }' | j i |' d 6d< j | � d 6| d 6� | S(> u
Configures the disk groups to use for vsan.
This function will do the following:
1. Check whether or not all disks in the diskgroup spec exist, and raises
and errors if they do not.
2. Create diskgroups with the correct disk configurations if diskgroup
(identified by the cache disk canonical name) doesn't exist
3. Adds extra capacity disks to the existing diskgroup
Example:
.. code:: python
{
'cache_scsi_addr': 'vmhba1:C0:T0:L0',
'capacity_scsi_addrs': [
'vmhba2:C0:T0:L0',
'vmhba3:C0:T0:L0',
'vmhba4:C0:T0:L0',
]
}
name
Mandatory state name
diskgroups
Disk group representation containing scsi disk addresses.
Scsi addresses are expected for disks in the diskgroup:
erase_disks
Specifies whether to erase all partitions on all disks member of the
disk group before the disk group is created. Default value is False.
u esxi.get_detailsu vcenteru hostu esxi_hostu Running state {0} for host '{1}'u nameu resultu changesu commentsu& Validating diskgroups_configured inputu
diskgroupsu erase_disksu& vsphere.get_service_instance_via_proxyu vsphere.list_diskst service_instanceu" No disks retrieved from host '{0}'c S@ s i | ] } | | d � q S( u scsi_address( ( t .0t d( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pys
<dictcomp>I s u scsi_addr_to_disk_map = {0}u vsphere.list_diskgroupsc S@ s i | ] } | | d � q S( u
cache_disk( ( Rt t dg( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pys
<dictcomp>N s u
Error: {0}u vsphere.disconnectu testu commentu cache_scsi_addru0 No cache disk with scsi address '{0}' was found.i����u idu {0} (id:{1})u capacity_scsi_addrsuO Error in diskgroup #{0}: capacity disks with scsi addresses {1} were not found.u , u '{0}'u erase_disks = {0}u\ State {0} will erase all disks of disk group #{1}; cache disk: '{2}', capacity disk(s): {3}.u '{}'u vsphere.erase_disk_partitionst disk_iduH Erased disks of diskgroup #{0}; cache disk: '{1}', capacity disk(s): {2}uT State {0} will create the disk group #{1}; cache disk: '{2}', capacity disk(s): {3}.u vsphere.create_diskgroupt
safety_checksu$ Error creating disk group #{0}: {1}.u Created disk group #'{0}'.u cacheu capacityu newu5 Disk group #{0} exists. Checking capacity disks: {1}.u capacity_disksu scsi_addressi un Disk group #{0}: existing capacity disk ids: {1}; added capacity disk ids: {2}; removed capacity disk ids: {3}uU Error removing capacity disk(s) {0} from disk group #{1}; operation is not supported.u; State {0} will add capacity disk(s) {1} to disk group #{2}.u! vsphere.add_capacity_to_diskgroupu: Error adding capacity disk(s) {0} to disk group #{1}: {2}.u- Added capacity disk(s) {0} to disk group #{1}u oldu< Disk group #{0} is correctly configured. Nothing to be done.u
N( R R t logt infoR R R t traceR t serializet
jsonschemat validatet
exceptionst ValidationErrorR R R R# R R R R t enumeratet appendR t joinR t debug(( R t
diskgroupst erase_diskst
proxy_detailst hostnameR t errorsR' t commentst diskgroup_changest sit schemat exct
host_diskst scsi_addr_to_disk_mapt existing_diskgroupst$ cache_disk_to_existing_diskgroup_mapR/ t idxRv t
cache_disk_idt cache_disk_displayt bad_scsi_addrst capacity_disk_idst capacity_disk_displayst scsi_addrt aRw t existing_diskgroupRu t existing_capacity_disk_displayst added_capacity_disk_idst added_capacity_disk_displayst removed_capacity_disk_idst removed_capacity_disk_displayst disk_scsi_addrt idt st comt result( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt diskgroups_configured st (
&
)
&
&
Q
$
$
) "
u 100%c ! C@ s[ t j d | � t j d | � t j d | � t j d | � t d � } | j d � sf | d n | d } t j d | � t j d
| � i | d 6d d
6dT d 6i d 6} t d r� dT n t } t }
g } i } dT }
yt j d � t
j � } y0 t j
i | d 6| d 6| d 6| d 6| � Wn% t j j k
rS} t | � � n Xt j d | � } t | j d � � } | j d � } t j d | | � t d � }
t d d |
� } | d | k r�| j i i | d d 6| d 6d 6� t }
n dT } | j d � r4t d d | d g d |
� } n t d! d" | d# g d |
� } | syt d$ j | d# | � � � n | d% } d& j | d' | d( � } t j d) | � dT } | s�| rAt d r�| j d* j | | | � � t j | d+ � qAt d, d- | d( d |
� | j d. j | | � � t j | d+ � n t d r�| j d/ j | | d | | � � t j | d+ � n5| r t d0 d- | d( d |
� } t j d1 | � g | D] } | d2 d3 k r�| ^ q�} t | � d% k r t d4 j | � � � q n t d5 | d | d% d( | d6 d |
�| j d7 j | d | | � � t j | d+ � | j i i i | d d 6| d8 6d 6d 6� t d d | d g d |
� d% } t }
n� | d% j d9 � s�t d: j | d � � � n | d( | d% d9 k rZt d; j | d | d( d< j g | d% d9 D] } d= j | � ^ q3� � � � n | j d> j | d | | � � | d% } t j d? | � t j | d+ � | r�| d@ k r�| dA | dB dC dC } n
| dC } t j dD | � t | dC � dC } t j dE | � d% } | j d � rBt j dF | j d � � n dT } | rft | j d � � } n | | k s�t }
| j i i dG j | dC � d 6dG j | dC � d 6d 6� q�n |
rzt d r| j dH j | | i | d 6| d dI 6| d 6� � q�| dB dU | k r@t dK j | d | dB dV | � � � n t dL | | d dM | d |
�| j dN j | � � n | j dO j | � � t } t dP |
� t j | d+ � | j i dQ j | � d
6| d 6| d 6� | SWno t k
rV} t j dR | � |
r t dP |
� n | j i t d s7t n dT d 6dS j | � d
6� | SXdT S(W uV
Configures the host cache used for swapping.
It will do the following:
1. Checks if backing disk exists
2. Creates the VMFS datastore if doesn't exist (datastore partition will be
created and use the entire disk)
3. Raises an error if ``dedicated_backing_disk`` is ``True`` and partitions
already exist on the backing disk
4. Configures host_cache to use a portion of the datastore for caching
(either a specific size or a percentage of the datastore)
Examples
Percentage swap size (can't be 100%)
.. code:: python
{
'enabled': true,
'datastore': {
'backing_disk_scsi_addr': 'vmhba0:C0:T0:L0',
'vmfs_version': 5,
'name': 'hostcache'
}
'dedicated_backing_disk': false
'swap_size': '98%',
}
Fixed sized swap size
.. code:: python
{
'enabled': true,
'datastore': {
'backing_disk_scsi_addr': 'vmhba0:C0:T0:L0',
'vmfs_version': 5,
'name': 'hostcache'
}
'dedicated_backing_disk': true
'swap_size': '10GiB',
}
name
Mandatory state name.
enabled
Specifies whether the host cache is enabled.
datastore
Specifies the host cache datastore.
swap_size
Specifies the size of the host cache swap. Can be a percentage or a
value in GiB. Default value is ``100%``.
dedicated_backing_disk
Specifies whether the backing disk is dedicated to the host cache which
means it must have no other partitions. Default is False
erase_backing_disk
Specifies whether to erase all partitions on the backing disk before
the datastore is created. Default value is False.
u enabled = %su datastore = %su swap_size = %su erase_backing_disk = %su esxi.get_detailsu vcenteru hostu esxi_hostu
hostname = %su0 Running host_cache_swap_configured for host '%s'u nameu Default commentsu commentu resultu changesu testu& Validating host_cache_configured inputu enabledu datastoreu swap_sizeu erase_backing_disku (\d+)(%|GiB)i i u$ swap_size_value = %s; swap_type = %su& vsphere.get_service_instance_via_proxyu vsphere.get_host_cacheRs u oldu newu! vsphere.list_datastores_via_proxyt datastore_namesu vsphere.list_diskst scsi_addressesu backing_disk_scsi_addru8 Disk with scsi address '{0}' was not found in host '{1}'i u {0} (id:{1})u scsi_addressu idu backing_disk = %su: State {0} will erase the backing disk '{1}' on host '{2}'.i����u vsphere.erase_disk_partitionsRw u( Erased backing disk '{0}' on host '{1}'.uR State {0} will create the datastore '{1}', with backing disk '{2}', on host '{3}'.u vsphere.list_disk_partitionsu partitions = %su formatu mbru, Backing disk '{0}' has unexpected partitionsu vsphere.create_vmfs_datastoreu vmfs_versionuB Created vmfs datastore '{0}', backed by disk '{1}', on host '{2}'.u backing_disku backing_disk_idsu+ Datastore '{0}' doesn't have a backing diskuJ Datastore '{0}' is not backed by the correct disk: expected '{1}'; got {2}u , u '{0}'u] Datastore '{0}' already exists on host '{1}' and is backed by disk '{2}'. Nothing to be done.u existing_datastore = %su %g Y@u capacityi u raw_size = %sMiBu adjusted swap_size = %sMiBu (\d+)MiBu {}GiBu> State {0} will configure the host cache on host '{1}' to: {2}.u datastore_nameg �@ua Capacity of host cache datastore '{0}' ({1} MiB) is smaller than the required swap size ({2} MiB)u vsphere.configure_host_cachet
swap_size_MiBu$ Host cache configured on host '{0}'.uM Host cache on host '{0}' is already correctly configured. Nothing to be done.u vsphere.disconnectu
u
Error: %s.u {}.Ng 0Ag 0A( Ry R{ R R Rz R R R R R� R R| R} R~ R R� R t ret matcht intt groupR R R R� t lenR R R� R R R# (! R R t datastoret swap_sizet dedicated_backing_diskt erase_backing_diskR� R� R R� t
needs_settingR� R' R� R� R� t mt swap_size_valuet swap_typet
host_cachet existing_datastorest existing_diskst backing_diskt backing_disk_displayt existing_datastoret
partitionst pt non_mbr_partitionst diskt raw_size_MiBR� t existing_swap_size_MiBR/ ( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt host_cache_configured sX J
3
0 "
c C@ s= i d d 6d d 6d d 6d d 6d d
6d d 6} | j | � S(
ul
Helper function that looks up syslog_config keys available from
``vsphere.get_syslog_config``.
u Default Network Retry Timeoutu default-timeoutu Local Log Outputu logdiru# Local Logging Default Rotation Sizeu default-sizeu Log To Unique Subdirectoryu
logdir-uniqueu Local Logging Default Rotationsu default-rotateu Remote Hostu loghost( R ( t configt lookup( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyRd > s
c C@ s. | j � | j d d � | j d d � | S( u�
Strips an SSH key string of white space and line endings and returns the new string.
key_string
The string to be stripped.
u
u u
( t stript replace( t
key_string( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyRJ M s
(3 t __doc__t
__future__R R R t loggingt sysR� t salt.extR t salt.utils.filesRL t salt.exceptionsR R R R R R t salt.utils.decoratorsR
t salt.config.schemas.esxiR R R} R t HAS_JSONSCHEMAt ImportErrorR t getLoggert __name__Ry t pyVmomiR
t
versionMapt version_infoR� t HAS_PYVMOMIR R, R0 R R< R? RF R[ Rr R� R� Rd RJ ( ( ( s4 /usr/lib/python2.7/site-packages/salt/states/esxi.pyt <module>] sl .
-
� 3 � H c � � � � #
Mini Shell