3 mclu - Mini Cloud, a tiny, sane cloud
7 mclu [-f mclu.conf] [--options] [list|status|boot|...] [...]
24 Display brief help message and exit.
28 =item B<--config-file mclu.conf>
30 Specify the path to the configuration file. If this command option is
31 I<not> given, then the environment variable C<MCLU_CONFIG> is used,
32 and if that environment variable is not set then C</etc/mclu.conf> is
35 See also: L</CONFIGURATION FILE> below.
41 Enable verbose / debugging messages.
47 Display version number and exit.
58 =item B<mclu boot template [host:]name [--memory ..] [--vcpus ..]>
60 Boot (create) a new instance from B<template>. It will be started on
61 B<host> and named B<name>. If the C<host:> prefix is not given then
62 it is started on the first host that has sufficient free memory.
64 The instance is created by running the template script. You can
65 control resources using the following options:
71 Specify the amount of memory (RAM) to give this guest. You can use
72 a number followed by a unit, eg. C<--memory=4G>
76 Specify the number of virtual CPUs to give to the guest. The default
77 is the number of physical CPUs, but not more than 4.
81 =item B<mclu console [host:]guest>
83 Connect to the serial console console of the named guest.
85 =item B<mclu destroy [host:]guest>
87 Destroy the named guest.
89 Note this permanently deletes the guest and its data.
91 =item B<mclu list [--active] [--all] [--templates]>
93 List all active (running) guests and/or templates. You can use
94 the following options:
100 List only active (running) guests.
104 List active (running) guests, and templates. This is the default.
112 =item B<mclu off node|wildcard ...>
114 Switch the node(s) off. Wildcards can be used in place of hostnames.
116 mclu checks that no guests are running on the nodes. Migrate or shut
117 down the guests first.
119 =item B<mclu on node|wildcard ...>
121 Switch the node(s) on. Wildcards can be used in place of hostnames.
123 This requires Wake-on-LAN support, both on the target host and in the
124 mclu configuration. mclu must have been compiled with the L<wol(1)>
125 client installed, and the C<mclu.conf> file must list a MAC address
129 host0 mac=11:22:33:44:55:66
130 host1 mac=11:22:33:44:55:67
132 =item B<mclu reboot [host:]guest>
138 Display the status of the cloud. This shows you which nodes are on
139 and off, and the amount of resources used and free on each node.
141 =item B<mclu viewer [host:]guest>
143 Open the graphical console of the guest (using L<virt-viewer(1)>).
148 =head1 CONFIGURATION FILE
154 =head1 TEMPLATE FILES
159 =head1 ENVIRONMENT VARIABLES
165 May be used to override the default configuration file location
166 (C</etc/mclu.conf>). See L</CONFIGURATION FILE> above.
170 The path to the directory that contains template files. See
171 L</TEMPLATE FILES> above.
183 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
187 Richard W.M. Jones <rjones @ redhat . com>
191 (C) Copyright 2014-2015 Red Hat Inc.
193 This program is free software; you can redistribute it and/or modify
194 it under the terms of the GNU General Public License as published by
195 the Free Software Foundation; either version 2 of the License, or
196 (at your option) any later version.
198 This program is distributed in the hope that it will be useful,
199 but WITHOUT ANY WARRANTY; without even the implied warranty of
200 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
201 GNU General Public License for more details.
203 You should have received a copy of the GNU General Public License
204 along with this program; if not, write to the Free Software
205 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.