| 1 |
<!-- SPDX-License-Identifier: LGPL-2.1+ --> |
| 2 |
|
| 3 |
<!DOCTYPE refentry PUBLIC @docdtd@ [ |
| 4 |
|
| 5 |
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
| 6 |
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
| 7 |
]> |
| 8 |
|
| 9 |
<refentry> |
| 10 |
|
| 11 |
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> |
| 12 |
|
| 13 |
<refmeta> |
| 14 |
<refentrytitle>lxc-info</refentrytitle> |
| 15 |
<manvolnum>1</manvolnum> |
| 16 |
</refmeta> |
| 17 |
|
| 18 |
<refnamediv> |
| 19 |
<refname>lxc-info</refname> |
| 20 |
|
| 21 |
<refpurpose> |
| 22 |
query information about a container |
| 23 |
</refpurpose> |
| 24 |
</refnamediv> |
| 25 |
|
| 26 |
<refsynopsisdiv> |
| 27 |
<cmdsynopsis> |
| 28 |
<command>lxc-info</command> |
| 29 |
<arg choice="req">-n <replaceable>name</replaceable></arg> |
| 30 |
<arg choice="opt">-c <replaceable>KEY</replaceable></arg> |
| 31 |
<arg choice="opt">-s</arg> |
| 32 |
<arg choice="opt">-p</arg> |
| 33 |
<arg choice="opt">-i</arg> |
| 34 |
<arg choice="opt">-S</arg> |
| 35 |
<arg choice="opt">-H</arg> |
| 36 |
</cmdsynopsis> |
| 37 |
</refsynopsisdiv> |
| 38 |
|
| 39 |
<refsect1> |
| 40 |
<title>Description</title> |
| 41 |
<para> |
| 42 |
<command>lxc-info</command> queries and shows information about a |
| 43 |
container. |
| 44 |
</para> |
| 45 |
</refsect1> |
| 46 |
|
| 47 |
<refsect1> |
| 48 |
<title>Options</title> |
| 49 |
<variablelist> |
| 50 |
|
| 51 |
<varlistentry> |
| 52 |
<term> |
| 53 |
<option>-c, --config <replaceable>KEY</replaceable></option> |
| 54 |
</term> |
| 55 |
<listitem> |
| 56 |
<para> |
| 57 |
Print a configuration key from the container. This option |
| 58 |
may be given multiple times to print out multiple key = value pairs. |
| 59 |
</para> |
| 60 |
</listitem> |
| 61 |
</varlistentry> |
| 62 |
|
| 63 |
<varlistentry> |
| 64 |
<term> |
| 65 |
<option>-s, --state</option> |
| 66 |
</term> |
| 67 |
<listitem> |
| 68 |
<para> |
| 69 |
Just print the container's state. |
| 70 |
</para> |
| 71 |
</listitem> |
| 72 |
</varlistentry> |
| 73 |
|
| 74 |
<varlistentry> |
| 75 |
<term> |
| 76 |
<option>-p, --pid</option> |
| 77 |
</term> |
| 78 |
<listitem> |
| 79 |
<para> |
| 80 |
Just print the container's pid. |
| 81 |
</para> |
| 82 |
</listitem> |
| 83 |
</varlistentry> |
| 84 |
|
| 85 |
<varlistentry> |
| 86 |
<term> |
| 87 |
<option>-i, --ips</option> |
| 88 |
</term> |
| 89 |
<listitem> |
| 90 |
<para> |
| 91 |
Just print the container's IP addresses. |
| 92 |
</para> |
| 93 |
</listitem> |
| 94 |
</varlistentry> |
| 95 |
|
| 96 |
<varlistentry> |
| 97 |
<term> |
| 98 |
<option>-S, --stats</option> |
| 99 |
</term> |
| 100 |
<listitem> |
| 101 |
<para> |
| 102 |
Just print the container's statistics. |
| 103 |
Note that for performance reasons the kernel does not account |
| 104 |
kernel memory use unless a kernel memory limit is set. If a limit |
| 105 |
is not set, <command>lxc-info</command> will display kernel memory |
| 106 |
use as 0. A limit can be set by specifying |
| 107 |
<programlisting> |
| 108 |
lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable> |
| 109 |
</programlisting> |
| 110 |
in your container configuration file, see |
| 111 |
<citerefentry> |
| 112 |
<refentrytitle>lxc.conf</refentrytitle> |
| 113 |
<manvolnum>5</manvolnum> |
| 114 |
</citerefentry>. |
| 115 |
</para> |
| 116 |
</listitem> |
| 117 |
</varlistentry> |
| 118 |
|
| 119 |
<varlistentry> |
| 120 |
<term> |
| 121 |
<option>-H, --no-humanize</option> |
| 122 |
</term> |
| 123 |
<listitem> |
| 124 |
<para> |
| 125 |
Print the container's statistics in raw, non-humanized form. The |
| 126 |
default is to print statistics in humanized form. |
| 127 |
</para> |
| 128 |
</listitem> |
| 129 |
</varlistentry> |
| 130 |
</variablelist> |
| 131 |
</refsect1> |
| 132 |
|
| 133 |
&commonoptions; |
| 134 |
|
| 135 |
<refsect1> |
| 136 |
<title>Examples</title> |
| 137 |
<variablelist> |
| 138 |
<varlistentry> |
| 139 |
<term>lxc-info -n foo</term> |
| 140 |
<listitem> |
| 141 |
<para> |
| 142 |
Show information for foo. |
| 143 |
</para> |
| 144 |
</listitem> |
| 145 |
</varlistentry> |
| 146 |
|
| 147 |
<varlistentry> |
| 148 |
<term>lxc-info -n 'ubuntu.*'</term> |
| 149 |
<listitem> |
| 150 |
<para> |
| 151 |
Show information for all containers whose name starts with ubuntu. |
| 152 |
</para> |
| 153 |
</listitem> |
| 154 |
</varlistentry> |
| 155 |
|
| 156 |
<varlistentry> |
| 157 |
<term>lxc-info -n foo -c lxc.net.0.veth.pair</term> |
| 158 |
<listitem> |
| 159 |
<para> |
| 160 |
prints the veth pair name of foo. |
| 161 |
</para> |
| 162 |
</listitem> |
| 163 |
</varlistentry> |
| 164 |
|
| 165 |
</variablelist> |
| 166 |
</refsect1> |
| 167 |
|
| 168 |
&seealso; |
| 169 |
</refentry> |
| 170 |
|
| 171 |
<!-- Keep this comment at the end of the file |
| 172 |
Local variables: |
| 173 |
mode: sgml |
| 174 |
sgml-omittag:t |
| 175 |
sgml-shorttag:t |
| 176 |
sgml-minimize-attributes:nil |
| 177 |
sgml-always-quote-attributes:t |
| 178 |
sgml-indent-step:2 |
| 179 |
sgml-indent-data:t |
| 180 |
sgml-parent-document:nil |
| 181 |
sgml-default-dtd-file:nil |
| 182 |
sgml-exposed-tags:nil |
| 183 |
sgml-local-catalogs:nil |
| 184 |
sgml-local-ecat-files:nil |
| 185 |
End: |
| 186 |
--> |