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 list [--active] [--all] [--templates]>
83 List all active (running) guests and/or templates. You can use
84 the following options:
90 List only active (running) guests.
94 List active (running) guests, and templates. This is the default.
102 =item B<mclu off node|wildcard ...>
104 Switch the node(s) off. Wildcards can be used in place of hostnames.
106 mclu checks that no guests are running on the nodes. Migrate or shut
107 down the guests first.
109 =item B<mclu on node|wildcard ...>
111 Switch the node(s) on. Wildcards can be used in place of hostnames.
113 This requires Wake-on-LAN support, both on the target host and in the
114 mclu configuration. mclu must have been compiled with the L<wol(1)>
115 client installed, and the C<mclu.conf> file must list a MAC address
119 host0 mac=11:22:33:44:55:66
120 host1 mac=11:22:33:44:55:67
124 Display the status of the cloud. This shows you which nodes are on
125 and off, and the amount of resources used and free on each node.
130 =head1 CONFIGURATION FILE
136 =head1 TEMPLATE FILES
141 =head1 ENVIRONMENT VARIABLES
147 May be used to override the default configuration file location
148 (C</etc/mclu.conf>). See L</CONFIGURATION FILE> above.
152 The path to the directory that contains template files. See
153 L</TEMPLATE FILES> above.
165 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
169 Richard W.M. Jones <rjones @ redhat . com>
173 (C) Copyright 2014-2015 Red Hat Inc.
175 This program is free software; you can redistribute it and/or modify
176 it under the terms of the GNU General Public License as published by
177 the Free Software Foundation; either version 2 of the License, or
178 (at your option) any later version.
180 This program is distributed in the hope that it will be useful,
181 but WITHOUT ANY WARRANTY; without even the implied warranty of
182 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
183 GNU General Public License for more details.
185 You should have received a copy of the GNU General Public License
186 along with this program; if not, write to the Free Software
187 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.