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 Open the serial console immediately after booting the guest. This is
72 the same as using the C<mclu console> subcommand, but quicker.
76 Specify the amount of memory (RAM) to give this guest. You can use
77 a number followed by a unit, eg. C<--memory 4G>
81 Specify the amount of disk space to give this guest. You can use
82 a number followed by a unit, eg. C<--size 20G>
84 =item B<--timezone TZ>
86 Specify the timezone, eg. C<--timezone Europe/London>
90 Specify the number of virtual CPUs to give to the guest. The default
91 is the number of physical CPUs, but not more than 4.
95 Open the graphical console immediately after booting the guest. This is
96 the same as using the C<mclu viewer> subcommand, but quicker.
100 =item B<mclu console [host:]guest>
102 Connect to the serial console console of the named guest.
104 =item B<mclu destroy [host:]guest>
106 Destroy the named guest.
108 Note this permanently deletes the guest and its data.
110 =item B<mclu list [--active] [--all] [--templates]>
112 List all active (running) guests and/or templates. You can use
113 the following options:
119 List only active (running) guests.
123 List active (running) guests, and templates. This is the default.
131 =item B<mclu off node|wildcard ...>
133 Switch the node(s) off. Wildcards can be used in place of hostnames.
135 mclu checks that no guests are running on the nodes. Migrate or shut
136 down the guests first.
138 =item B<mclu on node|wildcard ...>
140 Switch the node(s) on. Wildcards can be used in place of hostnames.
142 This requires Wake-on-LAN support, both on the target host and in the
143 mclu configuration. mclu must have been compiled with the L<wol(1)>
144 client installed, and the C<mclu.conf> file must list a MAC address
148 host0 mac=11:22:33:44:55:66
149 host1 mac=11:22:33:44:55:67
151 =item B<mclu reboot [host:]guest>
157 Display the status of the cloud. This shows you which nodes are on
158 and off, and the amount of resources used and free on each node.
160 =item B<mclu viewer [host:]guest>
162 Open the graphical console of the guest (using L<virt-viewer(1)>).
167 =head1 CONFIGURATION FILE
173 =head1 TEMPLATE FILES
178 =head1 ENVIRONMENT VARIABLES
184 May be used to override the default configuration file location
185 (C</etc/mclu.conf>). See L</CONFIGURATION FILE> above.
189 The path to the directory that contains template files. See
190 L</TEMPLATE FILES> above.
202 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
206 Richard W.M. Jones <rjones @ redhat . com>
210 (C) Copyright 2014-2015 Red Hat Inc.
212 This program is free software; you can redistribute it and/or modify
213 it under the terms of the GNU General Public License as published by
214 the Free Software Foundation; either version 2 of the License, or
215 (at your option) any later version.
217 This program is distributed in the hope that it will be useful,
218 but WITHOUT ANY WARRANTY; without even the implied warranty of
219 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
220 GNU General Public License for more details.
222 You should have received a copy of the GNU General Public License
223 along with this program; if not, write to the Free Software
224 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.