Current File : //lib/python2.7/site-packages/salt/modules/xapi_virt.pyo
�
���^c @@ sB d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m Z d d l m
Z
y d d l Z e Z
Wn e k
r� e Z
n Xd d l Z d d l Z d d l Z d d l Z d d l m Z d Z d � Z d � Z e j d
� � Z d � Z d � Z d
� Z d � Z d � Z d � Z! d � Z" d � Z# d d � Z% d d � Z& d � Z' d � Z( d � Z) d � Z* d � Z+ d � Z, d � Z- d � Z. d � Z/ d � Z0 d � Z1 d � Z2 d! � Z3 d" � Z4 d# � Z5 d$ � Z6 d% d d& d d d' � Z7 d( � Z8 d) � Z9 d d* � Z: d d+ � Z; d d, � Z< d S(- u�
This module (mostly) uses the XenAPI to manage Xen virtual machines.
Big fat warning: the XenAPI used in this file is the one bundled with
Xen Source, NOT XenServer nor Xen Cloud Platform. As a matter of fact it
*will* fail under those platforms. From what I've read, little work is needed
to adapt this code to XS/XCP, mostly playing with XenAPI version, but as
XCP is not taking precedence on Xen Source on many platforms, please keep
compatibility in mind.
Useful documentation:
. http://downloads.xen.org/Wiki/XenAPI/xenapi-1.0.6.pdf
. http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/
. https://github.com/xapi-project/xen-api/tree/master/scripts/examples/python
. http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/python/xen/xm;hb=HEAD
i ( t absolute_importt print_functiont unicode_literalsN( t range( t map( t CommandExecutionErroru virtc C@ s� t d d k rw d } t j j | � rw t j j j | � } d j | � } t j j | � rt t
j j | � qt qw n y' t r� t
j d � St d � j j SWn t t f k
r� t SXd S( Nu osu Debianu# /usr/lib/xen-common/bin/xen-versionu /usr/lib/xen-{0}/lib/pythonu
xen.xm.XenAPI( t
__grains__t ost patht isfilet saltt modulest cmdmodt
_run_quiett formatt isdirt syst appendt
HAS_IMPORTLIBt importlibt
import_modulet
__import__t xmt XenAPIt ImportErrort AttributeErrort False( t debian_xen_versiont
xenversiont xapipath( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt
_check_xenapi3 s
c C@ s t � t k r t St d f S( Nu Module xapi: xenapi check failed( R R t __virtualname__( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt __virtual__E s c c@ s� t � } t d d � } t d d � } t d d � } | sH d } n | sW d } n | sf d } n zR y. | j | � } | j j | | � | j VWn t k
r� t d � � n XWd | j j j � Xd S( uI
Get a session to XenAPI. By default, use the local UNIX socket.
u
config.optionu xapi.uriu
xapi.loginu
xapi.passwordu" httpu:///var/run/xend/xen-api.socku u# Failed to connect to XenAPI socket.N( R t __salt__t Sessiont xenapit login_with_passwordt ExceptionR t sessiont logout( t _xenapit xapi_urit
xapi_logint
xapi_passwordR& ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_xapi_sessionK s$
c C@ s@ x9 d d g D]+ } t j j j | � } | d k r
| Sq
Wd S( u6
Internal, returns xl or xm command line path
u xlu xmN( R
t utilsR t whicht None( t xtoolR ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt
_get_xtoolr s c C@ s t | | � j � S( u2
Internal, returns all members of rectype
( t getattrt get_all( t xapit rectype( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_all| s c C@ s7 y t | | � j | � d SWn t k
r2 t SXd S( u(
Internal, returns label's uuid
i N( R2 t get_by_name_labelR% R ( R4 R5 t label( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_label_uuid� s
c C@ s t | | � j | � S( u2
Internal, returns a full record for uuid
( R2 t
get_record( R4 R5 t uuid( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_record� s c C@ s8 t | | | � } | t k r" t St | | � j | � S( u2
Internal, returns a full record for uuid
( R9 R R2 R: ( R4 R5 R8 R; ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_record_by_label� s c C@ s) | d } t | d j | � � j | � S( u8
Internal, returns metrics record for a rectype
u metricsu {0}_metrics( R2 R R: ( R4 R5 t recordt
metrics_id( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_metrics_record� s
c C@ s8 | } x+ | D]# } | | k r, | | } q
d Sq
W| S( u)
Internal, get value from record
N( R/ ( R> t keyst datat key( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _get_val� s
c C@ sx t � �i } | j j � } g } xF | D]> } | j j | � d t k r( | j | j j | � � q( q( W| SWd QXd S( u�
Return a list of virtual machine names on the minion
CLI Example:
.. code-block:: bash
salt '*' virt.list_domains
u is_control_domainN( R, t VMR3 R: R R t get_name_label( R4 t hostst rett _host( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt list_domains� s
c @ s� t � �� � � f d � } i } | rO | | � } | d k r� | | | <q� n? x< t � D]1 } | | � } | d k rY | | � | | <qY qY W| SWd QXd S( u
Return detailed information about the vms.
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� t � d | � } | t k r" t St � d | � } i | d d 6t | d g � d 6| d d 6t | � d 6t | � d 6t t | d
g � � d 6t | d � d
6t | d g � d 6S( Nu VMu VCPUs_numberu cpuu VCPUs_maxu maxCPUu VCPUs_utilisationu cputimeu disksu nicsu memory_dynamic_maxu maxMemu
memory_actualu memu power_stateu state( R= R R@ RD t get_diskst get_nicst int( t vm_t vm_rect vm_metrics_rec( R4 ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt _info� s
N( R, R/ RJ ( RN RQ t infoRH ( ( R4 s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt vm_info� s
c C@ sr t � �c } i } | r6 t | d | � d | | <| Sx+ t � D] } t | d | � d | | <q@ W| SWd QXd S( u
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.
CLI Example:
.. code-block:: bash
salt '*' virt.vm_state <vm name>
u VMu power_stateN( R, R= RJ ( RN R4 RR ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt vm_state� s
c
@ sw t � �h} t | d t | d � d � } t | d | d d � � t | d | � } � f d � } � f d � } � f d � } i t | d d g � d
6| � d 6| � d 6t | d
d g � d 6t | d d g � d 6t | d � d d d 6t | d d g � d 6| � d 6t | d � d d d 6t | d
d g � d 6t | d
d g � d 6t | d
d g � d 6d j t | d g � � d 6t | d g � d! 6t | d" d# g � d# 6t | d" d$ g � d$ 6t | d" d% g � d% 6t | d
d& g � d& 6t | d
d' g � d' 6t | d
d( g � d( 6t | d
d) g � d) 6t | d
d* g � d* 6t | d
d+ g � d+ 6} | SWd, QXd, S(- u�
Return a dict with information about this node
CLI Example:
.. code-block:: bash
salt '*' virt.node_info
u hosti u host_cpuu host_CPUsc @ sQ g � D]" } d | k r t � d � ^ q } | rI t | � t | � Sd Sd S( Nu speedi ( RM t sumt len( t host_cpu_itt
cpu_speeds( t host_cpu_rec( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt getCpuMhz s
"c @ s � r � d Sd S( Nu features( ( ( RY ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt getCpuFeatures( s c @ s> d } x1 � D]) } t � d � d k r
| d 7} q
q
W| S( Ni u cpu_pooli ( RV ( t cntRW ( RY ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt getFreeCpuCount, s
u cpu_configurationu nr_cpusu cpucoresu cpufeaturesu cpumhzu software_versionu machineu cpuarchu threads_per_coreu
cputhreadsu memory_totali u phymemoryu cores_per_socketu cores_per_socketsu free_cpusu memory_freeu free_memoryu xen_majoru xen_minoru xen_extrau u capabilitiesu xen_capsu sched_policyu
xen_scheduleru other_configu xen_pagesizeu platform_paramsu xen_commandlineu
xen_changesetu cc_compileru
cc_compile_byu cc_compile_domainu cc_compile_dateu xend_config_formatN( R, R< R6 R@ RD RM t join( R4 t host_rect host_metrics_recRZ R[ R] RR ( ( RY s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt node_info sb
c C@ s� t � �� } i } t | d | � } | t k r4 t SxS | d D]G } t | d | � } i | d d 6| d d 6| d d 6| | d <q? W| SWd QXd S(
u�
Return info about the network interfaces of a named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_nics <vm name>
u VMu VIFsu VIFu MACu macu deviceu MTUu mtuN( R, R= R R< ( RN R4 t nicRO t vift vif_rec( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyRL a s
c C@ sD g } t | � } | d k r" d Sx | D] } | j | � q) W| S( u�
Return a list off MAC addresses from the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_macs <vm name>
N( RL R/ R ( RN t macst nicsRb ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt get_macs| s
c C@ s� t � �� } i } t | d | � } | t k r4 t Sxu | j j | � D]a } | j j | � } | sk qG n | j j | � } i | d d 6| d d 6| d d 6| | <qG W| SWd QXd S( u
Return the disks of a named vm
CLI Example:
.. code-block:: bash
salt '*' virt.get_disks <vm name>
u VMu backendu device-typeu typeu protocolN( R, R9 R RE t get_VBDst VBDt
get_devicet get_runtime_properties( RN R4 t diskt vm_uuidt vbdt devt prop( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyRK � s
c C@ s� t � �� } t | � d d } t | d | � } | t k rB t Sy. | j j | | � | j j | | � t SWn t k
r� t SXWd QXd S( u�
Changes the amount of memory allocated to VM.
Memory is to be specified in MB
CLI Example:
.. code-block:: bash
salt '*' virt.setmem myvm 768
i u VMN( R, RM R9 R RE t set_memory_dynamic_max_livet set_memory_dynamic_min_livet TrueR% ( RN t memoryR4 t
mem_targetRm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt setmem� s
c C@ sh t � �Y } t | d | � } | t k r. t Sy | j j | | � t SWn t k
r] t SXWd QXd S( u�
Changes the amount of vcpus allocated to VM.
vcpus is an int representing the number to be assigned
CLI Example:
.. code-block:: bash
salt '*' virt.setvcpus myvm 2
u VMN( R, R9 R RE t set_VCPUs_number_liveRs R% ( RN t vcpusR4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt setvcpus� s
c
C@ s� t � �� } t | d | � } | t k r. t Sd � } | d k rR | d � } n | d j | � � } y' | j j | d j | � | � t SWn7 t k
r� t d d j t � | | | � d t �SXWd
QXd
S( u�
Set which CPUs a VCPU can use.
CLI Example:
.. code-block:: bash
salt 'foo' virt.vcpu_pin domU-id 2 1
salt 'foo' virt.vcpu_pin domU-id 2 2-6
u VMc S@ s g } x� | j d � D]� } | d k r. q n d | k r� | j d � \ } } x� t t | � t | � d � D] } | j t | � � qo Wq | d d k r� g | D]" } | t | d � k r� | ^ q� } q | j t | � � q W| j � d j t t | � � S( Nu ,u u -i i u ^( t splitR RM R t sortR^ R t str( t cpulistt cpust ct xt yt i( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt cpu_make_map� s &2
u allu 0-63u {0}u cpumap{0}u cmd.runu {0} vcpu-pin {1} {2} {3}t python_shellN(
R, R9 R R RE t add_to_VCPUs_params_liveRs R% R! R1 ( RN t vcpuR~ R4 Rm R� t cpumap( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt vcpu_pin� s
c C@ s t � d S( u�
Return an int representing the amount of memory that has not been given
to virtual machines on this node
CLI Example:
.. code-block:: bash
salt '*' virt.freemem
u free_memory( Ra ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt freemem s c C@ s t � d S( u�
Return an int representing the number of unallocated cpus on this
hypervisor
CLI Example:
.. code-block:: bash
salt '*' virt.freecpu
u free_cpus( Ra ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt freecpu% s c C@ s i t � d 6t � d 6S( u�
Return the node_info, vm_info and freemem
CLI Example:
.. code-block:: bash
salt '*' virt.full_info
u node_infou vm_info( Ra RS ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt full_info3 s
c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( u�
Send a soft shutdown signal to the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.shutdown <vm name>
u VMN( R, R9 R RE t clean_shutdownRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt shutdown@ s
c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( uo
Pause the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.pause <vm name>
u VMN( R, R9 R RE t pauseRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyR� U s
c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( uq
Resume the named vm
CLI Example:
.. code-block:: bash
salt '*' virt.resume <vm name>
u VMN( R, R9 R RE t unpauseRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt resumej s
c C@ s# t d d j t � | � d t �S( u�
Start a defined domain
CLI Example:
.. code-block:: bash
salt '*' virt.start <path to Xen cfg file>
u cmd.runu {0} create {1}R� ( R! R R1 R ( t config_( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt start s c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( u~
Reboot a domain via ACPI request
CLI Example:
.. code-block:: bash
salt '*' virt.reboot <vm name>
u VMN( R, R9 R RE t clean_rebootRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt reboot� s
c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( u�
Reset a VM by emulating the reset button on a physical machine
CLI Example:
.. code-block:: bash
salt '*' virt.reset <vm name>
u VMN( R, R9 R RE t hard_rebootRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt reset� s
i i����c
C@ s� t � �� } t | d | � } | t k r. t Si | d 6| d 6| d 6| d 6} y' | j j | | t | � | � t SWn t k
r� t SXWd QXd S( u�
Migrates the virtual machine to another hypervisor
CLI Example:
.. code-block:: bash
salt '*' virt.migrate <vm name> <target hypervisor> [live] [port] [node] [ssl] [change_home_server]
Optional values:
live
Use live migration
port
Use a specified port
node
Use specified NUMA node on target
ssl
use ssl connection for migration
change_home_server
change home server for managed domains
u VMu portu nodeu sslu change_home_serverN( R, R9 R RE t migratet boolRs R% (
RN t targett livet portt nodet sslt change_home_serverR4 Rm t other_config( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyR� � s
c C@ se t � �V } t | d | � } | t k r. t Sy | j j | � t SWn t k
rZ t SXWd QXd S( u�
Hard power down the virtual machine, this is equivalent to pulling the
power
CLI Example:
.. code-block:: bash
salt '*' virt.stop <vm name>
u VMN( R, R9 R RE t
hard_shutdownRs R% ( RN R4 Rm ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt stop� 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( u�
Returns a bool whether or not this node is a hypervisor of any kind
CLI Example:
.. code-block:: bash
salt '*' virt.is_hyper
u virtual_subtypeu Xen Dom0u
/proc/modulesu xen_Nu xenstoreu cmd.runu ps(
R R t KeyErrorR
R- t filest fopent stringutilst
to_unicodet readt OSErrort IOErrorR! ( t fp_( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt is_hyper� s
!c @ sm t � �^ � � f d � } i } | r; | | � | | <| Sx! t � D] } | | � | | <qE W| SWd QXd S( u�
Return cputime used by the vms on this hyper in a
list of dicts:
.. 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
c @ s� t � d | � } t | d � } | t k r2 t St � d | � } t | d � } t | d d � } d } | r� d | | | } n i t | � d 6t d j | � � d
6S( Nu VMu host_CPUsu VCPUs_numberu VCPUs_utilisationu 0i gH�����z>u cputimeu {0:.0f}u cputime_percent( R= RV R R@ RM R ( RN R_ t host_cpust host_metricsRx t cputimet cputime_percent( R4 ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyRQ , s N( R, RJ ( RN RQ RR ( ( R4 s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt
vm_cputime s c @ sl t � �] � � f d � } i } | r: | | � | | <n$ x! t � D] } | | � | | <qD W| SWd QXd S( uV
Return combined network counters used by the vms on this hyper in a
list of dicts:
.. code-block:: python
[
'your-vm': {
'io_read_kbs' : 0,
'io_total_read_kbs' : 0,
'io_total_write_kbs' : 0,
'io_write_kbs' : 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| i } t � d | � } | t k r( t SxM | d D]A } t � d | � } t � d | � | | d <| | d d =q3 W| S( Nu VMu VIFsu VIFu deviceu last_updated( R= R R< R@ ( RN RH RO Rc Rd ( R4 ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyRQ ` s N( R, RJ ( RN RQ RR ( ( R4 s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt vm_netstatsE s
c @ sl t � �] � � f d � } i } | r: | | � | | <n$ x! t � D] } | | � | | <qD W| SWd QXd S( u�
Return disk usage counters used by the vms on this hyper in a
list of dicts:
.. code-block:: python
[
'your-vm': {
'io_read_kbs' : 0,
'io_write_kbs' : 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_diskstats
c @ s� i } t � d | � } | t k r( t SxU � j j | � D]A } t � d | � } t � d | � | | d <| | d d =q; W| S( Nu VMu VBDu deviceu last_updated( R9 R RE Rh R< R@ ( RN RH Rm Rn t vbd_rec( R4 ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyRQ � s N( R, RJ ( RN RQ RR ( ( R4 s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt vm_diskstatsv s
(= t __doc__t
__future__R R R R t
contextlibR t salt.ext.six.movesR R R Rs R R R t salt.utils.filesR
t salt.utils.patht salt.utils.stringutilst salt.modules.cmdmodt salt.exceptionsR R R R t contextmanagerR, R1 R6 R9 R< R= R@ RD RJ R/ RS RT Ra RL Rg RK Rv Ry R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/xapi_virt.pyt <module> sh
'
+ U 7
( 2 1
Mini Shell