Editing Man/vztmpl-dl.8

== NAME ==

<p style="margin-left:11%; margin-top: 1em">vztmpl-dl
&minus; download/list/update OpenVZ templates</p>

== SYNOPSIS ==

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p style="margin-top: 1em"><b>vztmpl-dl</b></p></td>
<td width="1%"></td>
<td width="59%">

<p style="margin-top: 1em">[ <i>option</i> ... ]
<i>template</i> [<i>template</i> ...]</p></td>
<td width="15%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p><b>vztmpl-dl</b></p></td>
<td width="1%"></td>
<td width="59%">

<p>[ <i>option</i> ... ] <b>--update-all</b></p></td>
<td width="15%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p><b>vztmpl-dl</b></p></td>
<td width="1%"></td>
<td width="59%">

<p><b>--list-local</b>|<b>--list-remote</b>|<b>--list-all</b></p> </td>
<td width="15%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p><b>vztmpl-dl</b></p></td>
<td width="1%"></td>
<td width="59%">

<p><b>--config</b>|<b>--help</b></p></td>
<td width="15%">
</td></tr>
</table>

== DESCRIPTION ==

<p style="margin-left:11%; margin-top: 1em">The main
purpose of this utility is to download a precreated
container tarballs (also known as templates) from the OpenVZ
download server. It can be used directly from the command
line, and is also used by <b>vzctl create</b>.</p>

<p style="margin-left:11%; margin-top: 1em">Usually one or
more template names are required, except if one of
<b>--update-all</b>, <b>--list</b>*, <b>--config</b> or
<b>--help</b> is used.</p>

== OPTIONS ==

<p style="margin-left:11%; margin-top: 1em"><b>--gpg-check</b></p>

<p style="margin-left:22%;">Check GPG signatures of
downloaded files. By default, GPG check is performed if
<b>CHECK_TEMPLATE_SIG</b> is set to <b>yes</b> in
<b>/etc/vz/download.conf</b> file, <b>gpg</b>(1) tool is
installed, and the OpenVZ public key is available in the gpg
keyring. See <b>EXAMPLES</b> section below on how to install
OpenVZ public key.</p>

<p style="margin-left:11%;"><b>--no-gpg-check</b></p>

<p style="margin-left:22%;">Do not check GPG
signatures.</p>

<p style="margin-left:11%;"><b>--ignore-errors</b></p>

<p style="margin-left:22%;">Keep processing templates from
the list and return 0 exit code, even if some template
failed to download. Without this option, <b>vztmpl-dl</b>
aborts upon first download failure.</p>

<p style="margin-left:11%;"><b>--update</b></p>

<p style="margin-left:22%;">Update (re-download) existing
templates.</p>

<p style="margin-left:11%;"><b>--no-update</b></p>

<p style="margin-left:22%;">Do not try to update existing
templates.</p>

<p style="margin-left:11%;"><b>--update-all</b></p>

<p style="margin-left:22%;">Try to update all templates
that are available locally. Note that there is no need to
specify individual templates. This options implicitly
assumes <b>--update</b> and <b>--ignore-errors</b>
options.</p>

<p style="margin-left:11%;"><b>--list-remote</b></p>

<p style="margin-left:22%;">Output list of templates
available for download. This option is also used by
[[Man/vzctl.8|<b>vzctl</b>(8)]] bash-completion script to complete
<b>--ostemplate</b> option arguments.</p>

<p style="margin-left:11%;"><b>--list-local</b></p>

<p style="margin-left:22%;">Output list of templates
available locally.</p>

<p style="margin-left:11%;"><b>--list-all</b></p>

<p style="margin-left:22%;">Output combined list of
templates.</p>

<p style="margin-left:11%;"><b>--config</b></p>

<p style="margin-left:22%;">Output current configuration.
The tool has built-in configuration which can be overwritten
by options in <b>/etc/vz/download.conf</b> file.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">

<p><b>--help</b></p></td>
<td width="2%"></td>
<td width="18%">

<p>Output help.</p></td>
<td width="60%">
</td></tr>
</table>

== CONFIGURATION ==

<p style="margin-left:11%; margin-top: 1em">The tool has a
built-in configuration defaults, which can be changed by
editing <b>/etc/vz/download.conf</b> file. The following
parameters can be set: <b><br>
UPDATE_TEMPLATE</b></p>

<p style="margin-left:22%;">Default is <b>yes</b>. Setting
to <b>no</b> has the same effect as using <b>--no-update</b>
option.</p>

<p style="margin-left:11%;"><b>CHECK_TEMPLATE_SIG</b></p>

<p style="margin-left:22%;">Default is <b>no</b>. Setting
to <b>yes</b> has the same effect as using
<b>--gpg-check</b> option.</p>

<p style="margin-left:11%;"><b>TMPL_REPO_PREFIX</b></p>

<p style="margin-left:22%;">URL repo prefix. Default is
<b>http://download.openvz.org/template/precreated</b>.
Setting this to location of your closest OpenVZ download
mirror can speed up download. Current list of OpenVZ mirrors
is available at
<b>http://openvz.org/Download_mirrors</b>.</p>

<p style="margin-left:11%;"><b>TEMPLATE_REPOS</b></p>

<p style="margin-left:22%;">List of URLs to get
repositories from. Default is ${TMPL_REPO_PREFIX}. More URLs
can be added to get access to beta or unsupported
templates.</p>

== EXIT STATUS ==

<p style="margin-left:11%; margin-top: 1em">Returns 0 upon
success, or an appropriate error code in case of an
error:</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

<p>1</p></td>
<td width="10%"></td>
<td width="75%">

<p>Download error</p></td>
<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

<p>2</p></td>
<td width="10%"></td>
<td width="75%">

<p>Local template file already present, not updating</p></td>
<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

<p>3</p></td>
<td width="10%"></td>
<td width="75%">

<p>Error in usage (no argument provided)</p></td>
<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

<p>4</p></td>
<td width="10%"></td>
<td width="75%">

<p>wget binary not found</p></td>
<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

<p>5</p></td>
<td width="10%"></td>
<td width="75%">

<p>GPG signature check failed</p></td>
<td width="3%">
</td></tr>
</table>

== EXAMPLES ==

<p style="margin-left:11%; margin-top: 1em">To add OpenVZ
public key to gpg keyring:</p>

<pre style="margin-left:11%;">  gpg --search-keys security@openvz.org</pre>

<p style="margin-left:11%; margin-top: 1em">To list all
available templates:</p>
<pre style="margin-left:11%;">  vztmpl-dl --list</pre>

<p style="margin-left:11%; margin-top: 1em">To download (or
update) centos-6 templates:</p>

<pre style="margin-left:11%;">  vztmpl-dl centos-6-x86 centos-6-x86_64</pre>

<p style="margin-left:11%; margin-top: 1em">To use
<b>yandex.ru</b> mirror (in
<b>/etc/vz/download.conf</b>):</p>

<pre style="margin-left:11%;">  TMPL_REPO_PREFIX=&quot;http://mirror.yandex.ru/mirrors/download.openvz.org/template/precreated&quot;</pre>

<p style="margin-left:11%; margin-top: 1em">To enable beta
templates (in <b>/etc/vz/download.conf</b>):</p>

<pre style="margin-left:11%;">  TEMPLATE_REPOS=&quot;${TEMPLATE_REPOS} ${TMPL_REPO_PREFIX}/beta/&quot;</pre>

== FILES ==

<pre style="margin-left:11%; margin-top: 1em">/etc/vz/download.conf
/vz/template/cache</pre>

== SEE ALSO ==

<p style="margin-left:11%; margin-top: 1em">[[Man/arpsend.8|<b>arpsend</b>(8)]],
<b>download.conf</b>(5),
<b>[[Package_signatures]]#Importing_the_public_key</b>.</p>

== LICENSE ==

<p style="margin-left:11%; margin-top: 1em">Copyright (C)
2011-2013, Parallels, Inc. Licensed under GNU GPL.</p>