Current File : //lib/python2.7/site-packages/salt/modules/virt.pyo
�
���^c @@ ss 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 Z d d l Z d d l
Z
d d l 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 Z y& d d l Z d d l m Z e Z Wn e k
re Z n Xd d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l! Z d d l" Z d d l# m$ Z$ m% Z% d d l& m' Z' d d l( m) Z) e j* e+ � Z, e j- d e j. e j/ j0 e j1 j2 j3 d
� � � Z4 i d d 6d d 6d d
6d d 6d d 6d d 6d d 6Z5 d � Z6 d � Z7 d � Z8 d � Z9 d � Z: d � Z; d � Z< d � Z= d � Z> d � Z? d � Z@ d � ZA d! � ZB d" � ZC d# � ZD eE d$ � ZF d% � ZG eE d& � ZH eE eE eE eE eE eE eE eE eE d' � ZI d( � ZJ e d) d* � ZK eE eE eE eE d+ � ZL d, � ZM eE d- � ZN eE d. � ZO eE eE d/ � ZP eE d0 eE eE e d0 eE d) e e eE eE d1 e e eE eE eE d2 � ZQ d3 � ZR d4 � ZS d5 � ZT d6 � ZU d7 � ZV d8 � ZW d9 � ZX d d eE eE eE eE eE e d: � ZY d; � ZZ d< � Z[ d= � Z\ eE d> � Z] eE d? � Z^ d@ � Z_ dA � Z` dB � Za dC � Zb dD � Zc dE � Zd e dF � Ze e dG � Zf dH � Zg dI � Zh dJ � Zi dK � Zj dL � Zk dM � Zl eE dN � Zm dO � Zn dP � Zo dQ � Zp dR � Zq dS � Zr dT � Zs dU � Zt dV � Zu dW � Zv dX � Zw dY � Zx dZ � Zy d[ � Zz d\ � Z{ e d] � Z| e d^ � Z} e d_ � Z~ e d` � Z da db � Z� dc � Z� e eE dd � Z� de � Z� df � Z� dg � Z� dh � Z� di � Z� dj � Z� dk � Z� eE dl � Z� eE dm � Z� eE dn � Z� e do � Z� eE dp � Z� eE eE dq � Z� dr � Z� eE e ds � Z� dt � Z� du � Z� dv � Z� dw � Z� dx � Z� dy � Z� dz � Z� d{ � Z� d| � Z� d} � Z� eE eE eE eE d~ � Z� e e d d� � Z� d� � Z� d� � Z� eE d� � Z� d� � Z� d� � Z� d� � Z� da d� � Z� eE eE eE eE eE eE eE eE eE e e d� � Z� d� � Z� eE d� � Z� d� � Z� d� � Z� d� � Z� d� � Z� e d� � Z� d� � Z� da d� � Z� d� � Z� d S(� u�
Work with virtual machines managed by libvirt
:depends: libvirt Python module
Connection
==========
The connection to the virtualization host can be either setup in the minion configuration,
pillar data or overridden for each individual call.
By default, the libvirt connection URL will be guessed: the first available libvirt
hypervisor driver will be used. This can be overridden like this:
.. code-block:: yaml
virt:
connection:
uri: lxc:///
If the connection requires an authentication like for ESXi, this can be defined in the
minion pillar data like this:
.. code-block:: yaml
virt:
connection:
uri: esx://10.1.1.101/?no_verify=1&auto_answer=1
auth:
username: user
password: secret
Connecting with SSH protocol
----------------------------
Libvirt can connect to remote hosts using SSH using one of the ``ssh``, ``libssh`` and
``libssh2`` transports. Note that ``libssh2`` is likely to fail as it doesn't read the
``known_hosts`` file. Libvirt may also have been built without ``libssh`` or ``libssh2``
support.
To use the SSH transport, on the minion setup an SSH agent with a key authorized on
the remote libvirt machine.
Per call connection setup
-------------------------
.. versionadded:: 2019.2.0
All the calls requiring the libvirt connection configuration as mentioned above can
override this configuration using ``connection``, ``username`` and ``password`` parameters.
This means that the following will list the domains on the local LXC libvirt driver,
whatever the ``virt:connection`` is.
.. code-block:: bash
salt 'hypervisor' virt.list_domains connection=lxc:///
The calls not using the libvirt connection setup are:
- ``seed_non_shared_migrate``
- ``virt_type``
- ``is_*hyper``
- all migration functions
- `libvirt ESX URI format <http://libvirt.org/drvesx.html#uriformat>`_
- `libvirt URI format <http://libvirt.org/uri.html#URI_config>`_
- `libvirt authentication configuration <http://libvirt.org/auth.html#Auth_client_config>`_
i ( t absolute_importt print_functiont unicode_literalsN( t ElementTree( t libvirtError( t CommandExecutionErrort SaltInvocationError( t six( t ranget loaderu virtu runningi i u pausedi u shutdowni i u crashedi c C@ s t s t d f Sd S( Nu2 Unable to locate or import python libvirt library.u virt( t HAS_LIBVIRTt False( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt __virtual__� s
c @ s � � f d � } d S( um
Get libvirt.openAuth callback with username, password values overriding
the configuration ones.
c @ s� x� | D]� } | d t j k rJ � r, � n t d d | d � | d <q | d t j k r� � ri � n t d d | d � | d <q t j d | d � q Wd S( u0 Callback method passed to libvirt.openAuth().
The credentials argument is a list of credentials that libvirt
would like to request. An element of this list is a list containing
5 items (4 inputs, 1 output):
- the credential type, e.g. libvirt.VIR_CRED_AUTHNAME
- a prompt to be displayed to the user
- a challenge
- a default result for the request
- a place to store the actual result for the request
The user_data argument is currently not set in the openAuth call.
i u
config.getu virt:connection:auth:usernamei i u virt:connection:auth:passwordu Unhandled credential type: %s( t libvirtt VIR_CRED_AUTHNAMEt __salt__t VIR_CRED_NOECHOPROMPTt logt info( t credentialst user_datat
credential( t passwordt username( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt __request_auth� s
N( ( R R R ( ( R R s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt __get_request_auth� s c K@ s� | j d d � } | j d d � } | j d d � } | s� t d d d � } | d k rt t j j j d d � n8 t d d d � } | d k r� t j j j d d � n t d d
| � } n t d d d � } | d k r� t j j j d d � n | d
k r1| d k r1t j j j d d � d } n yO t j t j t j
t j t j g } t j
| | t | | � d g d � } Wn- t k
r�t d j t d | � � � n X| S( u=
Detects what type of dom this node is and attempts to connect to the
correct hypervisor via libvirt.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
u usernameu passwordu
connectionu
config.getu virt.connectu Sodiumu� 'virt.connect' configuration property has been deprecated in favor of 'virt:connection:uri'. 'virt.connect' will stop being used in {version}.u libvirt:connectionu� 'libvirt.connection' configuration property has been deprecated in favor of 'virt:connection:uri'. 'libvirt.connection' will stop being used in {version}.u virt:connection:uriu libvirt:hypervisoru� 'libvirt.hypervisor' configuration property has been deprecated. Rather use the 'virt:connection:uri' to properly define the libvirt URI or alias of the host to connect to. 'libvirt:hypervisor' will stop being used in {version}.u esxiu� esxi hypervisor default with no default connection URI detected, please set 'virt:connection:uri' to 'esx' for keep the legacy behavior. Will default to libvirt guess once 'libvirt:hypervisor' configuration is removed in {version}.u esxi uH Sorry, {0} failed to open a connection to the hypervisor software at {1}u fqdnN( t gett NoneR t saltt utilst versionst
warn_untilR
R R t VIR_CRED_ECHOPROMPTt VIR_CRED_PASSPHRASEt VIR_CRED_EXTERNALt openAuthR t ExceptionR t formatt
__grains__( t kwargsR R t conn_strt
hypervisort
auth_typest conn( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
__get_conn� sL
+
c O@ s_ t � } t � } g } | j d t � r` x3 | j � D]" } | j | j | � j � � q7 Wn | j d t � r� x$ | j � D] } | j | � q Wn | s� t d � � n | r� xQ | D]: } | | k r� t d j d | � � � q� | j | � q� Wn t | � } x$ | D] } | j | j
| � � qWt | � d k r[| j d � r[| d p^| S( u�
Return a domain object for the named VM or return domain object for all VMs.
:params conn: libvirt connection object
:param vms: list of domain names to look for
:param iterable: True to return an array in all cases
u activeu inactiveu No virtual machines found.u The VM "{name}" is not presentt namei u iterablei ( t listR t Truet
listDomainsIDt appendt
lookupByIDR- t listDefinedDomainsR R% t lookupByNamet len( R+ t vmsR' t rett
lookup_vmst all_vmst id_R- ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_domain� s( #
c
C@ s� t j j j | � } g } xV| D]N} i | d d 6| d d 6| d d 6| d d 6d | k rm | d n d d
6} d | j � k r� t | d � | d <n d
| j � k rcg | d
D]� } i | d d 6| d d 6| d d 6t j j t d j | d | d � � � j
� d 6t j j t d j | d | d � � � j � j
� d 6^ q� | d
<n | j
| � q" Wxy | D]q } d | j � k r{g | D]2 } d | j � k r�| d | d k r�| ^ q�} | r�| d | d <q�q{q{W| d S( uD
Parse qemu-img info JSON output into disk infos dictionary
u filenameu fileu formatu file formatu actual-sizeu disk sizeu virtual-sizeu virtual sizeu cluster-sizeu cluster sizeu full-backing-filenameu backing fileu snapshotsu idu nameu tagu
vm-state-sizeu vmsizeu {}.{}u date-secu date-nsecu dateu vm-clock-secu
vm-clock-nsecu vmclocki N( R R t jsont loadsR t keysR% t datetimet
fromtimestampt floatt isoformatt utcfromtimestampt timeR1 ( R t raw_infost diskst
disk_infost diskt snapshott
candidates( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_qemu_img_info s*
�
?c C@ s t j t | � � j d � j S( u~
Return a uuid from the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_uuid <domain>
u uuid( R t
fromstringt get_xmlt findt text( t dom( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_uuidD s
c C@ s5 t j t | � � j d � } | d k r1 | j Sd S( u�
Return `on_poweroff` setting from the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_on_restart <domain>
u on_poweroffu N( R RL RM RN R RO ( RP t node( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_on_poweroffQ s
c C@ s5 t j t | � � j d � } | d k r1 | j Sd S( u�
Return `on_reboot` setting from the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_on_reboot <domain>
u on_rebootu N( R RL RM RN R RO ( RP RR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_on_reboot_ s
c C@ s5 t j t | � � j d � } | d k r1 | j Sd S( u�
Return `on_crash` setting from the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_on_crash <domain>
u on_crashu N( R RL RM RN R RO ( RP RR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_get_on_crashm s
c C@ s� i } t j | j d � � } x�| j d � D]y} i } | j d � | d <x7| D]/} | j d k r | j d � | d <n | j d k r� | j d � | d <n | j d k r� | j d � | d <n t j d | j � r!i } x* t j | j
� D] \ } } | | | <q� W| | | j <n | j d
k rT i } | j d � | d <x* t j | j
� D] \ } } | | | <q\W| | d
<qT qT Wd | k r�q. n | | | d <q. W| S( uE
Get domain network interfaces from a libvirt domain object.
i u devices/interfaceu typeu macu addressu modelu targetu devu (driver|source|address)u virtualport( R RL t XMLDesct findallR t tagt ret matchR t iteritemst attrib( RP t nicst doct
iface_nodet nict v_nodet tempt keyt value( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_nics{ s6
c C@ s� i d d 6d d 6d d 6d d 6d d 6} t j | j d � � } xD | j d � D]3 } x* t j | j � D] \ } } | | | <qj WqQ W| S( u;
Get domain graphics from a libvirt domain object.
u Noneu autoportu keymapu listenu portu typei u devices/graphics( R RL RV RW R R[ R\ ( RP t outR^ t g_nodeRc Rd ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_get_graphics� s
c C@ s i } t j | j d � � } x�| j d � D]�} | j d � } | d k rU q. n | j d � } | d k rv q. n d | j k r. | j d d � } | s� | j d d � } n | r� d | j k r� d | j k r� d
j | j d � | j d � � } n | s
q. n i | d 6| j d � d 6} | j d
� } | d k r�| j d � d k r�yp t j
d d d d d | d g d t d t j �j
� d } t j j j | � }
t |
� } | j | � Wq�t k
r�| j i d d 6� q�Xn | | | j d � <q. q. W| S( u8
Get domain disks from a libvirt domain object.
i u devices/disku sourceu targetu devu fileu u protocolu nameu {0}:{1}u deviceu typeu driveru qcow2u qemu-imgu infou --outputu jsonu --backing-chaint shellt stdoutu Does not existN( R RL RV RW RN R R\ R R% t
subprocesst PopenR t PIPEt communicateR R t stringutilst to_strRK t updatet TypeError( RP RF R^ t elemt sourcet targett qemu_targetRH t driverRj t qemu_outputt output( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_get_disks� sD % !
c C@ s� d } d } yN t j | d t d t j �j � d } t j j j | � j d � d } Wn t
k
rs d } n XyN t j | d t d t j �j � d } t j j j | � j d � d } Wn t
k
r� d } n Xi | d 6| d
6S( uL
Returns the user and group that the disk images should be owned by
u% grep ^\s*group /etc/libvirt/qemu.confu$ grep ^\s*user /etc/libvirt/qemu.confRi Rj i u "i u rootu useru group( Rk Rl R/ Rm Rn R R Ro Rp t splitt
IndexError( t g_cmdt u_cmdRj t groupt user( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _libvirt_creds� s" &
&
c C@ sM t d d � } | r/ t j j j d d � n t d d � } | rI d Sd S( uE
Returns the command shared by the different migration types
u
config.optionu virt.tunnelu Sodiumum 'virt.tunnel' has been deprecated in favor of 'virt:tunnel'. 'virt.tunnel' will stop being used in {version}.u
config.getu virt:tunneluE virsh migrate --p2p --tunnelled --live --persistent --undefinesource u3 virsh migrate --live --persistent --undefinesource ( R R R R R ( t tunnel( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_migrate_command� s
c C@ s, d } | r | d 7} n d j | | d � S( u8
Compute libvirt URL for target migration host.
u qemuu +sshu {0}://{1}/{2}u system( R% ( Ru t ssht proto( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_target s
c K@ s� t | � d } i | d 6| d 6t j | � d 6t j | � d 6}
| d7 k r] t |
d <n | d k rv d
|
d <n | r� d | k r� i d d
6d d 6| d <n5 d | d k r� | d d
d k r� d | d d <n | j d
d � d k r� d8 } q� n | |
d <d | k rKg |
d <x9 | d j � D] } |
d j | � q-Wn
d g |
d <| d k r�t d d k r�d |
d <g |
d <q�n d | k r�| d |
d <n d |
k r�|
d d k r�d | k r�| d |
d <q�d |
d <n d |
k r'd | k r| d |
d <q't |
d <n g |
d <i d d 6d d 6d! d" 6d d# 6} xt
| � D]� \ }
} | j | d$ d% � } i | j d& d' � d& 6d( j | t j
|
� d) 6| d$ d* 6| d+ d
6t j |
� d, 6} d- r�| d- r�| d- | d- <n | d9 k r t | d <t | d/ <n# | d: k rBt | d <t | d/ <n |
d j | � q`W| |
d1 <| |
d2 <| |
d3 <d4 } y t j | � } Wn( t j j k
r�t j d5 | � d6 SX| j |
� S(; u8
Generate the XML string to define a libvirt VM
i u
hypervisoru nameu cpuu memu qemuu kvmu controller_modelu vmwareu lsilogicu listenu addressu typeu 0.0.0.0u noneu graphicsu boot_devu hdu xenu os_familyu Suseu" /usr/lib/grub2/x86_64-xen/grub.xenu kernelu serial_typeu tcpu telnet_porti�Y u consoleu disksu vdu virtiou xvdu fdu fdcu ideu modelu sdu deviceu disku {0}{1}u
target_devu disk_busu formatu indexu source_fileu bhyveu driveru esxiu nicsu os_typeu archu libvirt_domain.jinjau Could not load template %su ( u qemuu kvmN( u qemuu kvmu bhyveu xen( u esxiu vmware( t intR t text_typeR R R R{ R1 R& R/ t enumerateR% t stringt ascii_lowercaset JINJAt get_templatet jinja2t
exceptionst TemplateNotFoundR t errort render( R- t cput memt diskpt nicpR) t os_typet archt graphicsR' t contextt devt disk_bus_mapt iRH t prefixt disk_contextt fn_t template( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _gen_xml s�
$
"
c C@ s� t | � d } i | d 6d j | | � d 6| d 6| d 6t j | � d 6| d 6} d } y t j | � } Wn( t j j k
r� t j
d
| � d SX| j | � S( uD
Generate the XML string to define a libvirt storage volume
i u nameu {0}.{1}u filenameu volnameu disktypeu sizeu poolu libvirt_volume.jinjau Could not load template %su ( R� R% R R� R� R� R� R� R� R R� R� ( t vmnamet disknamet disktypet sizet poolR� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _gen_vol_xmlr s
c C@ sz i | d 6| d 6| d 6| d 6| d 6} d } y t j | � } Wn( t j j k
rl t j d | � d SX| j | � S( u=
Generate the XML string to define a libvirt network
u nameu bridgeu forwardu vportu tagu libvirt_network.jinjau Could not load template %su ( R� R� R� R� R� R R� R� ( R- t bridget forwardt vportRX R� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _gen_net_xml� s
c C@ s! g | p g D] } | j d � ^ q
} i | d 6| d 6i | d 6| d 6d 6i | pZ g d 6| d 6| d 6g | D]: } i | d
d 6t | � d k r� | d n d d 6^ qs d
6| d 6| d 6|
d 6d 6}
d } y t j | � } Wn( t j j k
rt j d | � d SX| j
|
� S( uB
Generate the XML string to define a libvirt storage pool
u :u nameu ptypeu pathu permissionsu targetu devicesu diru adapteri i u portu hostsu authu formatu sourceu libvirt_pool.jinjau Could not load template %su N( R{ R5 R R� R� R� R� R� R R� R� ( R- t ptypeRu t permissionst source_devicest
source_dirt source_adaptert source_hostst source_autht source_namet
source_formatt hostt hostsR� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_gen_pool_xml� s( (
Hc C@ sS t d d � } | r/ t j j j d d � n t d d � } t j d | � | S( u
Extract the images dir from the configuration. First attempts to
find legacy virt.images, then tries virt:images.
u
config.optionu virt.imagesu Sodiumum 'virt.images' has been deprecated in favor of 'virt:images'. 'virt.images' will stop being used in {version}.u
config.getu virt:imagesu6 Image directory from config option `virt:images` is %s( R R R R R R t debug( t img_dir( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_images_dir� s
u basec C@ s | j d d � } | j d d � } | rN | rN t d j | d � � � n | d } t j d | � t j j | � } t j d | � t j j | � s� t j
| � n | rJt j d | � t d | | � } t } t
j j j d
� r1t d d j | � � } t
j j j | � }
|
d
d k } n y� | rs| rst j d | � t d d j | | � j � � n) t j d | | � t
j j j | | � t
j j j � } | r�| r�t j d | � t d d j | | � � n t j d � d | Ad @} t j | | � Wqt t f k
rF}
t d j | |
� � � qXn� y� t
j j j � } | r�t j d | � t d d j | j d d � | | � � n t d j | � � � t j d � d | Ad @} t j | | � Wn1 t t f k
r}
t d j | |
� � � n X| S( uv
Create the image file using specified disk_size or/and disk_image
Return path to the created image file
u sizeu imageuR Unable to create new disk {0}, please specify disk size and/or disk image argumentu filenameu source_fileu Image destination will be %su! Image destination directory is %su# Create disk from specified image %su
cp.cache_fileu qemu-imgu cmd.runu qemu-img info "{}"u file formatu qcow2u* Cloning qcow2 image %s using copy on writeu4 qemu-img create -f qcow2 -o backing_file="{0}" "{1}"u Copying %s to %su Resize qcow2 image to %sMu qemu-img resize "{0}" {1}Mu Apply umask and remove exec biti� i� u& Problem while copying image. {0} - {1}u Create empty image with size %sMu! qemu-img create -f {0} "{1}" {2}Mu formatu= Unable to create new disk {0}, please specify <size> argumentu' Problem while creating volume {0} - {1}N( R R R R% R R� t ost patht dirnamet existst makedirsR R R R t whicht yamlt safe_loadR R{ t filest copyfilet get_umaskt chmodt IOErrort OSError( RH t create_overlayt saltenvt disk_sizet
disk_imaget img_destR� t sfnt qcow2t rest imageinfot maskt modet err( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _qemu_image_create� sv
c K@ s� i i d d 6d 6g } | d k r] i d d 6d d 6d d
6d j | rM | n d � d
6} nZ | d k r� i d d 6d d
6d d 6} n0 | d k r� i d d 6d d
6d d 6} n i } g } | rqt j t d d i � j | | � � } g | D]1 }
|
j � D] \ } } t | d | �^ qq� } | rqt j d | | d d | d j d d � � | | d d <qqn | r�xt | D]i }
d |
k r~g | D] }
|
d |
d k r�|
^ q�} | r�| d j |
� q�| j
|
� q~q~Wn x� | D]� }
x6 t j | � D]% \ } } | |
k r | |
| <q q Wd |
k rg|
d rgt
j j |
d � |
d <q�d |
k r�t | |
| | � q�q�W| S( u�
Gather the disk profile from the config or apply the default based
on the active hypervisor
This is the ``default`` profile for KVM/QEMU, which can be
overridden in the configuration:
.. code-block:: yaml
virt:
disk:
default:
- system:
size: 8192
format: qcow2
model: virtio
Example profile for KVM/QEMU with two disks, first is created
from specified image, the second is empty:
.. code-block:: yaml
virt:
disk:
two_disks:
- system:
size: 8192
format: qcow2
model: virtio
image: http://path/to/image.qcow2
- lvm:
size: 32768
format: qcow2
model: virtio
The ``format`` and ``model`` parameters are optional, and will
default to whatever is best suitable for the active hypervisor.
i u sizeu systemu vmwareu vmdku formatu scsiu modelu disku deviceu [{0}] u 0u poolu qemuu kvmu qcow2u virtiou xenu
config.getu virt:diskR- uG %s image from module arguments will be used for disk "%s" instead of %si u nameu imageu u source_fileu filename( u qemuu kvm( R% t copyt deepcopyR R t itemst dictR R� Rq R1 R R[ R� R� t basenamet _fill_disk_filename( t profileR) RF t vm_namet imageR� R' t defaultt overlayt disklistRH R- t dt udiskt foundRc t val( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_disk_profile: sR '
"
"> %
-
c K@ s | j d d � } | d k r� | s0 t � } q� | j d � s� t | | � } | | k rd | | n d } | s� | d s� | d j d � r� t d j | d | � � � n | d } q� n | rd
j | | d | d � | d <t j j | | d � | d
<n d S( uE
Compute the disk file name and update it in the disk value.
u poolu qemuu kvmu xenu /u target_pathu /devuR Unable to create new disk {0}, specified pool {1} does not exist or is unsupportedu nameu {0}_{1}.{2}u formatu filenameu source_fileN( u qemuu kvmu xen(
R R R� t
startswitht pool_infoR R% R� R� t join( R� RH R) R' t base_dirt infosR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� � s %!c
@ s� i d d 6d d 6d d 6} i d d 6d d 6d d 6} i d d 6d d 6d d 6} i | d 6| d
6| d 6| d 6� d
� } � � f d � } � f d � } xY | D]Q } | | � | j d d � d k r� | | � � n � � k r� | | � q� q� W| S( u7
Complete missing data for network interfaces.
u bridgeu typeu DEFAULTu sourceu e1000u modelu br0u virtiou xenu kvmu qemuu vmwarec S@ ss x@ d d g D]2 } | | k r
| | d <| j | � | d <q
q
W| j d d � | d <| j d d � | d <d S( u�
Guess which style of definition:
bridge: br0
or
network: net0
or
type: network
source: net0
u bridgeu networku typeu sourceN( t popR R ( t
attributest type_( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _normalize_net_types� s
c @ sL xE t j � � � D]0 \ } } | | k s7 | | r | | | <q q Wd S( u9
Apply the default overlay to attributes
N( R R[ ( R� Rc Rd ( R) t overlays( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _apply_default_overlay� s c @ s� � d k r_ t j d � � t j j j j � � rA � | d <q� d j � � } t | � � nA | d k r� t j j
j d d � | d <n t j j
j � | d <d S(
uE
Compute mac address for NIC depending on hypervisor
u Default MAC address is %su macu Malformed MAC address: {0}u qemuu kvmR� u 52:54:00N( u qemuu kvm( R R R� R R t validatet nett macR% R t networkt gen_mac( R� R) t msg( t dmac( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _assign_mac� s
u macN( R R (
t
interfacesR) R� t vmware_overlayt kvm_overlayt xen_overlayR� R� R� t interface( ( R� R) R� s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _complete_nics� s$
c @ s i i d 6g } t d d i � j | d � } | d k rT t j j j d d � n t d d i � j | | � } g � � f d � } t | t � r� | | � na t | t � rxO | D]D } t | t � r� t
| � d k r� | | � q� � j | � q� q� Wn t � | d
| �S( u+
Compute NIC data based on profile
u eth0u
config.optionu virt.nicu Sodiumud 'virt.nic' has been deprecated in favor of 'virt:nic'. 'virt.nic' will stop being used in {version}.u
config.getu virt:nicc @ s; x4 t j | � D]# \ } } | | d <� j | � q Wd S( uC
Append dictionary profile data to interfaces list
u nameN( R R[ R1 ( t profile_dictt interface_nameR� ( R� ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt% append_dict_profile_to_interface_list s
i R� N(
R R R R R R R t
isinstanceR� R. R5 R1 R ( t profile_nameR) R� R� t config_dataR R� ( ( R� s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _nic_profile s(
c C@ s� | r t | | d | �n g } t j d | � | r� t | | � } xb | D]Z } g | D] } | d | d k rZ | ^ qZ } | r� | d j | � qM | j | � qM Wt j d | � n | S( uT
Get network devices from the profile and merge uer defined ones with them.
R� u NIC profile is %su namei u Merged NICs: %s( R R R� R Rq R1 ( R) R� R� R� R� t
users_nicst unicR` R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _get_merged_nicsL s !
-u defaultu
seed.applyc & K@ s� t | � } t d � | d D� � } t d � | d D� � } | r� t d d | � } | t k r t j j j d d � nW t d � g | d D] } | d d
j � ^ q� D� � } d | k r� d n | d } n | d
k r� d n | } t j
d | � | j d t � } | r2t j j j d d � n t | | | d | �} | j d t � } | r{t j j j d d � n | r�t j j j d d � n t
| | | | d | d | | �} x�| D]�} t j
d | | � | d k rJd | k rt d � � nB t j
d | � t | | d | d | d | d � } t | � n| d d d g k rG| }! |! r�t j j j d d! � n | j d" t � }! | d# r�t j j | d# � r�| d# }" n t | |! |
� }" n t }" | o�|" o�| j d t � rDt j
d$ | � t | |" d% | d& | j d' � d( | d) |
d* | �n n t d+ j | � � � q�Wt j
d, � | r�t j j j d d- � i d. d/ 6} n | t k r�d0 | k r�d0 n | d } n | t k r�d1 | k r�d1 n | d } n t | | | | | | | | | | � }# t | � }$ y |$ j |# � WnQ t k
r�}% d2 j | � t j |% � k rst j |% � n |$ j � |% � n X| r�t j
d3 | � t |$ | � j � n |$ j � t! S(4 u�$
Initialize a new vm
:param name: name of the virtual machine to create
:param cpu: Number of virtual CPUs to assign to the virtual machine
:param mem: Amount of memory to allocate to the virtual machine in MiB.
:param image: Path to a disk image to use as the first disk (Default: ``None``).
Deprecated in favor of the ``disks`` parameter. To set (or change) the image of a
disk, add the following to the disks definitions:
.. code-block:: python
{
'name': 'name_of_disk_to_change',
'image': '/path/to/the/image'
}
:param nic: NIC profile to use (Default: ``'default'``).
The profile interfaces can be customized / extended with the interfaces parameter.
If set to ``None``, no profile will be used.
:param interfaces:
List of dictionaries providing details on the network interfaces to create.
These data are merged with the ones from the nic profile. The structure of
each dictionary is documented in :ref:`init-nic-def`.
.. versionadded:: 2019.2.0
:param hypervisor: the virtual machine type. By default the value will be computed according
to the virtual host capabilities.
:param start: ``True`` to start the virtual machine after having defined it (Default: ``True``)
:param disk: Disk profile to use (Default: ``'default'``). If set to ``None``, no profile will be used.
:param disks: List of dictionaries providing details on the disk devices to create.
These data are merged with the ones from the disk profile. The structure of
each dictionary is documented in :ref:`init-disk-def`.
.. versionadded:: 2019.2.0
:param saltenv: Fileserver environment (Default: ``'base'``).
See :mod:`cp module for more details <salt.modules.cp>`
:param seed: ``True`` to seed the disk image. Only used when the ``image`` parameter is provided.
(Default: ``True``)
:param install: install salt minion if absent (Default: ``True``)
:param pub_key: public key to seed with (Default: ``None``)
:param priv_key: public key to seed with (Default: ``None``)
:param seed_cmd: Salt command to execute to seed the image. (Default: ``'seed.apply'``)
:param enable_vnc:
``True`` to setup a vnc display for the VM (Default: ``False``)
Deprecated in favor of the ``graphics`` parameter. Could be replaced with
the following:
.. code-block:: python
graphics={'type': 'vnc'}
.. deprecated:: 2019.2.0
:param graphics:
Dictionary providing details on the graphics device to create. (Default: ``None``)
See :ref:`init-graphics-def` for more details on the possible values.
.. versionadded:: 2019.2.0
:param os_type:
type of virtualization as found in the ``//os/type`` element of the libvirt definition.
The default value is taken from the host capabilities, with a preference for ``hvm``.
.. versionadded:: 2019.2.0
:param arch:
architecture of the virtual machine. The default value is taken from the host capabilities,
but ``x86_64`` is prefed over ``i686``.
.. versionadded:: 2019.2.0
:param enable_qcow:
``True`` to create a QCOW2 overlay image, rather than copying the image
(Default: ``False``).
Deprecated in favor of ``disks`` parameter. Add the following to the disks
definitions to create an overlay image of a template disk image with an
image set:
.. code-block:: python
{
'name': 'name_of_disk_to_change',
'overlay_image': True
}
.. deprecated:: 2019.2.0
:param pool:
Path of the folder where the image files are located for vmware/esx hypervisors.
Deprecated in favor of ``disks`` parameter. Add the following to the disks
definitions to set the vmware datastore of a disk image:
.. code-block:: python
{
'name': 'name_of_disk_to_change',
'pool': 'mydatastore'
}
.. deprecated:: Flurorine
:param dmac:
Default MAC address to use for the network interfaces. By default MAC addresses are
automatically generated.
Deprecated in favor of ``interfaces`` parameter. Add the following to the interfaces
definitions to force the mac address of a NIC:
.. code-block:: python
{
'name': 'name_of_nic_to_change',
'mac': 'MY:MA:CC:ADD:RE:SS'
}
.. deprecated:: 2019.2.0
:param config: minion configuration to use when seeding.
See :mod:`seed module for more details <salt.modules.seed>`
:param boot_dev: String of space-separated devices to boot from (Default: ``'hd'``)
:param serial_type: Serial device type. One of ``'pty'``, ``'tcp'`` (Default: ``None``)
:param telnet_port: Telnet port to use for serial device of type ``tcp``.
:param console: ``True`` to add a console device along with serial one (Default: ``True``)
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. _init-nic-def:
.. rubric:: Network Interfaces Definitions
Network interfaces dictionaries can contain the following properties:
name
Name of the network interface. This is only used as a key to merge with the profile data
type
Network type. One of ``'bridge'``, ``'network'``
source
The network source, typically the bridge or network name
mac
The desired mac address, computed if ``None`` (Default: ``None``).
model
The network card model (Default: depends on the hypervisor)
.. _init-disk-def:
.. rubric:: Disks Definitions
Disk dictionaries can contain the following properties:
name
Name of the disk. This is mostly used in the name of the disk image and as a key to merge
with the profile data.
format
Format of the disk image, like ``'qcow2'``, ``'raw'``, ``'vmdk'``.
(Default: depends on the hypervisor)
size
Disk size in MiB
pool
Path to the folder or name of the pool where disks should be created.
(Default: depends on hypervisor)
model
One of the disk busses allowed by libvirt (Default: depends on hypervisor)
See the libvirt `disk element`_ documentation for the allowed bus types.
image
Path to the image to use for the disk. If no image is provided, an empty disk will be created
(Default: ``None``)
overlay_image
``True`` to create a QCOW2 disk image with ``image`` as backing file. If ``False``
the file pointed to by the ``image`` property will simply be copied. (Default: ``False``)
source_file
Absolute path to the disk image to use. Not to be confused with ``image`` parameter. This
parameter is useful to use disk images that are created outside of this module. Can also
be ``None`` for devices that have no associated image like cdroms.
device
Type of device of the disk. Can be one of 'disk', 'cdrom', 'floppy' or 'lun'.
(Default: ``'disk'``)
.. _init-graphics-def:
.. rubric:: Graphics Definition
The graphics dictionnary can have the following properties:
type
Graphics type. The possible values are ``none``, ``'spice'``, ``'vnc'`` and other values
allowed as a libvirt graphics type (Default: ``None``)
See the libvirt `graphics element`_ documentation for more details on the possible types.
port
Port to export the graphics on for ``vnc``, ``spice`` and ``rdp`` types.
tls_port
Port to export the graphics over a secured connection for ``spice`` type.
listen
Dictionary defining on what address to listen on for ``vnc``, ``spice`` and ``rdp``.
It has a ``type`` property with ``address`` and ``None`` as possible values, and an
``address`` property holding the IP or hostname to listen on.
By default, not setting the ``listen`` part of the dictionary will default to
listen on all addresses.
.. rubric:: CLI Example
.. code-block:: bash
salt 'hypervisor' virt.init vm_name 4 512 salt://path/to/image.raw
salt 'hypervisor' virt.init vm_name 4 512 /var/lib/libvirt/images/img.raw
salt 'hypervisor' virt.init vm_name 4 512 nic=profile disk=profile
The disk images will be created in an image folder within the directory
defined by the ``virt:images`` option. Its default value is
``/srv/salt-images/`` but this can changed with such a configuration:
.. code-block:: yaml
virt:
images: /data/my/vm/images/
.. _disk element: https://libvirt.org/formatdomain.html#elementsDisks
.. _graphics element: https://libvirt.org/formatdomain.html#elementsGraphics
c S@ s h | ] } | d � q S( u os_type( ( t .0t guest( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys <setcomp>e s u guestsc S@ s h | ] } | d d � q S( u archu name( ( R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys <setcomp>f s u
config.getu libvirt:hypervisoru Sodiumu� 'libvirt:hypervisor' configuration property has been deprecated. Rather use the 'virt:connection:uri' to properly define the libvirt URI or alias of the host to connect to. 'libvirt:hypervisor' will stop being used in {version}.c S@ s# h | ] } | D] } | � q q S( ( ( R t yt x( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys <setcomp>t s u archu domainsu kvmi u esxiu vmwareu Using hypervisor %su dmacu� 'dmac' parameter has been deprecated. Rather use the 'interfaces' parameter to properly define the desired MAC address. 'dmac' will be removed in {version}.R� u poolu� 'pool' parameter has been deprecated. Rather use the 'disks' parameter to properly define the vmware datastore of disks. 'pool' will be removed in {version}.u� 'image' parameter has been deprecated. Rather use the 'disks' parameter to override or define the image. 'image' will be removed in {version}.R� R� u Creating disk for VM [ %s ]: %su imageuM virt.init does not support image template in conjunction with esxi hypervisoru Generating libvirt XML for %su nameu formatu sizeu qemuu xenu� 'enable_qcow' parameter has been deprecated. Rather use the 'disks' parameter to override or define the image. 'enable_qcow' will be removed in {version}.u
overlay_imageu source_fileu Seed command is %sR: t configu configt installt pub_keyt priv_keyu4 Unsupported hypervisor when handling disk image: {0}u Generating VM XMLu� 'enable_vnc' parameter has been deprecated in favor of 'graphics'. Use graphics={'type': 'vnc'} for the same behavior. 'enable_vnc' will be removed in {version}. u vncu typeu hvmu x86_64u domain '{}' already existsu Starting VM %s(" t capabilitiest sortedR R R R R R R> R R� R R
R� R R� t define_vol_xml_strR R� R� R� R� R% R� R, t defineXMLR R R� t warningt closeR; t createR/ (& R- R� R� R� R` R� R) t startRH RF R� t seedR R R t seed_cmdt
enable_vnct enable_qcowR� R� R� R' t capst os_typest archesR t hypervisorsR� R� R� R� t _diskt vol_xmlR� R� t vm_xmlR+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt init^ s� �
;
$
'
c C@ s | j d � } | j d � } | j d � d k rK t j | j d � � n d } | j d � d k r~ t j | j d � � n d } | | k o| d k o| d k o| j d � | j d � k o| j d d � | j d d � k o| j d � | j d � k S( uM
Test if two disk elements should be considered like the same device
u targetu sourceu busu deviceu disku devN( RN R R t tostringR ( t disk1t disk2t target1t target2t source1t source2( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _disks_equal s 33 $c C@ s d � } | | � | | � k S( uR
Test if two interface elements should be considered like the same device
c S@ s� i | j d d 6| j d � d k rC | j d � j | j d n d d 6| j d � d k r{ | j d � j d j � n d d 6| j d � d k r� | j d � j d n d d 6S( uC
Filter out elements to ignore when comparing nics
u typeu sourceu macu addressu modelN( R\ RN R t lower( R` ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _filter_nic s
98( ( t nic1t nic2R0 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _nics_equal s
c C@ s1 d � } t j | | � � t j | | � � k S( uK
Test if two graphics devices should be considered the same device
c S@ s� t j | � } i d d 6d d 6d d g d 6i d d 6d d 6d g d 6i d
d 6d d 6d g d 6g } xx | D]p } | j | d � } | d } | d k rp | | j k s� | j | | d k rp | j | | d d � qp qp W| S(
u�
When the domain is running, the graphics element may contain additional properties
with the default values. This function will strip down the default values.
u .u nodeu portu attribu 5900u -1u valuesu addressu 127.0.0.1u listeni N( R� R� RN R R\ t set( t gfxt gfx_copyt defaultsR� RR R\ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _filter_graphics' s !
2 ( R R' ( t gfx1t gfx2R8 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _graphics_equal# s c C@ s� d � } i g d 6g d 6g d 6g d 6} t j | � } x� | D]� } g | D]' } | | | � | | � � rN | ^ qN } | r� | j | d � | d j | d � | d j | d � qA | d j | � | d j | � qA W| | d <| S( u,
Compare lists to extract the changes
:param old: old list
:param new: new list
:return: a dictionary with ``unchanged``, ``new``, ``deleted`` and ``sorted`` keys
The sorted list is the union of unchanged and new lists, but keeping the original
order from the new list.
c S@ s< t j | � } d | _ x | j � D] } d | _ q% W| S( uM
Remove the XML indentation to compare XML trees more easily
N( R� R� R RO t itert tail( RR t node_copyt item( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _remove_indentG s
u unchangedu newu deletedu sortedi ( R� R� t removeR1 ( t oldt newt
comparatorR@ t difft old_devicest new_itemR? R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _diff_lists< s
"
4
c C@ s g } d d d d d d g } x� | D]� } | j d � } | j d � } g | D] } | j | � rP | ^ qP d } g t t | � � D]> } d
j | t j | � | k r� d
j | t j | � ^ q� d }
| j d |
� | j |
� q% Wt
| | t � S( u�
Compare disk definitions to extract the changes and fix target devices
:param old: list of ElementTree nodes representing the old disks
:param new: list of ElementTree nodes representing the new disks
u fdu hdu vdu sdu xvdu ubdu targetu devi u {0}{1}( RN R R� R R5 R% R� R� R4 R1 RH R. ( RB RC t targetst prefixesRH t target_nodeRu R? R� R� t
new_target( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _diff_disk_listsa s
,Bc C@ s� t | | t � } g | d D] } | j d � j d � ^ q } xF | d D]: } | j d � } | j d � | k rL | j | � qL qL W| S( u�
Compare network interface definitions to extract the changes
:param old: list of ElementTree nodes representing the old interfaces
:param new: list of ElementTree nodes representing the new interfaces
u unchangedu macu addressu new( RH R3 RN R RA ( RB RC RE R` t macsR� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _diff_interface_listsy s /c C@ s t | | t � S( u�
Compare graphic devices definitions to extract the changes
:param old: list of ElementTree nodes representing the old graphic devices
:param new: list of ElementTree nodes representing the new graphic devices
( RH R; ( RB RC ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _diff_graphics_lists� s c ( K@ s" i t d 6i g d 6g d 6d 6i g d 6g d 6d 6}
t | � } t | | � } t j | j d � � }
t } |
j d � } t | | | | | � } t j t | | | | t | | | � | | j
� |
j d � j d � | | � � } |
j d
� } | rIt | j
� | k rIt j | � | _
| j d t j | � � t } n xm d d
g D]_ } |
j | � } | rVt | j
� | d k rVt j | � | _
| j d d � t } qVqVW|
j d � } i d d g d 6d d g d 6d g d 6} i } x� | D]� } i | | <t � } g | | D]$ } | j | d' � d' k r#| ^ q#r�| j | � } | j d j | � � } t � d j | � | | � | | <| | d s�| | d r�x | D] } | j | � q�W| j | | d � t } q�q�q�W| r| d rzxq t | d d � D]X \ } } | | d } | | d d k r| rt j j | � rt | | � qqWn y3 | j t j j! j" t j# |
� � � t |
d <Wn& t$ j% k
r�} | j& � | � n Xg }! | j' � r0| r0| r"|! j( i d d 6d d 6| t$ j) g d! 6� n | rZ|! j( i d" d 6d# d 6| d t$ j) g d! 6� n x� d d g D]� } x[ | | j d g � D]C }" |! j( i | d 6d$ d 6t j j! j" t j# |" � � g d! 6� q�Wx[ | | j d g � D]C }# |! j( i | d 6d% d 6t j j! j" t j# |# � � g d! 6� q�WqgWn x� |! D]� }$ y� t* | |$ d � |$ d! � }% |$ d }& |& d( k r�t+ |% � |
|& <n9 i d d$ 6d d% 6}' |
|& |' |$ d j( |$ d! d � Wq7t$ j% k
r } d& |
k r�g |
d& <n |
d& j( t j | � � q7Xq7Wn | j& � |
S() up
Update the definition of an existing domain.
:param name: Name of the domain to update
:param cpu: Number of virtual CPUs to assign to the virtual machine
:param mem: Amount of memory to allocate to the virtual machine in MiB.
:param disk_profile: disk profile to use
:param disks:
Disk definitions as documented in the :func:`init` function.
If neither the profile nor this parameter are defined, the disk devices
will not be changed. However to clear disks set this parameter to empty list.
:param nic_profile: network interfaces profile to use
:param interfaces:
Network interface definitions as documented in the :func:`init` function.
If neither the profile nor this parameter are defined, the interface devices
will not be changed. However to clear network interfaces set this parameter
to empty list.
:param graphics:
The new graphics definition as defined in :ref:`init-graphics-def`. If not set,
the graphics will not be changed. To remove a graphics device, set this parameter
to ``{'type': 'none'}``.
:param live:
``False`` to avoid trying to live update the definition. In such a case, the
new definition is applied at the next start of the virtual machine. If ``True``,
not all aspects of the definition can be live updated, but as much as possible
will be attempted. (Default: ``True``)
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
:return:
Returns a dictionary indicating the status of what has been done. It is structured in
the following way:
.. code-block:: python
{
'definition': True,
'cpu': True,
'mem': True,
'disks': {'attached': [list of actually attached disks],
'detached': [list of actually detached disks]},
'nics': {'attached': [list of actually attached nics],
'detached': [list of actually detached nics]},
'errors': ['error messages for failures']
}
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.update domain cpu=2 mem=1024
u
definitionu attachedu detachedu disku interfacei u typeu
.//os/typeu archu vcpuu currentu memoryu
currentMemoryi u unitu MiBu devicesu disksu disk_profileu
interfacesu nic_profileu graphicsu devices/{0}u _diff_{0}_listsu deletedu newu sortedu source_fileu cpuu deviceu
setVcpusFlagsu cmdu argsu memu setMemoryFlagsu attachDeviceu detachDeviceu errorsN( u cpuu mem(, R R, R; R RL RV R R� R� R
t OSTypeRN R� RO R R� R4 R/ t localsR RW R% t globalsRA t extendR� R� R� t isfileR� R R R Ro Rp R' R
R R t isActiveR1 t VIR_DOMAIN_AFFECT_LIVEt getattrt bool(( R- R� R� t disk_profileRF t nic_profileR� R� t liveR' t statusR+ t domaint desct need_updateR) t all_diskst new_desct cpu_nodet
mem_node_namet mem_nodet devices_nodet
parameterst changest dev_typet func_localst paramRB RC R? t idxt source_fileR� t commandst addedt removedt cmdR7 t device_typet actions( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyRq � s� G
5#
!-%
* 1
)
%
c K@ sP g } t | � } x- t | d t �D] } | j | j � � q% W| j � | S( u�
Return a list of available domains.
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_domains
t iterable( R, R; R/ R1 R- R ( R' R6 R+ RP ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt list_domainsS s
c K@ sV g } t | � } x3 t | d t d t �D] } | j | j � � q+ W| j � | S( u�
Return a list of names for active virtual machine on the minion
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_active_vms
Rt t inactive( R, R; R/ R R1 R- R ( R' R6 R+ RP ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt list_active_vmso s
c K@ sV g } t | � } x3 t | d t d t �D] } | j | j � � q+ W| j � | S( u�
Return a list of names for inactive virtual machine on the minion
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_inactive_vms
Rt t active( R, R; R/ R R1 R- R ( R' R6 R+ RP ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt list_inactive_vms� s
c K@ s~ d � } i } t | � } | r= | t | | � � | | <n3 x0 t | d t �D] } | | � | | j � <qP W| j � | S( u�
Return detailed information about the vms on this hyper in a
list of dicts:
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. code-block:: python
[
'your-vm': {
'cpu': <int>,
'maxMem': <int>,
'mem': <int>,
'state': '<state>',
'cputime' <int>
},
...
]
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
CLI Example:
.. code-block:: bash
salt '*' virt.vm_info
c S@ s� | j � } i | d d 6t | d � d 6t | � d 6t | � d 6t | � d 6t | � d 6t | � d 6t | � d
6t | � d 6t | d � d
6t | d � d 6t j
| d d � d 6S( u/
Compute the infos of a domain
i u cpui u cputimeu disksu graphicsu nicsu uuidu on_crashu on_rebootu on_poweroffi u maxMemi u memi u unknownu state( R R� Rz Rh Re RQ RU RT RS t VIRT_STATE_NAME_MAPR ( RP t raw( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _info� s
Rt ( R, R; R/ R- R ( t vm_R' R| R R+ R^ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt vm_info� s &
c K@ s~ d � } i } t | � } | r= | t | | � � | | <n3 x0 t | d t �D] } | | � | | j � <qP W| j � | S( uf
Return list of all the vms and their state.
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.vm_state <domain>
c S@ s, d } | j � } t j | d d � } | S( u&
Compute domain state
u i u unknown( R Rz R ( RP t stateR{ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR| s Rt ( R, R; R/ R- R ( R} R' R| R R+ R^ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt vm_state� s
c C@ sw | j � } i | d d 6| d d 6t j | d � d 6| d d 6| d d
6| d d 6| d
d 6| d d 6} | S( uP
Internal variant of node_info taking a libvirt connection as parameter
i u cpucoresi u cpumhzi u cpumodeli u cpusi u
cputhreadsi u numanodesi u phymemoryi u sockets( t getInfoR R� ( R+ R{ R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_node_info s c K@ s& t | � } t | � } | j � | S( u�
Return a dict with information about this node
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.node_info
( R, R� R ( R' R+ R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt node_info$ s
c K@ s/ t | � } t t | | � � } | j � | S( u�
Return info about the network interfaces of a named vm
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_nics <domain>
( R, Re R; R ( R} R' R+ R] ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_nics> s
c K@ sA t j t | | � � } g | j d � D] } | j d � ^ q( S( u�
Return a list off MAC addresses from the named vm
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_macs <domain>
u devices/interface/macu address( R RL RM RW R ( R} R' R^ RR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_macsY s c K@ s/ t | � } t t | | � � } | j � | S( u�
Returns the information on vnc for a given vm
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_graphics <domain>
( R, Rh R; R ( R} R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_graphicsr s
c K@ s/ t | � } t t | | � � } | j � | S( u�
Return the disks of a named vm
:param vm_: name of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_disks <domain>
( R, Rz R; R ( R} R' R+ RF ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_disks� s
c K@ s� t | � } t | | � } t j | j � d d � d k rA t St j } | r` | t j B} n | j | d | � } | j | d t j
� } | j � | | k o� d k SS( u�
Changes the amount of memory allocated to VM. The VM must be shutdown
for this to work.
:param vm_: name of the domain
:param memory: memory amount to set in MB
:param config: if True then libvirt will be asked to modify the config as well
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.setmem <domain> <size>
salt '*' virt.setmem my_domain 768
i u unknownu shutdowni ( R, R; Rz R R R R
t VIR_DOMAIN_MEM_MAXIMUMt VIR_DOMAIN_AFFECT_CONFIGt setMemoryFlagst VIR_DOMAIN_AFFECT_CURRENTR ( R} t memoryR R' R+ RP t flagst ret1t ret2( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt setmem� s "
c K@ s� t | � } t | | � } t j | j � d d � d k rA t St j } | r` | t j B} n | j | | � } | j | t j
� } | j � | | k o� d k SS( u*
Changes the amount of vcpus allocated to VM. The VM must be shutdown
for this to work.
If config is True then we ask libvirt to modify the config as well
:param vm_: name of the domain
:param vcpus: integer representing the number of CPUs to be assigned
:param config: if True then libvirt will be asked to modify the config as well
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.setvcpus <domain> <amount>
salt '*' virt.setvcpus my_domain 4
i u unknownu shutdown( R, R; Rz R R R R
t VIR_DOMAIN_VCPU_MAXIMUMR� t
setVcpusFlagsR� R ( R} t vcpusR R' R+ RP R� R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt setvcpus� s "
c C@ sh | j � d } | d 8} xG t | d t �D]3 } | j � d k r- | | j � d d 8} q- q- W| S( uN
Internal variant of freemem taking a libvirt connection as parameter
i i Rt i i i ( R� R; R/ t IDR ( R+ R� RP ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _freemem s
c K@ s& t | � } t | � } | j � | S( u�
Return an int representing the amount of memory (in MB) that has not
been given to virtual machines on this node
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.freemem
( R, R� R ( R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt freemem s
c C@ sZ | j � d } xC t | d t �D]/ } | j � d k r# | | j � d 8} q# q# W| S( uN
Internal variant of freecpu taking a libvirt connection as parameter
i Rt i i ( R� R; R/ R� R ( R+ t cpusRP ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _freecpu- s
c K@ s& t | � } t | � } | j � | S( u�
Return an int representing the number of unallocated cpus on this
hypervisor
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.freecpu
( R, R� R ( R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt freecpu8 s
c K@ sQ t | � } i t | � d 6t | � d 6t | � d 6t � d 6} | j � | S( u�
Return the node_info, vm_info and freemem
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.full_info
u freecpuu freememu node_infou vm_info( R, R� R� R� R~ R ( R' R+ R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt full_infoS s
c K@ s2 t | � } t | | � j d � } | j � | S( u�
Returns the XML for a given vm
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_xml <domain>
i ( R, R; RV R ( R} R' R+ t xml_desc( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyRM p s
c K@ s_ i } t | � } t d � g | d D] } | d d j � ^ q& D� � } d | k r_ d n | d } | s� t d d � } | d k r� t j j j d d
� q� | } n t d d i � } x� d d
g D]� } t t
j t d j
| � � } i | d | � d 6| | <| | k r� | j | i � x, | | D] }
| |
| � | | |
<q3Wq� q� W| S( ub
Return the virt profiles for hypervisor.
Currently there are profiles for:
- nic
- disk
:param hypervisor: override the default machine type.
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.get_profiles
salt '*' virt.get_profiles hypervisor=esxi
c S@ s# h | ] } | D] } | � q q S( ( ( R R
R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys <setcomp>� s u guestsu archu domainsu kvmi u
config.getu libvirt:hypervisoru Sodiumu� 'libvirt:hypervisor' configuration property has been deprecated. Rather use the 'virt:connection:uri' to properly define the libvirt URI or alias of the host to connect to. 'libvirt:hypervisor' will stop being used in {version}.u virtu disku nicu _{0}_profileu defaultN( R R R> R R R R R R RX t syst modulest __name__R% t
setdefault( R) R' R7 R R R" t default_hypervisort virtconft typt _funct prf( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_profiles� s( ;
"c K@ s; t | � } t | | � } | j � d k } | j � | S( u�
Send a soft shutdown signal to the named vm
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.shutdown <domain>
i ( R, R; t shutdownR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� � s
c K@ s; t | � } t | | � } | j � d k } | j � | S( u�
Pause the named vm
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pause <domain>
i ( R, R; t suspendR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pause� s
c K@ s; t | � } t | | � } | j � d k } | j � | S( u�
Resume the named vm
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.resume <domain>
i ( R, R; t resumeR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� � s
c K@ s5 t | � } t | | � j � d k } | j � | S( u�
Start a defined domain
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.start <domain>
i ( R, R; R R ( R- R' R+ R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR
s
c K@ s5 t | � } t | | � j � d k } | j � | S( u�
Hard power down the virtual machine, this is equivalent to pulling the power.
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.stop <domain>
i ( R, R; t destroyR ( R- R' R+ R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt stop4
s
c K@ s; t | � } t | | � j t j � d k } | j � | S( u�
Reboot a domain via ACPI request
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.reboot <domain>
i ( R, R; t rebootR
t VIR_DOMAIN_REBOOT_DEFAULTR ( R- R' R+ R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� O
s !
c K@ s> t | � } t | | � } | j d � d k } | j � | S( u�
Reset a VM by emulating the reset button on a physical machine
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.reset <domain>
i ( R, R; t resetR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� j
s
c K@ sS t | � } t | | � } | j d d d d d g d d � d k } | j � | S( u�
Sends CTRL+ALT+DEL to a VM
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.ctrl_alt_del <domain>
i i i8 io i ( R, R; t sendKeyR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt ctrl_alt_del�
s
*
c K@ s2 t | � } | j | d � d k } | j � | S( u
Start a domain based on the XML passed to the function
:param xml: libvirt XML definition of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.create_xml_str <XML in string format>
i N( R, t createXMLR R ( t xmlR' R+ R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt create_xml_str�
s
c K@ sf yG t j j j | d � �) } t t j j j | j � � | � SWd QXWn t t f k
ra t
SXd S( uF
Start a domain based on the XML-file path passed to the function
:param path: path to a file containing the libvirt XML definition of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.create_xml_path <path to XML file on the node>
u rN( R R R� t fopenR� Ro t
to_unicodet readR� R� R ( R� R' t fp_( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt create_xml_path�
s c K@ s/ t | � } | j | � d k } | j � | S( u
Define a domain based on the XML passed to the function
:param xml: libvirt XML definition of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.define_xml_str <XML in string format>
N( R, R R R ( R� R' R+ R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt define_xml_str�
s
c K@ sf yG t j j j | d � �) } t t j j j | j � � | � SWd QXWn t t f k
ra t
SXd S( uH
Define a domain based on the XML-file path passed to the function
:param path: path to a file containing the libvirt XML definition of the domain
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.define_xml_path <path to XML file on the node>
u rN( R R R� R� R� Ro R� R� R� R� R ( R� R' R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt define_xml_path�
s c K@ s� t d d d � } | d k r8 t j j j d d � n t d d d � } t | � } | j t j | � � } | j
| d � d k } | j � | S( u�
Define a volume based on the XML passed to the function
:param xml: libvirt XML definition of the storage volume
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.define_vol_xml_str <XML in string format>
The storage pool where the disk image will be defined is ``default``
unless changed with a configuration like this:
.. code-block:: yaml
virt:
storagepool: mine
u
config.getu libvirt:storagepoolu Sodiumu� 'libvirt:storagepool' has been deprecated in favor of 'virt:storagepool'. 'libvirt:storagepool' will stop being used in {version}.u virt:storagepoolu defaulti N( R R R R R R R, t storagePoolLookupByNameR R� R� R ( R� R' t poolnameR+ R� R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR s
c K@ sf yG t j j j | d � �) } t t j j j | j � � | � SWd QXWn t t f k
ra t
SXd S( uL
Define a volume based on the XML-file path passed to the function
:param path: path to a file containing the libvirt XML definition of the volume
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.define_vol_xml_path <path to XML file on the node>
u rN( R R R� R� R Ro R� R� R� R� R ( R� R' R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt define_vol_xml_pathJ s c C@ sY t � d | t | | � } t j | d t d t j �j � d } t j j j
| � S( u4
Attempt to execute non-shared storage "all" migration
:param vm_: domain name
:param target: target libvirt host name
:param ssh: True to connect over ssh
CLI Example:
.. code-block:: bash
salt '*' virt.migrate_non_shared <vm name> <target hypervisor>
A tunnel data migration can be performed by setting this in the
configuration:
.. code-block:: yaml
virt:
tunnel: True
For more details on tunnelled data migrations, report to
https://libvirt.org/migration.html#transporttunnel
u --copy-storage-all Ri Rj i ( R� R� Rk Rl R/ Rm Rn R R Ro Rp ( R} Ru R� Rq Rj ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt migrate_non_sharedj s
c C@ sY t � d | t | | � } t j | d t d t j �j � d } t j j j
| � S( u8
Attempt to execute non-shared storage "all" migration
:param vm_: domain name
:param target: target libvirt host name
:param ssh: True to connect over ssh
CLI Example:
.. code-block:: bash
salt '*' virt.migrate_non_shared_inc <vm name> <target hypervisor>
A tunnel data migration can be performed by setting this in the
configuration:
.. code-block:: yaml
virt:
tunnel: True
For more details on tunnelled data migrations, report to
https://libvirt.org/migration.html#transporttunnel
u --copy-storage-inc Ri Rj i ( R� R� Rk Rl R/ Rm Rn R R Ro Rp ( R} Ru R� Rq Rj ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt migrate_non_shared_inc� s
c C@ sY t � d | t | | � } t j | d t d t j �j � d } t j j j
| � S( u
Shared storage migration
:param vm_: domain name
:param target: target libvirt host name
:param ssh: True to connect over ssh
CLI Example:
.. code-block:: bash
salt '*' virt.migrate <domain> <target hypervisor>
A tunnel data migration can be performed by setting this in the
configuration:
.. code-block:: yaml
virt:
tunnel: True
For more details on tunnelled data migrations, report to
https://libvirt.org/migration.html#transporttunnel
u Ri Rj i ( R� R� Rk Rl R/ Rm Rn R R Ro Rp ( R} Ru R� Rq Rj ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt migrate� s
c
C@ s� x�t j | � D]~\ } } | d } | d } | d j � d d } t j j | � r� | r� t j j j t
j d d t d t
j
�j � d � } | d | d k r� | d | d k r� t Sn t j j t j j | � � st j t j j | � � n t j j | � r#t j | � n d | d
| d
| } t
j | d t �t � } d | d d
| d d
| } t
j | d t �q Wt S( u�
Non shared migration requires that the disks be present on the migration
destination, pass the disks information via this function, to the
migration destination before executing the migration.
:param disks: the list of disk data as provided by virt.get_disks
:param force: skip checking the compatibility of source and target disk
images if True. (default: False)
CLI Example:
.. code-block:: bash
salt '*' virt.seed_non_shared_migrate <disks>
u fileu file formatu virtual sizei u qemu-img info archRi Rj i u qemu-img create -f u u chown u useru :u group( R R[ R{ R� R� RU R R R� R� Rk Rl R/ Rm Rn R t isdirR� R� RA t callR� (
RF t forcet _t dataR� t formR� t preRq t creds( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt seed_non_shared_migrate� s*
"u onc K@ sw t | � } t | | � } t } | d k rE | j d � d k } n$ | d k ri | j d � d k } n | j � | S( u�
Set the autostart flag on a VM so that the VM will start with the host
system on reboot.
:param vm_: domain name
:param state: 'on' to auto start the pool, anything else to mark the
pool not to be started when the host boots
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt "*" virt.set_autostart <domain> <on | off>
u oni i u off( R, R; R t setAutostartR ( R} R R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
set_autostart� s
c K@ sh t | � } t | | � } t t d t � rH | j t j � d k } n | j � d k } | j � | S( u&
Remove a defined vm, this does not purge the virtual machine image, and
this only works if the vm is powered down
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.undefine <domain>
u VIR_DOMAIN_UNDEFINE_NVRAMi ( R, R; RX R
R t
undefineFlagst VIR_DOMAIN_UNDEFINE_NVRAMt undefineR ( R} R' R+ RP R7 ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� s
c
K@ s� t | � } t | | � } t | � } | d k rR t j j j d d � t } n t j
| j � d d � d k r� | j � d k r� t
St � } xe | D]] } | r� | | d d k r� q� n t j | | d � | j t j j | | d � � q� W| r"x | D] } t j | � qWn t t d
t
� riy | j t j � Wqst k
re| j � qsXn
| j � | j � t S(
u�
Recursively destroy and delete a virtual machine, pass True for dir's to
also delete the directories containing the virtual machine disk images -
USE WITH EXTREME CAUTION!
Pass removables=False to avoid deleting cdrom and floppy images. To avoid
disruption, the default but dangerous value is True. This will be changed
to the safer False default value in Sodium.
:param vm_: domain name
:param dirs: pass True to remove containing directories
:param removables: pass True to remove removable devices
.. versionadded:: 2019.2.0
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.purge <domain> removables=False
u Sodiumu� removables argument default value is True, but will be changed to False by default in {version}. Please set to True to maintain the current behavior in the future.i u unknownu shutdownu typeu cdromu floppyu fileu VIR_DOMAIN_UNDEFINE_NVRAMN( u cdromu floppy( R, R; Rz R R R R R R/ Rz R R R� R R4 R� RA t addR� R� t shutilt rmtreeRX R
R� R� R$ R� R (
R} t dirst
removablesR' R+ RP RF t directoriesRH t dir_( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt purgeA s6 4
%
c C@ s t d S( u�
Returns the virtual machine type as a string
CLI Example:
.. code-block:: bash
salt '*' virt.virt_type
u virtual( R& ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt virt_type� s
c C@ st yG t j j j d � �, } d t j j j | j � � k r@ t SWd QXWn t k
r[ t SXd t d t
d � k S( uE
Returns a bool whether or not this node is a KVM hypervisor
u
/proc/modulesu kvm_Nu libvirtdu cmd.runu ps( R R R� R� Ro R� R� R R� R R& ( R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_is_kvm_hyper� s !
c C@ s t j j j d d � t � S( u�
Returns a bool whether or not this node is a KVM hypervisor
CLI Example:
.. code-block:: bash
salt '*' virt.is_kvm_hyper
.. deprecated:: 2019.2.0
u Sodiumu� 'is_kvm_hyper' function has been deprecated. Use the 'get_hypervisor' == "kvm" instead. 'is_kvm_hyper' will be removed in {version}.( R R R R R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt is_kvm_hyper� s c C@ s� y t d d k r t SWn t k
r, t SXyG t j j j d � �, } d t j j j | j � � k rm t SWd QXWn t
t f k
r� t SXd t d t d � k S( uE
Returns a bool whether or not this node is a XEN hypervisor
u virtual_subtypeu Xen Dom0u
/proc/modulesu xen_Nu libvirtdu cmd.runu ps(
R& R t KeyErrorR R R� R� Ro R� R� R� R� R ( R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
_is_xen_hyper� s
!c C@ s t j j j d d � t � S( u�
Returns a bool whether or not this node is a XEN hypervisor
CLI Example:
.. code-block:: bash
salt '*' virt.is_xen_hyper
.. deprecated:: 2019.2.0
u Sodiumu� 'is_xen_hyper' function has been deprecated. Use the 'get_hypervisor' == "xen" instead. 'is_xen_hyper' will be removed in {version}.( R R R R R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt is_xen_hyper� s c C@ sY d d g } g | D]. } t t j t d � j | � � r | ^ q } | rU | d Sd S( u5
Returns the name of the hypervisor running on this node or ``None``.
Detected hypervisors:
- kvm
- xen
CLI Example:
.. code-block:: bash
salt '*' virt.get_hypervisor
.. versionadded:: 2019.2.0
the function and the ``kvm`` and ``xen`` hypervisors support
u kvmu xenu _is_{}_hyperi N( RX R� R� R� R% R ( R" t hypert result( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt get_hypervisor� s ;c C@ s t r t � p t � St S( u�
Returns a bool whether or not this node is a hypervisor of any kind
CLI Example:
.. code-block:: bash
salt '*' virt.is_hyper
( R
R� R� R ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt is_hyper� s
c @ s� t | � } | j � d � � f d � } i } | rS | t | | � � | | <n3 x0 t | d t �D] } | | � | | j � <qf W| j � | S( u*
Return cputime used by the vms on this hyper in a
list of dicts:
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. code-block:: python
[
'your-vm': {
'cputime' <int>
'cputime_percent' <int>
},
...
]
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
CLI Example:
.. code-block:: bash
salt '*' virt.vm_cputime
i c @ sx | j � } t | d � } t | d � } d } | rM d | � | } n i t | d � d 6t d j | � � d 6S( u2
Compute cputime info of a domain
i i i gH�����z>u cputimeu {0:.0f}u cputime_percent( R R� R% ( RP R{ R� t cputimet cputime_percent( t host_cpus( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR| '
s Rt ( R, R� R; R/ R- R ( R} R' R+ R| R R^ ( ( R� s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
vm_cputime
s #
c K@ s~ d � } i } t | � } | r= | t | | � � | | <n3 x0 t | d t �D] } | | � | | j � <qP W| j � | S( u
Return combined network counters used by the vms on this hyper in a
list of dicts:
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. code-block:: python
[
'your-vm': {
'rx_bytes' : 0,
'rx_packets' : 0,
'rx_errs' : 0,
'rx_drop' : 0,
'tx_bytes' : 0,
'tx_packets' : 0,
'tx_errs' : 0,
'tx_drop' : 0
},
...
]
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
CLI Example:
.. code-block:: bash
salt '*' virt.vm_netstats
c S@ s0 t | � } i d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6} x� t j | � D]� } d
| k rZ | d
} | j | � } | d c | d 7<| d c | d 7<| d c | d 7<| d c | d
7<| d c | d 7<| d c | d 7<| d c | d 7<| d c | d 7<qZ qZ W| S( u3
Compute network stats of a domain
i u rx_bytesu
rx_packetsu rx_errsu rx_dropu tx_bytesu
tx_packetsu tx_errsu tx_dropu targeti i i i i i i ( Re R t
itervaluest interfaceStats( RP R] R7 t attrsR� t stats( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR| i
s.
Rt ( R, R; R/ R- R ( R} R' R| R R+ R^ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt vm_netstats@
s )
c @ s� � f d � � � f d � } i } t � � } | rR | t | | � � | | <n9 x6 t | d t d t �D] } | | � | | j � <qk W| j � | S( u�
Return disk usage counters used by the vms on this hyper in a
list of dicts:
:param vm_: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. code-block:: python
[
'your-vm': {
'rd_req' : 0,
'rd_bytes' : 0,
'wr_req' : 0,
'wr_bytes' : 0,
'errs' : 0
},
...
]
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs.
CLI Example:
.. code-block:: bash
salt '*' virt.vm_blockstats
c @ sA t j t | � � � } g | j d � D] } | j d � ^ q( S( uO
Extract the disk devices names from the domain XML definition
u devices/disk/targetu dev( R RL RM RW R ( RP R^ Ru ( R' ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
get_disk_devs�
s c @ s� � | � } i d d 6d d 6d d 6d d 6d d 6} x� | D]y } | j | � } | d c | d 7<| d c | d 7<| d c | d 7<| d c | d 7<| d c | d
7<q< W| S( u4
Compute the disk stats of a domain
i u rd_requ rd_bytesu wr_requ wr_bytesu errsi i i i ( t
blockStats( RP RF R7 RH R� ( R� ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR| �
s
Rt Rv ( R, R; R/ R R- R ( R} R' R| R R+ R^ ( ( R� R' s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt vm_diskstats�
s &
c C@ s� t � } t j | j � � } x� | D]� } | j d k rJ | j | d <q% | j d k r� | s� t j j t | j � � j d � n t | j � | d <q% | j d k r% | j d k | d <q% q% W| j
� d k | d <| S( ub
Parse XML doc and return a dict with the status values.
:param xmldoc:
:return:
u nameu creationTimeu u createdu stateu runningi u current( R� R RL t
getXMLDescRX RO R? R@ RA RB t isCurrent( t vm_snapshott unix_timeR7 t treeRR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_snapshot_description�
s
@c K@ s� t � } t | � } xd t | d t | r3 | g p9 t � �D]; } g | j � D] } t | � ^ qP pk d | | j � <q= W| j � | S( u2
List available snapshots for certain vm or for all.
:param domain: domain name
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_snapshots
salt '*' virt.list_snapshots <domain>
Rt u N/A( R� R, R; R/ R. t listAllSnapshotsR� R- R ( R^ R' R7 R+ t vm_domaint snap( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt list_snapshots�
s .9
c K@ s | r9 | j � | j � k r9 t d j d | � � � n | sl d j d | d t j d t j � � � } n | r� d j d | d | � } n t j d � } t j | d
� } | | _ t
| � } t | | � j t
j j j t j | � � � | j � i | d
6S( u
Create a snapshot of a VM.
:param domain: domain name
:param name: Name of the snapshot. If the name is omitted, then will be used original domain
name with ISO 8601 time as a suffix.
:param suffix: Add suffix for the new name. Useful in states, where such snapshots
can be distinguished from manually created.
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' virt.snapshot <domain>
uV Virtual Machine {name} is already defined. Please choose another name for the snapshotR- u {domain}-{tsnap}R^ t tsnapu
%Y%m%d-%H%M%Su {name}-{suffix}t suffixu domainsnapshotu name( R/ R R% RD t strftimet localtimeR t Elementt
SubElementRO R, R; t snapshotCreateXMLR R Ro Rp R' R ( R^ R- R� R' R^ t n_nameR+ ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyRI s -
c O@ s� t � } t | � } t | | � } xP | j � D]B } | j � | k sP | r1 t | � | | j � <| j � q1 q1 W| j � i g | j � D] } t | � ^ q� p� d | 6} i | d 6| d 6S( u�
Delete one or more snapshots of the given VM.
:param name: domain name
:param names: names of the snapshots to remove
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' virt.delete_snapshots <domain> all=True
salt '*' virt.delete_snapshots <domain> <snapshot>
salt '*' virt.delete_snapshots <domain> <snapshot1> <snapshot2> ...
u N/Au availableu deleted( R� R, R; R� t getNameR� t deleteR ( R- t namesR' t deletedR+ R^ R� t available( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt delete_snapshotsJ s
2c K@ sf t � } t | � } t | | � } | j � } t � } x9 | D]1 } | j i t | d t �d d 6| d 6� q@ Wg t | d d � d t �D] }
|
d ^ q� } ~ | s� | j � t
d � � n+ t | � d k r� | j � t
d
� � n d } xu | D]m } | sR| j
� rn| | j | � d rn| | j | � d d } Pqnq| j � | k r| } PqqW| s�| j � t
t r�d j | � p�d
� � n% | j
� r�| j � t
d � � n | j | � | j � | d <| rNt � }
xG | D]? } | j � | j � k r<|
j | j � � | j � q�Pq�W|
| d <n
d | d <| j � | S( u�
Revert snapshot to the previous from current (if available) or to the specific.
:param name: domain name
:param vm_snapshot: name of the snapshot to revert
:param cleanup: Remove all newer than reverted snapshots. Values: True or False (default False).
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' virt.revert <domain>
salt '*' virt.revert <domain> <snapshot>
R� u createdu idxu ptrRc c S@ s | d S( Nu idx( ( R? ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt <lambda>� s t reverseu No snapshots foundi u8 Cannot revert to itself: only one snapshot is available.i u Snapshot "{0}" not foundu$ No more previous snapshots availableu0 Cannot revert to the currently running snapshot.u revertedu deletedu N/AN( R� R, R; R� R. R1 R� R/ R R R R5 R R� t indexR RI R% t revertToSnapshotR ( R- R� t cleanupR' R7 R+ R^ t snapshotst
_snapshotst snap_objt w_ptrR� t p_snapR ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt revert_snapshotr sX
/2
#
!
c C@ s� | j d � } | j d � } | j } d } | rB | } | } n | j | � } | s� i g d 6} | r} t | � | d <n | | | <n | r� | d j | � n d S( uc
Parse the <machine> element of the host capabilities and add it
to the machines list.
u maxCpusu canonicalu u alternate_namesu maxcpusN( R RO R� R1 ( t machinesRR t maxcpust canonicalR- t alternate_namet machine( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _caps_add_machine� s
c C@ s� | j d � } i | j d � j d 6i | j d � d 6i d 6i d 6d 6} x | D]} | j d k r� t | j � | d d <qT | j d k r� | j | d d <qT | j d k r� t | d d | � qT | j d k rT | j d
� } i d
d 6i d 6} | j d � } | d
k r*| j | d <n x( | j d � D] } t | d | � q:W| | d d | <qT qT W| j d � } | d
k r�d � | D� | d <n | S( uF
Parse the <guest> element of the connection capabilities XML
u archu os_typeu nameu machinesu domainsu wordsizeu emulatoru machineu domainu typeu featuresc S@ s` i | ]V } i | j d � d k r* t n t d 6| j d � d k rL t n t d 6| j � q S( u toggleu yesu defaultu no( R R/ R RX ( R t child( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp> s N( RN RO R RX R� R R RW ( R t arch_nodeR� R t domain_typeR^ t
emulator_nodeR t features_nodes( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_guest� s<
c C@ s� i t | j d � � d 6} | j d � } | d k rk | j d d � } | j } d j | | � | d <n g | j d � D]D } i d j | j d � | j d d � � d 6t | j � d 6^ q{ } | r� | | d <n d � | j d
� D� } | r| | d <n g } x� | j d � D]� } i t | j d � � d 6}
| j d
� } | rdt | � |
d
<n | j d � } | r�t | � |
d <n | j d � }
|
r�|
|
d <n | j |
� qW| r�| | d <n | S( uK
Parse the <cell> nodes of the connection capabilities XML output.
u idu memoryu unitu KiBu {} {}u pagesu sizeu availablec S@ s7 i | ]- } t | j d � � t | j d � � � q S( u valueu id( R� R ( R t distance( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp> s u distances/siblingu distancesu cpus/cpuu socket_idu core_idu siblingsu cpusN( R� R RN R RO R% RW R1 ( t cellR� Re t unitR� t paget pagest distancesR� Rc R� t socket_idt core_idt siblings( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_cell s@ W
c C@ s@ i t | j d � � d 6t | j d � � d 6| j d � d 6d j | j d � | j d � � d 6| j d � d 6} g } x� | j d � D]� } | j d � } i d j | j d � | � d 6| j d � d 6t | j d
� � d
6} | j d � } | rd j | | � | d <n | j | � q� W| r<| | d <n | S(
uF
Parse the <bank> element of the connection capabilities XML.
u idu levelu typeu {} {}u sizeu unitu cpusu controlu granularityu maxAllocsu minu controls( R� R R% RW R1 ( t bankR� t controlst controlR t result_controlt minimum( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_bank: s( %
c
C@ s� i } x�| D]�} | j d k r2 | j | d <q
| j d k r�i | j d � d& k rk | j d � j n d& d 6| j d � d& k r� | j d � j n d& d 6| j d � d& k r� | j d � j n d& d 6g | j d � D] } | j d � ^ q� d 6g | j d � D]4 } i d
j | j d � | j d d
� � d 6^ q
d 6} | j d � } | d& k ry| j d � | d <n | j d � } | d& k r�t | j d � � | d <t | j d � � | d <t | j d � � | d <n | | d <q
| j d k r!g | D] } | j ^ q| d <q
| j d k ryi | j d � d& k d 6g | j d � D] } | j ^ qYd 6| d <q
| j d k r�i g | j d � D] } t | � ^ q�d 6| d <q
| j d k r
i g | j d � D] }
t |
� ^ q�d 6| d <q
q
Wg | j d � D]� } i | j d � d& k rG| j d � j n d& d 6| j d � d& k ru| j d � j n d& d 6g | j d! � D]& } i | j d" � d" 6| j d# 6^ q�d$ 6^ q| d% <| S(' uF
Parse the <host> element of the connection capabilities XML.
u uuidu cpuu archu modelu vendoru featureu nameu featuresu pagesu {} {}u sizeu unitu KiBu microcodeu versionu topologyu socketsu coresu threadsu power_managementu migration_featuresu liveu uri_transports/uri_transportu
transportsu migrationu
cells/cellu cellsu cacheu banku banksu secmodelu doiu baselabelu typeu labelu
baselabelsu securityN(
RX RO RN R RW R R% R� R& R, (
R� R� R t featureR R� t microcodet topologyRR R R' t secmodelt label( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_hostY sH
...,K
#037�c K@ sn t | � } t j | j � � } | j � i t | j d � � d 6g | j d � D] } t | � ^ qT d 6S( ur
Return the hypervisor connection capabilities.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.capabilities
u hostu guestu guests( R, R RL t getCapabilitiesR R2 RN RW R ( R' R+ R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR � s
c C@ s2 | j d � g | j d � D] } | j ^ q f S( uP
Return a tuple containing the name of the enum and the possible values
u nameu value( R RW RO ( RR Rd ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_enum� s c
C@ s� i } x�| j d � D]�} | j d � d k s7 q n | j d � } | d k r_ t | | <q | d k rfi } | j d � } | d k r� i | j d 6} | j d � } | r� | | d <n | j d � } | r� | | d <n | | d <n | j d
� d k r| j d
� j n d } | r-| | d
<n d � | j d � D� }
|
rY|
| d
<n | | | <q | d k r i } d � | j d � D� } | r�| | d <n | | | <q q W| S( u<
Parse the <cpu> element of the domain capabilities
u modeu supportedu yesu nameu host-passthroughu
host-modelu modelu vendor_idu fallbacku vendorc S@ s+ i | ]! } | j d � | j d � � q S( u policyu name( R ( R R- ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp>� s u featureu featuresu customc S@ s% i | ] } | j d � | j � q S( u usable( R RO ( R t model( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp>� s u modelsN( RW R R/ RN R RO (
RR R� R� R- t
host_modelt
model_nodeR5 t vendor_idt fallbackt vendort featurest custom_modelt models( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_cpu� sD
-
c C@ sr i } xe | D]] } | j d � d k r
g | j d � D] } t | � ^ q8 } d � | D� | | j <q
q
W| S( uG
Parse the devices or features list of the domain capatilities
u supportedu yesu enumc S@ s+ i | ]! } | d r | d | d � q S( i i ( ( R R? ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp>� s ( R RW R4 RX ( RR R� R t enums( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_devices_features� s
( c C@ st g | j d � D] } t | � ^ q } d � | D� } g | j d � D] } | j ^ qH } | rp | | d <n | S( u@
Parse the <loader> element of the domain capabilities.
u enumc S@ s+ i | ]! } | d r | d | d � q S( i i ( ( R R? ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp>� s u valueu values( RW R4 RO ( RR t enumR? R� R t values( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _parse_caps_loader� s (%
c K@ sn t | � } t j | j | | | | d � � } | j � i | j d � d k rd | j d � j n d d 6| j d � d k r� | j d � j n d d 6| j d � d k r� | j d � j n d d 6| j d � d k r� | j d � j n d d 6} xo| D]g} | j d k r?| j d � r?t
| j d � � | d <q� | j d
k rj| j d � d k | d
<q� | j d
k r�i | d
<| j d � } | d k rf| j d � d k rft | � }
|
| d
d <qfq� | j d k rt | � } | rf| | d <qfq� | j d k r5t
| � } | rf| | d <qfq� | j d k r� t
| � }
|
rf|
| d <qfq� q� W| S( u�
Return the domain capabilities given an emulator, architecture, machine or virtualization type.
.. versionadded:: 2019.2.0
:param emulator: return the capabilities for the given emulator binary
:param arch: return the capabilities for the given CPU architecture
:param machine: return the capabilities for the given emulated machine type
:param domain: return the capabilities for the given virtualization type.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
The list of the possible emulator, arch, machine and domain can be found in
the host capabilities output.
If none of the parameters is provided the libvirt default domain capabilities
will be returned.
CLI Example:
.. code-block:: bash
salt '*' virt.domain_capabilities arch='x86_64' domain='kvm'
i u pathu emulatoru domainu machineu archu vcpuu maxu max_vcpusu iothreadsu supportedu yesu osu loaderu cpuu devicesu featuresN( R, R RL t getDomainCapabilitiesR RN R RO RX R R� RC R> R@ ( t emulatorR� R R^ R' R+ R R� R t loader_nodeR R� t devicesR; ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt domain_capabilities s@ $
...1
! u libvirtc K@ s� t | � } t j | j � � } | j d � } t j d t j j j
t j | � � � d } | r� t t
d t � r� | t
j 7} q� | j � t � n | r� t t
d t � r� | t
j 7} n t j | j t j j j
t j | � � g | � � } | j � | rit t
d t � rit j j j d d � � } t j | � } Wd QX| j d � j } x
| re| j d
� }
g |
D]3 } | j d � | k r{t t | � � r{| ^ q{} | s�t d j | � � � n* t | � d
k r�t d j | � � � n | d } | j d � }
|
d k r*d } n |
j d � } | j g | j d � D] } | ^ qO� q_Wn | d k r�i | j d � j d 6| j d � j d 6g | j d � D] } | j d � ^ q�d 6S| j � S( u
Return the optimal 'custom' CPU baseline config for VM's on this minion
.. versionadded:: 2016.3.0
:param full: Return all CPU features rather than the ones on top of the closest CPU model
:param migratable: Exclude CPU features that are unmigratable (libvirt 2.13+)
:param out: 'libvirt' (default) for usable libvirt XML definition, 'salt' for nice dict
:param connection: libvirt connection URI, overriding defaults
.. versionadded:: 2019.2.0
:param username: username to connect with, overriding defaults
.. versionadded:: 2019.2.0
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.cpu_baseline
u host/cpuu Host CPU model definition: %si u# VIR_CONNECT_BASELINE_CPU_MIGRATABLEu( VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURESu /usr/share/libvirt/cpu_map.xmlu rNu modelu
arch/modelu nameu Model {0} not found in CPU mapi u$ Multiple models {0} found in CPU mapu featureu saltu vendoru features( R, R RL R3 RN R R� R R Ro Rp R' RX R
R t# VIR_CONNECT_BASELINE_CPU_MIGRATABLER t
ValueErrort( VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURESt baselineCPUR� R� t parseRO RW R RY R5 R% R RT t toxml( t fullt
migratableRf R' R+ R R� R� t cpu_mapt cpu_modelt cpu_map_modelst elt cpu_specsR7 R- ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt cpu_baselineJ sJ (
6
@
0 -c K@ s� t | � } | j d d � } | j d d � } | j d t � } | j d t � } t | | | | | � } y | j | � Wn0 t k
r� }
t j |
� | j � |
� n Xy | j
| � } Wn0 t k
r� }
t j |
� | j � |
� n X| d k r| j � t S| t k s(| t k rG| j � d k rG| j
� n | t k r{| j � d k r{| j t | � � n4 | t k r�| j � d k r�| j t | � � n | j � t S( u�
Create libvirt network.
:param name: Network name
:param bridge: Bridge name
:param forward: Forward mode(bridge, router, nat)
:param vport: Virtualport type
:param tag: Vlan tag
:param autostart: Network autostart (default True)
:param start: Network start (default True)
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
CLI Example:
.. code-block:: bash
salt '*' virt.network_define network main bridge openvswitch
.. versionadded:: 2019.2.0
u vportu tagu autostartu starti N( R, R R R/ R� t networkDefineXMLR R R R t networkLookupByNameR RV R t autostartR� R� ( R- R� R� R' R+ R� RX RY t startingt net_xmlR� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt network_define� sD
*
c K@ sE t | � } z' g | j � D] } | j � ^ q SWd | j � Xd S( u^
List all virtual networks.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_networks
N( R, t listAllNetworksR- R ( R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
list_networks� s 'c @ s� i } t | � } d � � z� yW g | j � D]* } | d k sR | j � | k r. | ^ q. } � f d � | D� } Wn, t j k
r� } t j d t | � � n XWd | j � X| S( u�
Return informations on a virtual network provided its name.
:param name: virtual network name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
If no name is provided, return the infos for all defined virtual networks.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.network_info default
c S@ sk | j � } xX | D]P } | d t j k r9 d | d <q | d t j k rY d | d <q d | d <q W| S( u3
Get all DHCP leases for a network
u typeu ipv4u ipv6u unknown( t
DHCPLeasesR
t VIR_IP_ADDR_TYPE_IPV4t VIR_IP_ADDR_TYPE_IPV6( R� t leasest lease( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _net_get_leases
s
c @ sm i | ]c } i | j � d 6| j � d 6| j � d 6| j � d 6| j � d 6� | � d 6| j � � q S( u uuidu bridgeu autostartu activeu
persistentu leases( t
UUIDStringt
bridgeNameRY RV t isPersistentR- ( R R� ( Rd ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp> s u Silenced libvirt error: %sN(
R, R] R R- R
R R R� t strR ( R- R' R� R+ R� t netsR� ( ( Rd s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt network_info� s = c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Start a defined virtual network.
:param name: virtual network name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.network_start default
N( R, RX RY R R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
network_start+ s
c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Stop a defined virtual network.
:param name: virtual network name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.network_stop default
N( R, RX RY R� R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt network_stopD s
c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Remove a defined virtual network. This does not stop the virtual network.
:param name: virtual network name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.network_undefine default
N( R, RX RY R� R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt network_undefine] s
c K@ sW t | � } z9 | j | � } t | j | d k r9 d n d � � SWd | j � Xd S( u�
Set the autostart flag on a virtual network so that the network
will start with the host system on reboot.
:param name: virtual network name
:param state: 'on' to auto start the network, anything else to mark the
virtual network not to be started when the host boots
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt "*" virt.network_set_autostart <pool> <on | off>
u oni i N( R, RX RY R� R ( R- R R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt network_set_autostartv s
*c
K@ s� t |
� } t | | | d | d | d | d | d | d | d | d |
�} z^ y> | rl | j | � } n" | j | � } | r� | j � n Wn t k
r� } | � n XWd | j � Xt S(
u�
Create libvirt pool.
:param name: Pool name
:param ptype:
Pool type. See `libvirt documentation <https://libvirt.org/storage.html>`_ for the
possible values.
:param target: Pool full path target
:param permissions:
Permissions to set on the target folder. This is mostly used for filesystem-based
pool types. See :ref:`pool-define-permissions` for more details on this structure.
:param source_devices:
List of source devices for pools backed by physical devices. (Default: ``None``)
Each item in the list is a dictionary with ``path`` and optionally ``part_separator``
keys. The path is the qualified name for iSCSI devices.
Report to `this libvirt page <https://libvirt.org/formatstorage.html#StoragePool>`_
for more informations on the use of ``part_separator``
:param source_dir:
Path to the source directory for pools of type ``dir``, ``netfs`` or ``gluster``.
(Default: ``None``)
:param source_adapter:
SCSI source definition. The value is a dictionary with ``type``, ``name``, ``parent``,
``managed``, ``parent_wwnn``, ``parent_wwpn``, ``parent_fabric_wwn``, ``wwnn``, ``wwpn``
and ``parent_address`` keys.
The ``parent_address`` value is a dictionary with ``unique_id`` and ``address`` keys.
The address represents a PCI address and is itself a dictionary with ``domain``, ``bus``,
``slot`` and ``function`` properties.
Report to `this libvirt page <https://libvirt.org/formatstorage.html#StoragePool>`_
for the meaning and possible values of these properties.
:param source_hosts:
List of source for pools backed by storage from remote servers. Each item is the hostname
optionally followed by the port separated by a colon. (Default: ``None``)
:param source_auth:
Source authentication details. (Default: ``None``)
The value is a dictionary with ``type``, ``username`` and ``secret`` keys. The type
can be one of ``ceph`` for Ceph RBD or ``chap`` for iSCSI sources.
The ``secret`` value links to a libvirt secret object. It is a dictionary with
``type`` and ``value`` keys. The type value can be either ``uuid`` or ``usage``.
Examples:
.. code-block:: python
source_auth={
'type': 'ceph',
'username': 'admin',
'secret': {
'type': 'uuid',
'uuid': '2ec115d7-3a88-3ceb-bc12-0ac909a6fd87'
}
}
.. code-block:: python
source_auth={
'type': 'chap',
'username': 'myname',
'secret': {
'type': 'usage',
'uuid': 'mycluster_myname'
}
}
:param source_name:
Identifier of name-based sources.
:param source_format:
String representing the source format. The possible values are depending on the
source type. See `libvirt documentation <https://libvirt.org/storage.html>`_ for
the possible values.
:param start: Pool start (default True)
:param transient:
When ``True``, the pool will be automatically undefined after being stopped.
Note that a transient pool will force ``start`` to ``True``. (Default: ``False``)
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. _pool-define-permissions:
.. rubric:: Permissions definition
The permissions are described by a dictionary containing the following keys:
mode
The octal representation of the permissions. (Default: `0711`)
owner
the numeric user ID of the owner. (Default: from the parent folder)
group
the numeric ID of the group. (Default: from the parent folder)
label
the SELinux label. (Default: `None`)
.. rubric:: CLI Example:
Local folder pool:
.. code-block:: bash
salt '*' virt.pool_define somepool dir target=/srv/mypool permissions="{'mode': '0744' 'ower': 107, 'group': 107 }"
CIFS backed pool:
.. code-block:: bash
salt '*' virt.pool_define myshare netfs source_format=cifs source_dir=samba_share source_hosts="['example.com']" target=/mnt/cifs
.. versionadded:: 2019.2.0
R� R� R� R� R� R� R� R� N( R, R� t storagePoolCreateXMLt storagePoolDefineXMLR R R R/ ( R- R� Ru R� R� R� R� R� R� R� R� t transientR R' R+ t pool_xmlR� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_define� s0 � c K@ sE t | � } z' g | j � D] } | j � ^ q SWd | j � Xd S( uY
List all storage pools.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.list_pools
N( R, t listAllStoragePoolsR- R ( R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
list_pools5 s 'c @ s� i } t | � } d � � z� yW g | j � D]* } | d k sR | j � | k r. | ^ q. } � f d � | D� } Wn, t j k
r� } t j d t | � � n XWd | j � X| S( u�
Return informations on a storage pool provided its name.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
If no name is provided, return the infos for all defined storage pools.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_info default
c S@ s� d d d d d g } | j � } | d t | � k rE | | d n d } t j | j � � } | j d � } i | j � d 6| d
6| d d 6| d
d 6| d d 6| j � d 6| j � d 6| d k r� | j
n d d 6| j d � d 6S( u_
Format the pool info dictionary
:param pool: the libvirt pool object
u inactiveu buildingu runningu degradedu inaccessiblei u unknownu target/pathu uuidu statei u capacityi u
allocationi u freeu autostartu
persistentu target_pathu typeN( R R5 R RL RV RN Re RY Rg R RO R ( R� t statesR� R R_ t path_node( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt _pool_extract_infosb s *
c @ s% i | ] } � | � | j � � q S( ( R- ( R R� ( Rx ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pys
<dictcomp>{ s u Silenced libvirt error: %sN(
R, Rt R R- R
R R R� Rh R ( R- R' R� R+ R� t poolsR� ( ( Rx s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyR� L s = c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Start a defined libvirt storage pool.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_start default
N( R, R� RY R R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
pool_start� s
c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Build a defined libvirt storage pool.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_build default
N( R, R� RY t buildR ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
pool_build� s
c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Stop a defined libvirt storage pool.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_stop default
N( R, R� RY R� R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_stop� s
c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Remove a defined libvirt storage pool. The pool needs to be stopped before calling.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_undefine default
N( R, R� RY R� R ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt
pool_undefine� s
c K@ s` t | � } zB | j | � } t j } | r9 t j } n t | j | � � SWd | j � Xd S( u
Delete the resources of a defined libvirt storage pool.
:param name: libvirt storage pool name
:param fast: if set to False, zeroes out all the data.
Default value is True.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_delete default
N( R, R� R
t VIR_STORAGE_POOL_DELETE_NORMALt VIR_STORAGE_POOL_DELETE_ZEROEDRY R R ( R- t fastR' R+ R� R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_delete� s c K@ sB t | � } z$ | j | � } t | j � � SWd | j � Xd S( u�
Refresh a defined libvirt storage pool.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' virt.pool_refresh default
N( R, R� RY t refreshR ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_refresh s
c K@ sW t | � } z9 | j | � } t | j | d k r9 d n d � � SWd | j � Xd S( u�
Set the autostart flag on a libvirt storage pool so that the storage pool
will start with the host system on reboot.
:param name: libvirt storage pool name
:param state: 'on' to auto start the pool, anything else to mark the
pool not to be started when the host boots
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt "*" virt.pool_set_autostart <pool> <on | off>
u oni i N( R, R� RY R� R ( R- R R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_set_autostart s
*c K@ s; t | � } z | j | � } | j � SWd | j � Xd S( u�
List the volumes contained in a defined libvirt storage pool.
:param name: libvirt storage pool name
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt "*" virt.pool_list_volumes <pool>
N( R, R� t listVolumesR ( R- R' R+ R� ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt pool_list_volumes: s
(� t __doc__t
__future__R R R R� R� RY R� R� Rk R� t loggingRD R? t xml.etreeR R� t jinja2.exceptionsR
R R/ R
t ImportErrorR t salt.utils.filesR t salt.utils.jsont salt.utils.networkt salt.utils.patht salt.utils.stringutilst salt.utils.templatest salt.utils.validate.nett salt.utils.versionst salt.utils.yamlt salt.exceptionsR R t salt.extR t salt.ext.six.movesR t getLoggerR� R t Environmentt FileSystemLoaderR� R� R t templatest TEMPLATE_DIRNAMER� Rz R R R, R; RK RQ RS RT RU Re Rh Rz R� R� R� R R� R� R� R� R� R� R� R� R R R
R& R. R3 R; RH RM RO RP Rq Ru Rw Ry R~ R� R� R� R� R� R� R� R� R� R� R� R� R� R� RM 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� RI R R R R R& R, R2 R R4 R> R@ RC RH RV R\ R^ Rj Rk Rl Rm Rn Rs Ru R� Rz R| R} R~ R� R� R� R� ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/virt.pyt <module>G s�
$
! K & )
$ + \ \c K H � � % � B + / .
: / " " " ( ( !A
? Q O !2 (R / / = 2 FT B 4 � 7
Mini Shell