Current File : //lib/python2.7/site-packages/salt/utils/virtualbox.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z d d l
j j Z e j e � Z d d l m Z d d l m Z e Z y d d l Z e Z Wn$ e k
r� d Z e j d � n Xd a i d d d
d d d
d d g d 6d d d d d d d d d d d d g d 6Z dr Z ds dt du dv dw dx dy dz d{ d| d} d~ d d� d� d� d� d� d� d� d� d� d� d� d� d� d� d� g Z! e" e! � Z# e" e$ e! � � Z% dW � Z& dX � Z' dY � Z( d d dZ � Z) d d d d d[ � Z* d\ d] � Z+ d\ d^ d d_ � Z, d d d d` � Z- da � Z. d db � Z/ d d d dc dd � Z0 de � Z1 d dc df � Z2 d dc dg � Z3 d dc dh � Z4 d d d d di � Z5 dj � Z6 dk � Z7 dl � Z8 dm � Z9 dn � Z: do � Z; dp � Z< dq � Z= d S(� u�
Utilities to help make requests to virtualbox
The virtualbox SDK reference can be found at http://download.virtualbox.org/virtualbox/SDKRef.pdf
This code assumes vboxapi.py from VirtualBox distribution
being in PYTHONPATH, or installed system-wide
i ( t absolute_importt print_functiont unicode_literalsN( t wait_for( t six( t rangeu Couldn't import VirtualBox APIu idu nameu
accessibleu descriptionu groupsu
memorySizeu OSTypeIdu stateu IMachineu adapterTypeu slotu enabledu
MACAddressu bridgedInterfaceu hostOnlyInterfaceu internalNetworku
NATNetworku
genericDriveru cableConnectedu lineSpeedu INetworkAdapteru Unknownu* This state is unknown to us. Might be new?u Nullu" Null value (never used by the API)u
PoweredOffu} The machine is not running and has no saved execution state; it has either never been started or been shut down successfully.u Savedu� The machine is not currently running, but the execution state of the machine has been saved to an external file when it was running, from where it can be resumed.u
Teleportedu� The machine was teleported to a different host (or process) and then powered off. Take care when powering it on again may corrupt resources it shares with the teleportation target (e.g. disk and network).u Abortedu� The process running the machine has terminated abnormally. This may indicate a crash of the VM process in host execution context, or the VM process has been terminated externally.u Runningu( The machine is currently being executed.u Pausedu) Execution of the machine has been paused.u Stucku} Execution of the machine has reached the 'Guru Meditation' condition. This indicates a severe error in the hypervisor itself.u Teleportingu� The machine is about to be teleported to a different host or process. It is possible to pause a machine in this state, but it will go to the TeleportingPausedVM state and it will not be possible to resume it again unless the teleportation fails.u LiveSnapshottingu! A live snapshot is being taken. The machine is running normally, but some of the runtime configuration options are inaccessible. Also, if paused while in this state it will transition to OnlineSnapshotting and it will not be resume the execution until the snapshot operation has completed.u StartinguJ Machine is being started after powering it on from a zero execution state.u Stoppinguk Machine is being normally stopped powering it off, or after the guest OS has initiated a shutdown sequence.u Savingu0 Machine is saving its execution state to a file.u Restoringuq Execution state of the machine is being restored from a file after powering it on from the saved execution state.u TeleportingPausedVMu� The machine is being teleported to another host or process, but it is not running. This is the paused variant of the Teleporting state.u
TeleportingInu> Teleporting the machine state in from another host or process.u FaultTolerantSyncinguH The machine is being synced with a fault tolerant VM running else-where.u DeletingSnapshotOnlineuk Like DeletingSnapshot , but the merging of media is ongoing in the background while the machine is running.u DeletingSnapshotPausedul Like DeletingSnapshotOnline , but the machine was paused when the merging of differencing media was started.u OnlineSnapshottinguf Like LiveSnapshotting , but the machine was paused when the merging of differencing media was started.u RestoringSnapshotuH A machine snapshot is being restored; this typically does not take long.u DeletingSnapshotu� A machine snapshot is being deleted; this can take a long time since this may require merging differencing media. This value indicates that the machine is not running while the snapshot is being deleted.u SettingUpu' Lengthy setup operation is in progress.u Snapshottingu Taking an (offline) snapshot.u FirstOnlineuE Pseudo-state: first online state (for use in relational expressions).u
LastOnlineuD Pseudo-state: last online state (for use in relational expressions).u FirstTransientuH Pseudo-state: first transient state (for use in relational expressions).u
LastTransientuG Pseudo-state: last transient state (for use in relational expressions).c C@ s> t d k r: t r: t j j j t � t j d d � a n t S( u�
Creates a 'singleton' manager to communicate with a local virtualbox hypervisor.
@return:
@rtype: VirtualBoxManager
N( t _virtualboxManagert Nonet HAS_LIBSt saltt utilst compatt reloadt vboxapit VirtualBoxManager( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_get_manager� s c C@ s8 t � y
t j } Wn t k
r3 t j � } n X| S( um
Needed for certain operations in the SDK e.g creating sessions
@return:
@rtype: IVirtualBox
( R R t vboxt AttributeErrort
getVirtualBox( R ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt
vb_get_box� s
c C@ s> t � j } g d d g D] } | j | � ^ q } t | � S( uR
Max number of slots any machine can have
@return:
@rtype: number
i i ( R t systemPropertiest getMaxNetworkAdapterst sum( t syspropst adapter_typet totals( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_get_max_network_slots� s
"c C@ s� | r t � j | � } n g } xm t t � � D]\ } yB | j | � } t | d � } | j d � | d <| j | � Wq1 t k
r� q1 Xq1 W| S( u�
A valid machine_name or a machine is needed to make this work!
@param machine_name:
@type machine_name: str
@param machine:
@type machine: IMachine
@return: INetorkAdapter's converted to dicts
@rtype: [dict]
u INetworkAdapteru u
properties( R t findMachineR R t getNetworkAdaptert vb_xpcom_to_attribute_dictt
getPropertiest appendt Exception( t machine_namet machinet network_adapterst it inetwork_adaptert network_adapter( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_get_network_adapters� s
c
C@ s= i | d 6| d 6| d 6} t t d | d | d g d | �S( u�
Wait until a machine has a network address to return or quit after the timeout
@param timeout: in seconds
@type timeout: float
@param step: How regularly we want to check for ips (in seconds)
@type step: float
@param machine_name:
@type machine_name: str
@param machine:
@type machine: IMachine
@type wait_for_pattern: str
@param wait_for_pattern:
@type machine: str
@return:
@rtype: list
u machine_nameu machineu wait_for_patternt timeoutt stept defaultt func_kwargs( R t vb_get_network_addresses( R( R) R! R" t wait_for_patternt kwargs( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_wait_for_network_address� s
u Unlockedc C@ s# t t j d | � } | j | k S( u�
@param xp_session:
@type xp_session: ISession from the Virtualbox API
@param expected_state: The constant descriptor according to the docs
@type expected_state: str
@return:
@rtype: bool
u
SessionState_( t getattrR t constantst state( t
xp_sessiont expected_statet state_value( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt _check_session_state� s i
c
C@ s2 | | f } t t d | d | d t d | �d S( u�
Waits until a session state has been reached, checking at regular intervals.
@param xp_session:
@type xp_session: ISession from the Virtualbox API
@param state: The constant descriptor according to the docs
@type state: str
@param timeout: in seconds
@type timeout: int | float
@param step: Intervals at which the value is checked
@type step: int | float
@return: Did we reach the state?
@rtype: bool
R( R) R* t func_argsN( R R6 t False( R3 R2 R( R) t args( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_wait_for_session_state� s c C@ s` | r t � j | � } n g } t j d � | j t j j k rLt j d � | rz | j | � rz t j d | � d S| j d � } | s� t j d | � d Sy t
| � } xl t | � D]^ } y2 | j d j | � � } | r� | j
| � n Wq� t k
r } t j | j � q� Xq� WWqLt k
rH} t j | j � d SXn t j d | � | S( u.
TODO distinguish between private and public addresses
A valid machine_name or a machine is needed to make this work!
!!!
Guest prerequisite: GuestAddition
!!!
Thanks to Shrikant Havale for the StackOverflow answer http://stackoverflow.com/a/29335390
More information on guest properties: https://www.virtualbox.org/manual/ch04.html#guestadd-guestprops
@param machine_name:
@type machine_name: str
@param machine:
@type machine: IMachine
@return: All the IPv4 addresses we could get
@rtype: str[]
u checking for power on:u
got power on:u waiting for pattern:%s:u /VirtualBox/GuestInfo/Net/Countu waiting for net count:%s:u# /VirtualBox/GuestInfo/Net/{0}/V4/IPu returning ip_addresses:%s:N( R R t logt debugR2 R R1 t MachineState_Runningt getGuestPropertyValueR t intR t formatR R t messaget
ValueError( R! R" R- t ip_addressest _total_slotst total_slotsR$ t addresst e( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyR,
s6
c K@ sA t � } | j t � d � } g | D] } t | d | � ^ q% S( u�
Which machines does the hypervisor have
@param kwargs: Passed to vb_xpcom_to_attribute_dict to filter the attributes
@type kwargs: dict
@return: Untreated dicts of the machines known to the hypervisor
@rtype: [{}]
u machinesu IMachine( R t getArrayR R ( R. t managert machinesR" ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_list_machinesI s c C@ sj t � } t j d | � d } d } | j d | | | d � } | j | � t j d | � t | d � S( u�
Creates a machine on the virtualbox hypervisor
TODO pass more params to customize machine creation
@param name:
@type name: str
@return: Representation of the created machine
@rtype: dict
u Create virtualbox machine %s u Otheru Finished creating %su IMachineN( R R; t infoR t
createMachinet registerMachineR ( t nameR t groupst
os_type_idt new_machine( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_create_machineY s
i' c K@ s� t � } t j d | | � | j | � } d } d } | j d | | | d � } | j | | d � }
|
j | � t j d | | � | j | � t | d � S( u@
Tells virtualbox to create a VM by cloning from an existing one
@param name: Name for the new VM
@type name: str
@param clone_from:
@type clone_from: str
@param timeout: maximum time in milliseconds to wait or -1 to wait indefinitely
@type timeout: int
@return dict of resulting VM
u# Clone virtualbox machine %s from %su Otheru Finished cloning %s from %su IMachineN(
R R; RL R R RM t cloneTot waitForCompletionRN R ( RO t
clone_fromt
clone_modeR( R. R t source_machineRP RQ RR t progress( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_clone_vms s&
c C@ sH y | j | d d � SWn* t k
rC } t j | j d t �d SXd S( u�
Helper to try and start machines
@param machine:
@type machine: IMachine
@param session:
@type session: ISession
@return:
@rtype: IProgress or None
u t exc_infoN( t launchVMProcessR R; R< RA t TrueR ( R" t sessionRG ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt _start_machine� s
c K@ s t j � } | d } | | } t � } | j | � } t j | � } t j d | t | j � � zg | | f } t t
d | d | �}
|
s� | j | d d � }
n | t j � } |
j | d � Wd t j
| � X| t j � } t | d | �t j d | � t | d � S( u�
Tells Virtualbox to start up a VM.
Blocking function!
@param name:
@type name: str
@param timeout: Maximum time in milliseconds to wait or -1 to wait indefinitely
@type timeout: int
@return untreated dict of started VM
i� u Starting machine %s in state %sR( R7 u Nu Started machine %su IMachine( t timeR R R t getSessionObjectR; RL t vb_machinestate_to_strR2 R R_ R\ RU t closeMachineSessionR: R ( RO R( R. t
start_timet timeout_in_secondst max_timeR R" R^ R9 RY t time_left( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_start_vm� s&
c K@ s� t � } | j | � } t j d | � t j | � } z& | j } | j � } | j | � Wd t j | � t
| � Xt j d | t | j � � t
| d � S( u
Tells Virtualbox to stop a VM.
This is a blocking function!
@param name:
@type name: str
@param timeout: Maximum time in milliseconds to wait or -1 to wait indefinitely
@type timeout: int
@return untreated dict of stopped VM
u Stopping machine %sNu Stopped machine %s is now %su IMachine( R R R; RL R t openMachineSessiont consolet powerDownRU Rc R: Rb R2 R ( RO R( R. R R" R^ Rj RY ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt
vb_stop_vm� s
c C@ sg t � } t j d | � | j | � } | j d � } | j | � } | j | � t j d | � d S( u�
Attempts to get rid of a machine and all its files from the hypervisor
@param name:
@type name: str
@param timeout int timeout in milliseconds
u Destroying machine %si u Finished destroying machine %sN( R R; RL R t
unregistert deleteConfigRU ( RO R( R R" t filesRY ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_destroy_machine� s
c C@ s | rJ t j d j | � t j | � � } | sJ t j d | � t � Sn t | pb t j
| g � � } | r� | j | � } n | r� | j | � } n g } xt | D]l } t
| t � r� | d } | d }
| t | | |
� � f } n | t | | d � f } | j | � q� Wt | � S( u�
Attempts to build a dict from an XPCOM object.
Attributes that don't exist in the object return an empty string.
attribute_list = list of str or tuple(str,<a class>)
e.g attributes=[('bad_attribute', list)] --> { 'bad_attribute': [] }
@param xpcom:
@type xpcom:
@param interface_name: Which interface we will be converting from.
Without this it's best to specify the list of attributes you want
@type interface_name: str
@param attributes: Overrides the attributes used from XPCOM_ATTRIBUTES
@type attributes: attribute_list
@param excluded_attributes: Which should be excluded in the returned dict.
!!These take precedence over extra_attributes!!
@type excluded_attributes: attribute_list
@param extra_attributes: Which should be retrieved in addition those already being retrieved
@type extra_attributes: attribute_list
@return:
@rtype: dict
u XPCOM.+implementing {0}u7 Interface %s is unknown and cannot be converted to dicti i u ( t ret searchR@ R t text_typeR; t warningt dictt sett XPCOM_ATTRIBUTESt gett uniont
differencet
isinstancet tupleR0 R ( t xpcomt interface_namet
attributest excluded_attributest extra_attributest mt interface_attributest attribute_tuplest attributet attribute_namet attribute_classt value( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyR s& $
c C@ s� | j i | j d d � d 6| j d d � d 6d j | j d d � � d 6t | � d 6g d 6g d
6� d | k r� | d =n | S( u�
Make machine presentable for outside world.
!!!Modifies the input machine!!!
@param machine:
@type machine: dict
@return: the modified input machine
@rtype: dict
u idu u imageu {0} MBu
memorySizei u sizeu stateu private_ipsu
public_ips( t updateRx R@ t machine_get_machinestate_str( R" ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt treat_machine_dict@ s
c C@ s t | � d S( u�
Put a name to the state
@param machinestate: from the machine state enum from XPCOM
@type machinestate: int
@return:
@rtype: str
i ( t vb_machinestate_to_tuple( t machinestate( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyRb Z s
c C@ s t | � d S( u�
Describe the given state
@param machinestate: from the machine state enum from XPCOM
@type machinestate: int | str
@return:
@rtype: str
i ( R� ( R� ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_machinestate_to_descriptiong s c C@ sj t | t � r$ t j | t � } n- t | t j � rK t j | t � } n t } t j j
j | d t �S( uw
@param machinestate:
@type machinestate: int | str
@return:
@rtype: tuple(<name>, <description>)
t preserve_tuples(
R{ R? t MACHINE_STATES_ENUMRx t UNKNOWN_MACHINE_STATER t string_typest MACHINE_STATESR R
t datat decodeR] ( R� t ret( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyR� s s c C@ s t | j d � � S( Nu state( R� Rx ( t machinedict( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt machine_get_machinestate_tuple� s c C@ s t | j d � � S( Nu state( Rb Rx ( R� ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyR� � s c C@ s� y t � } | j | � t SWn� t k
r� } t | j t j � rQ | j } nB t | d � r� t t | d � t j � r� t | d � } n d } d | j
d � k r� t j | � n t
SXd S( u�
Checks in with the hypervisor to see if the machine with the given name is known
@param name:
@type name:
@return:
@rtype:
u msgu i u) Could not find a registered machine namedN( R R R] R R{ RA R R� t hasattrR0 t findR; t errorR8 ( RO R RG RA ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_machine_exists� s
*c K@ s( t � } | j | � } t | d | � S( u�
Attempts to fetch a machine from Virtualbox and convert it to a dict
@param name: The unique name of the machine
@type name:
@param kwargs: To be passed to vb_xpcom_to_attribute_dict
@type kwargs:
@return:
@rtype: dict
u IMachine( R R R ( RO R. R R" ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt vb_get_machine� s ( u Unknownu* This state is unknown to us. Might be new?( u Nullu" Null value (never used by the API)( u
PoweredOffu} The machine is not running and has no saved execution state; it has either never been started or been shut down successfully.( u Savedu� The machine is not currently running, but the execution state of the machine has been saved to an external file when it was running, from where it can be resumed.( u
Teleportedu� The machine was teleported to a different host (or process) and then powered off. Take care when powering it on again may corrupt resources it shares with the teleportation target (e.g. disk and network).( u Abortedu� The process running the machine has terminated abnormally. This may indicate a crash of the VM process in host execution context, or the VM process has been terminated externally.( u Runningu( The machine is currently being executed.( u Pausedu) Execution of the machine has been paused.( u Stucku} Execution of the machine has reached the 'Guru Meditation' condition. This indicates a severe error in the hypervisor itself.( u Teleportingu� The machine is about to be teleported to a different host or process. It is possible to pause a machine in this state, but it will go to the TeleportingPausedVM state and it will not be possible to resume it again unless the teleportation fails.( u LiveSnapshottingu! A live snapshot is being taken. The machine is running normally, but some of the runtime configuration options are inaccessible. Also, if paused while in this state it will transition to OnlineSnapshotting and it will not be resume the execution until the snapshot operation has completed.( u StartinguJ Machine is being started after powering it on from a zero execution state.( u Stoppinguk Machine is being normally stopped powering it off, or after the guest OS has initiated a shutdown sequence.( u Savingu0 Machine is saving its execution state to a file.( u Restoringuq Execution state of the machine is being restored from a file after powering it on from the saved execution state.( u TeleportingPausedVMu� The machine is being teleported to another host or process, but it is not running. This is the paused variant of the Teleporting state.( u
TeleportingInu> Teleporting the machine state in from another host or process.( u FaultTolerantSyncinguH The machine is being synced with a fault tolerant VM running else-where.( u DeletingSnapshotOnlineuk Like DeletingSnapshot , but the merging of media is ongoing in the background while the machine is running.( u DeletingSnapshotPausedul Like DeletingSnapshotOnline , but the machine was paused when the merging of differencing media was started.( u OnlineSnapshottinguf Like LiveSnapshotting , but the machine was paused when the merging of differencing media was started.( u RestoringSnapshotuH A machine snapshot is being restored; this typically does not take long.( u DeletingSnapshotu� A machine snapshot is being deleted; this can take a long time since this may require merging differencing media. This value indicates that the machine is not running while the snapshot is being deleted.( u SettingUpu' Lengthy setup operation is in progress.( u Snapshottingu Taking an (offline) snapshot.( u FirstOnlineuE Pseudo-state: first online state (for use in relational expressions).( u
LastOnlineuD Pseudo-state: last online state (for use in relational expressions).( u FirstTransientuH Pseudo-state: first transient state (for use in relational expressions).( u
LastTransientuG Pseudo-state: last transient state (for use in relational expressions).(> t __doc__t
__future__R R R t loggingRq R` t salt.utils.compatR t salt.utils.datat salt.utils.timeoutR t salt.ext.sixt extR t getLoggert __name__R; t salt.extt salt.ext.six.movesR R8 R R
R] t ImportErrorR R t traceR Rw R� t MACHINE_STATE_LISTRu R� t enumerateR� R R R R' R/ R6 R: R, RK RS RZ R_ Rh Rl Rp R R� Rb R� R� R� R� R� R� ( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/virtualbox.pyt <module> s�
< + * 4
Mini Shell