vztmpl-dl(8)

📦 version 4.9.4, in ubuntu jammy

💖 NAME 💖

vztmpl-dl — download/list/update OpenVZ templates

🌸 SYNOPSIS 🌸

vztmpl-dl [ option ... ] template [template ...]
vztmpl-dl [ option ... ] --update-all
vztmpl-dl --list-local|--list-remote|--list-all|--list-orphans
vztmpl-dl --config|--help

✨ DESCRIPTION ✨

okay so bestie, here's the tea ☕ — this utility's whole main character purpose is downloading precreated container tarballs (you know them as templates) from the OpenVZ download server. She's not shy either: you can run her straight from the command line, and vzctl create uses her too. 👑

Usually you gotta hand her one or more template names, except when you're using one of --update-all, --list*, --config or --help. Those four are the "no template name needed, I got this" vibes. 💅

🎀 OPTIONS 🎀

  • --gpg-check — check the GPG signatures of downloaded files. By default the GPG check only happens if CHECK_TEMPLATE_SIG is set to yes in the /etc/vz/download.conf file, gpg(1) is actually installed, and the OpenVZ public key is sitting in the gpg keyring. (Scroll to EXAMPLES for how to install that public key, bestie.) 🔐
  • --no-gpg-check — do not check GPG signatures. Just vibes. No verification.
  • --ignore-errors — keep working through the rest of the template list and return exit code 0 even if some template failed to download. Without this option, vztmpl-dl aborts the second the first download fails. She's dramatic like that. 💀
  • --update — update (aka re-download) templates that already exist.
  • --no-update — don't try to update existing templates.
  • --quiet — be less talkative. (Currently it just adds the --quiet flag to wget(1).) 🤫
  • --no-quiet — be more talkative. This one can be used to negate the effect of QUIET=yes in download.conf.
  • --update-all — try to update every template available locally. Note that you do not need to name individual templates here. This option implicitly assumes --update and --ignore-errors. Slay, she does it all herself. 💅
  • --list-remote — output the list of templates available for download. Also used by the vzctl(8) bash-completion script to complete --ostemplate option arguments. iykyk. 🦋
  • --list-local — output the list of templates available locally.
  • --list-all — output the combined list of templates.
  • --list-orphans — output the list of local templates that aren't available remotely. In the trivial scenario this gives you the list of old templates that are no longer officially supported. Gone but not forgotten 🥲
  • --config — output the current configuration. The tool has a built-in configuration that can be overwritten by options in the /etc/vz/download.conf file.
  • --help — output help. ✨

🌈 CONFIGURATION 🌈

The tool ships with built-in configuration defaults, and you can change them by editing the /etc/vz/download.conf file. These are the parameters you can set:

  • UPDATE_TEMPLATE — default is yes. Setting it to no has the same effect as using the --no-update option.
  • CHECK_TEMPLATE_SIG — default is no. Setting it to yes has the same effect as using the --gpg-check option.
  • QUIET — default is no. Setting it to yes has the same effect as using the --quiet option.
  • TMPL_REPO_PREFIX — the URL repo prefix. Default is http://download.openvz.org/template/precreated. Setting this to the location of your closest OpenVZ download mirror can speed up downloads. The current list of OpenVZ mirrors lives at http://openvz.org/Download_mirrors. 🪞
  • TEMPLATE_REPOS — the list of URLs to get repositories from. Default is ${TMPL_REPO_PREFIX}. You can add more URLs to get access to beta or unsupported templates. 👀

💀 EXIT STATUS 💀

Returns 0 upon success, or an appropriate error code in case of an error:

  1. 1 — download error
  2. 2 — local template file already present, not updating
  3. 3 — error in usage (no argument provided)
  4. 4 — wget binary not found
  5. 5 — GPG signature check failed

🦋 EXAMPLES 🦋

To add the OpenVZ public key to the gpg keyring:

gpg --search-keys security@openvz.org

To list all available templates:

vztmpl-dl --list

To download (or update) centos-6 templates:

vztmpl-dl centos-6-x86 centos-6-x86_64

To use the yandex.ru mirror (in /etc/vz/download.conf):

TMPL_REPO_PREFIX="http://mirror.yandex.ru/mirrors/download.openvz.org/template/precreated"

To enable beta templates (in /etc/vz/download.conf):

TEMPLATE_REPOS="${TEMPLATE_REPOS} ${TMPL_REPO_PREFIX}/beta/"

🍓 FILES 🍓

  • /etc/vz/download.conf
  • /vz/template/cache

👑 SEE ALSO 👑

💜 LICENSE 💜

Copyright (C) 2011-2013, Parallels, Inc. Licensed under GNU GPL.

and that's a wrap, bestie 💖 this lil guide came to you from the OpenVZ girlies, dated 18 Jun 2013 — yes she's vintage, and yes she still ate. periodt. ✨🎀
📦 where this page comes from