<html><head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Libvirt" rel="Chapter" href="Libvirt.html"> <link title="Libvirt_version" rel="Chapter" href="Libvirt_version.html"><title>Libvirt.Domain</title> </head> <body> <code class="code"><span class="keyword">sig</span><br> <span class="keyword">type</span> <span class="keywordsign">'</span>rw t<br> <span class="keyword">type</span> state =<br> <span class="constructor">InfoNoState</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoRunning</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoBlocked</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoPaused</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoShutdown</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoShutoff</span><br> <span class="keywordsign">|</span> <span class="constructor">InfoCrashed</span><br> <span class="keyword">type</span> info = {<br> state : <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.state;<br> max_mem : int64;<br> memory : int64;<br> nr_virt_cpu : int;<br> cpu_time : int64;<br> }<br> <span class="keyword">type</span> vcpu_state = <span class="constructor">VcpuOffline</span> <span class="keywordsign">|</span> <span class="constructor">VcpuRunning</span> <span class="keywordsign">|</span> <span class="constructor">VcpuBlocked</span><br> <span class="keyword">type</span> vcpu_info = {<br> number : int;<br> vcpu_state : <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.vcpu_state;<br> vcpu_time : int64;<br> cpu : int;<br> }<br> <span class="keyword">type</span> sched_param = string * <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.sched_param_value<br> <span class="keyword">and</span> sched_param_value =<br> <span class="constructor">SchedFieldInt32</span> <span class="keyword">of</span> int32<br> <span class="keywordsign">|</span> <span class="constructor">SchedFieldUInt32</span> <span class="keyword">of</span> int32<br> <span class="keywordsign">|</span> <span class="constructor">SchedFieldInt64</span> <span class="keyword">of</span> int64<br> <span class="keywordsign">|</span> <span class="constructor">SchedFieldUInt64</span> <span class="keyword">of</span> int64<br> <span class="keywordsign">|</span> <span class="constructor">SchedFieldFloat</span> <span class="keyword">of</span> float<br> <span class="keywordsign">|</span> <span class="constructor">SchedFieldBool</span> <span class="keyword">of</span> bool<br> <span class="keyword">type</span> typed_param = string * <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.typed_param_value<br> <span class="keyword">and</span> typed_param_value =<br> <span class="constructor">TypedFieldInt32</span> <span class="keyword">of</span> int32<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldUInt32</span> <span class="keyword">of</span> int32<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldInt64</span> <span class="keyword">of</span> int64<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldUInt64</span> <span class="keyword">of</span> int64<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldFloat</span> <span class="keyword">of</span> float<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldBool</span> <span class="keyword">of</span> bool<br> <span class="keywordsign">|</span> <span class="constructor">TypedFieldString</span> <span class="keyword">of</span> string<br> <span class="keyword">type</span> migrate_flag = <span class="constructor">Live</span><br> <span class="keyword">type</span> memory_flag = <span class="constructor">Virtual</span><br> <span class="keyword">type</span> list_flag = <span class="constructor">ListActive</span> <span class="keywordsign">|</span> <span class="constructor">ListInactive</span> <span class="keywordsign">|</span> <span class="constructor">ListAll</span><br> <span class="keyword">type</span> block_stats = {<br> rd_req : int64;<br> rd_bytes : int64;<br> wr_req : int64;<br> wr_bytes : int64;<br> errs : int64;<br> }<br> <span class="keyword">type</span> interface_stats = {<br> rx_bytes : int64;<br> rx_packets : int64;<br> rx_errs : int64;<br> rx_drop : int64;<br> tx_bytes : int64;<br> tx_packets : int64;<br> tx_errs : int64;<br> tx_drop : int64;<br> }<br> <span class="keyword">val</span> max_peek : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int<br> <span class="keyword">val</span> create_linux :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.xml <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.rw <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> lookup_by_id : <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> int <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> lookup_by_uuid :<br> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.uuid <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> lookup_by_uuid_string :<br> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> string <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> lookup_by_name : <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> string <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> destroy : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> free : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> suspend : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> resume : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> save : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.filename <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> restore : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.filename <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> core_dump : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.filename <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> shutdown : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> reboot : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> get_name : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> get_uuid : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.uuid<br> <span class="keyword">val</span> get_uuid_string : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> get_id : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int<br> <span class="keyword">val</span> get_os_type : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> get_max_memory : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int64<br> <span class="keyword">val</span> set_max_memory : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> set_memory : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> get_info : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.info<br> <span class="keyword">val</span> get_xml_desc : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.xml<br> <span class="keyword">val</span> get_scheduler_type : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string * int<br> <span class="keyword">val</span> get_scheduler_parameters :<br> [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.sched_param array<br> <span class="keyword">val</span> set_scheduler_parameters :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.sched_param array <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> define_xml :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.xml <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.rw <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> undefine : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> create : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> get_autostart : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> bool<br> <span class="keyword">val</span> set_autostart : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> bool <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> set_vcpus : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> pin_vcpu : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int <span class="keywordsign">-></span> string <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> get_vcpus :<br> [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span><br> int <span class="keywordsign">-></span> int <span class="keywordsign">-></span> int * <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.vcpu_info array * string<br> <span class="keyword">val</span> get_cpu_stats :<br> [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.typed_param list array<br> <span class="keyword">val</span> get_max_vcpus : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> int<br> <span class="keyword">val</span> attach_device : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.xml <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> detach_device : [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.xml <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> migrate :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span><br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span><br> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.migrate_flag list <span class="keywordsign">-></span><br> ?dname:string <span class="keywordsign">-></span><br> ?uri:string <span class="keywordsign">-></span> ?bandwidth:int <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.rw <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> <span class="keyword">val</span> block_stats :<br> [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.block_stats<br> <span class="keyword">val</span> interface_stats :<br> [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> string <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.interface_stats<br> <span class="keyword">val</span> block_peek :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span><br> string <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> int <span class="keywordsign">-></span> string <span class="keywordsign">-></span> int <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> memory_peek :<br> [> <span class="keywordsign">`</span><span class="constructor">W</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span><br> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.memory_flag list <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> int <span class="keywordsign">-></span> string <span class="keywordsign">-></span> int <span class="keywordsign">-></span> unit<br> <span class="keyword">external</span> const : [> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t <span class="keywordsign">-></span> <span class="constructor">Libvirt</span>.ro <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t<br> = <span class="string">"%identity"</span><br> <span class="keyword">val</span> get_domains :<br> ([> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="keyword">as</span> <span class="keywordsign">'</span>a) <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span><br> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.list_flag list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t list<br> <span class="keyword">val</span> get_domains_and_infos :<br> ([> <span class="keywordsign">`</span><span class="constructor">R</span> ] <span class="keyword">as</span> <span class="keywordsign">'</span>a) <span class="constructor">Libvirt</span>.<span class="constructor">Connect</span>.t <span class="keywordsign">-></span><br> <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.list_flag list <span class="keywordsign">-></span><br> (<span class="keywordsign">'</span>a <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.t * <span class="constructor">Libvirt</span>.<span class="constructor">Domain</span>.info) list<br> <span class="keyword">end</span></code></body></html>