]>
Commit | Line | Data |
---|---|---|
f79d43bb | 1 | <!-- |
d823d5b9 | 2 | |
3 | lxc: linux Container library | |
4 | ||
5 | (C) Copyright IBM Corp. 2007, 2008 | |
6 | ||
7 | Authors: | |
9afe19d6 | 8 | Daniel Lezcano <daniel.lezcano at free.fr> |
d823d5b9 | 9 | |
10 | This library is free software; you can redistribute it and/or | |
11 | modify it under the terms of the GNU Lesser General Public | |
12 | License as published by the Free Software Foundation; either | |
13 | version 2.1 of the License, or (at your option) any later version. | |
14 | ||
15 | This library is distributed in the hope that it will be useful, | |
16 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public | |
21 | License along with this library; if not, write to the Free Software | |
250b1eec | 22 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
d823d5b9 | 23 | |
24 | --> | |
25 | ||
7f951458 | 26 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
99e4008c | 27 | |
10fba81b | 28 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
99e4008c MN |
29 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
30 | ]> | |
d823d5b9 | 31 | |
32 | <refentry> | |
33 | ||
34 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
35 | ||
36 | <refmeta> | |
37 | <refentrytitle>lxc-monitor</refentrytitle> | |
38 | <manvolnum>1</manvolnum> | |
39 | </refmeta> | |
40 | ||
41 | <refnamediv> | |
42 | <refname>lxc-monitor</refname> | |
43 | ||
44 | <refpurpose> | |
45 | monitor the container state | |
46 | </refpurpose> | |
47 | </refnamediv> | |
48 | ||
49 | <refsynopsisdiv> | |
50 | <cmdsynopsis> | |
b4578c5b | 51 | <command>lxc-monitor</command> |
fbf050e4 | 52 | <arg choice="opt">-n <replaceable>name</replaceable></arg> |
2afd1dc0 | 53 | <arg choice="opt">-Q <replaceable>name</replaceable></arg> |
d823d5b9 | 54 | </cmdsynopsis> |
55 | </refsynopsisdiv> | |
56 | ||
57 | <refsect1> | |
58 | <title>Description</title> | |
59 | ||
60 | <para> | |
fbf050e4 DE |
61 | <command>lxc-monitor</command> monitors the state of containers. The |
62 | <replaceable>name</replaceable> argument may be used to specify | |
63 | which containers to monitor. It is a regular expression, conforming | |
64 | with posix2, so it is possible to monitor all the containers, | |
65 | several of them or just one. If not specified, | |
66 | <replaceable>name</replaceable> will default to '.*' which will | |
67 | monitor all containers in <command>lxcpath</command>. | |
d823d5b9 | 68 | </para> |
69 | ||
8d06bd13 DE |
70 | <para> |
71 | The <option>-P, --lxcpath</option>=PATH option may be specified multiple | |
72 | times to monitor more than one container path. Note however that | |
73 | containers with the same name in multiple paths will be | |
74 | indistinguishable in the output. | |
75 | </para> | |
76 | ||
d823d5b9 | 77 | </refsect1> |
78 | ||
2afd1dc0 DE |
79 | <refsect1> |
80 | <title>Options</title> | |
81 | ||
82 | <variablelist> | |
83 | <varlistentry> | |
84 | <term> | |
85 | <option>-Q, --quit</option> | |
86 | </term> | |
87 | <listitem> | |
88 | <para> | |
89 | Ask the lxc-monitord daemon on each given <command>lxcpath</command> | |
90 | to quit. After receiving this command, lxc-monitord will exit | |
91 | immediately as soon as it has no clients instead of waiting the | |
92 | normal 30 seconds for new clients. This is useful if you need to | |
93 | unmount the filesystem <command>lxcpath</command> is on. | |
94 | </para> | |
95 | </listitem> | |
96 | </varlistentry> | |
97 | </variablelist> | |
98 | </refsect1> | |
99 | ||
10fba81b | 100 | &commonoptions; |
d823d5b9 | 101 | |
102 | <refsect1> | |
103 | <title>Examples</title> | |
104 | <variablelist> | |
105 | <varlistentry> | |
106 | <term>lxc-monitor -n foo</term> | |
107 | <listitem> | |
108 | <para> | |
109 | will monitor the different states for container foo. | |
110 | </para> | |
111 | </listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term>lxc-monitor -n 'foo|bar'</term> | |
116 | <listitem> | |
117 | <para> | |
118 | will monitor the different states for container foo and bar. | |
119 | </para> | |
120 | </listitem> | |
121 | </varlistentry> | |
122 | ||
123 | <varlistentry> | |
e3dd06ef | 124 | <term>lxc-monitor -n '[fb].*'</term> |
d823d5b9 | 125 | <listitem> |
126 | <para> | |
127 | will monitor the different states for container with the | |
128 | name beginning with letter 'f' or 'b'. | |
129 | </para> | |
130 | </listitem> | |
131 | </varlistentry> | |
132 | ||
133 | <varlistentry> | |
134 | <term>lxc-monitor -n '.*'</term> | |
135 | <listitem> | |
136 | <para> | |
137 | will monitor the different states for all containers. | |
138 | </para> | |
139 | </listitem> | |
140 | </varlistentry> | |
141 | ||
142 | </variablelist> | |
143 | </refsect1> | |
144 | ||
145 | <refsect1> | |
146 | <title>Diagnostic</title> | |
147 | ||
148 | <variablelist> | |
149 | ||
150 | <varlistentry> | |
151 | <term>The container was not found</term> | |
152 | <listitem> | |
153 | <para> | |
154 | The specified container was not created before with | |
155 | the <command>lxc-create</command> command. | |
156 | </para> | |
157 | </listitem> | |
f79d43bb | 158 | </varlistentry> |
d823d5b9 | 159 | |
160 | ||
161 | </variablelist> | |
162 | ||
163 | </refsect1> | |
164 | ||
165 | <refsect1> | |
166 | <title>See Also</title> | |
167 | ||
f79d43bb | 168 | <simpara> |
d823d5b9 | 169 | <citerefentry> |
170 | <refentrytitle>regex</refentrytitle> | |
171 | <manvolnum>7</manvolnum> | |
172 | </citerefentry>, | |
173 | </simpara> | |
174 | ||
d823d5b9 | 175 | </refsect1> |
176 | ||
99e4008c MN |
177 | &seealso; |
178 | ||
d823d5b9 | 179 | <refsect1> |
180 | <title>Author</title> | |
181 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
182 | </refsect1> | |
183 | ||
184 | </refentry> | |
185 | ||
186 | <!-- Keep this comment at the end of the file | |
187 | Local variables: | |
188 | mode: sgml | |
189 | sgml-omittag:t | |
190 | sgml-shorttag:t | |
191 | sgml-minimize-attributes:nil | |
192 | sgml-always-quote-attributes:t | |
193 | sgml-indent-step:2 | |
194 | sgml-indent-data:t | |
195 | sgml-parent-document:nil | |
196 | sgml-default-dtd-file:nil | |
197 | sgml-exposed-tags:nil | |
198 | sgml-local-catalogs:nil | |
199 | sgml-local-ecat-files:nil | |
200 | End: | |
201 | --> |