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 number of virtual CPUs to give to the guest. The default
82 is the number of physical CPUs, but not more than 4.
86 Open the graphical console immediately after booting the guest. This is
87 the same as using the C<mclu viewer> subcommand, but quicker.
91 =item B<mclu console [host:]guest>
93 Connect to the serial console console of the named guest.
95 =item B<mclu destroy [host:]guest>
97 Destroy the named guest.
99 Note this permanently deletes the guest and its data.
101 =item B<mclu list [--active] [--all] [--templates]>
103 List all active (running) guests and/or templates. You can use
104 the following options:
110 List only active (running) guests.
114 List active (running) guests, and templates. This is the default.
122 =item B<mclu off node|wildcard ...>
124 Switch the node(s) off. Wildcards can be used in place of hostnames.
126 mclu checks that no guests are running on the nodes. Migrate or shut
127 down the guests first.
129 =item B<mclu on node|wildcard ...>
131 Switch the node(s) on. Wildcards can be used in place of hostnames.
133 This requires Wake-on-LAN support, both on the target host and in the
134 mclu configuration. mclu must have been compiled with the L<wol(1)>
135 client installed, and the C<mclu.conf> file must list a MAC address
139 host0 mac=11:22:33:44:55:66
140 host1 mac=11:22:33:44:55:67
142 =item B<mclu reboot [host:]guest>
148 Display the status of the cloud. This shows you which nodes are on
149 and off, and the amount of resources used and free on each node.
151 =item B<mclu viewer [host:]guest>
153 Open the graphical console of the guest (using L<virt-viewer(1)>).
158 =head1 CONFIGURATION FILE
164 =head1 TEMPLATE FILES
169 =head1 ENVIRONMENT VARIABLES
175 May be used to override the default configuration file location
176 (C</etc/mclu.conf>). See L</CONFIGURATION FILE> above.
180 The path to the directory that contains template files. See
181 L</TEMPLATE FILES> above.
193 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
197 Richard W.M. Jones <rjones @ redhat . com>
201 (C) Copyright 2014-2015 Red Hat Inc.
203 This program is free software; you can redistribute it and/or modify
204 it under the terms of the GNU General Public License as published by
205 the Free Software Foundation; either version 2 of the License, or
206 (at your option) any later version.
208 This program is distributed in the hope that it will be useful,
209 but WITHOUT ANY WARRANTY; without even the implied warranty of
210 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
211 GNU General Public License for more details.
213 You should have received a copy of the GNU General Public License
214 along with this program; if not, write to the Free Software
215 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.