mclu version 2
[mclu.git] / mclu_list.mli
1 (* mclu: Mini Cloud
2  * Copyright (C) 2014-2015 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  *)
18
19 val get_arg_speclist : unit -> (Arg.key * Arg.spec * Arg.doc) list
20
21 val run : verbose:bool -> string list -> unit
22
23 type dom_info = {
24   dom_name : string;
25   dom_info : Libvirt.Domain.info;
26 }
27
28 val active_guests : ?verbose:bool -> ?nodes:Mclu_conf.node list -> unit -> (Mclu_conf.node * dom_info list) list
29 (** Return the active (running) guests on each node.
30
31     The optional [?nodes] parameter is the list of nodes to start
32     with.  If not passed, then it examines every node.  This parameter
33     is useful if you already know which nodes are up, to avoid trying
34     to connect to down nodes a second time. *)