vzlist(8)

💖 vzlist(8) — Containers 💖

okay bestie, welcome to vzlist, from the Containers section of the manual (section 8, iykyk) 🫶

---

✨ NAME ✨

vzlist — show various information about containers 👑

---

🌸 SYNOPSIS 🌸

vzlist [-a | -S] [-n] [-H] [-t] [-j] [-o name[,name...]|-1] [-s [-]name]
       [-h pattern] [-N pattern] [-d pattern] [CTID [CTID ...]]
vzlist -L | --list
vzlist --help

---

🦋 DESCRIPTION 🦋

So this lil utility is literally the one you use for listing containers and all their parameters. By default only running containers are listed. And if you pass one or more CTIDs? Then only the containers you asked for show up. No extras. Periodt. 💅

Now listen, some fields can have long values — think ip, hostname, description or features — and those value strings get trimmed to some predefined width, because otherwise the whole columned layout would break and we can't have that 😭. UNLESS that field is the last one. So if you want the full, non-trimmed value for one of those fields, put the field name last in the list of fields for the -o option. And if you're running vzlist from a script, add -t to disable trimming entirely. 🎀

---

💅 OPTIONS 💅

• -a, --all — list all containers. every single one. 💖
• -S, --stopped — list only the containers that are not running (and yes, that includes the ones whose status shows as mounted or suspended). 🛑
• -n, --name — display container names instead of hostnames. a whole different vibe. ✨
• -H, --no-header — suppress the header row. super usable for scripts. 🤖
• -t, --no-trim — suppress trimming of long fields. also super usable for scripts. 📜
• -j, --json — output in JSON format. by default, all possible fields are printed. 🧚
• -o, --output field[,field...] — display only the fields you specify (peep the Possible fields subsection below, bestie). 🎯
• -1 — synonym for -H -octid, meaning you only show container IDs, one per line. so clean. so minimal. 🌈
• -s, --sort [-]field — sort by the value of field (the possible arguments are the same as for -o). the - before the field name means sort in reverse order. 🔄

🔍 Output filters 🔍

Your list of CTs can be filtered even further with the following options. For patterns, you can use the same wildcards as in shell (that's *, ?, and []). 📝

Note: to avoid expansion of wildcards by the shell, you have to escape the pattern by either putting it into single quotes (like 'a*a') or by adding a backslash before the wildcard character (like a\*a). do NOT skip this step, the shell will absolutely snatch your pattern otherwise 💀

• -h, --hostname pattern — list only containers whose hostnames match the pattern. 🏠
• -N, --name_filter pattern — list only containers whose names match the pattern. 📛
• -d, --description pattern — list only containers with descriptions matching the pattern. 📖

🌟 Possible fields 🌟

• -L, --list — list all available format specifiers that can be used for both output (-o, --output) and the sorting order (-s, --sort). the whole menu, served fresh. 🍓

For the user beancounter fields, if the suffix is not specified, the current usage (a.k.a. "held") value is shown. You can also use the following suffixes:

• .m — maxheld
• .b — barrier
• .l — limit
• .f — fail counter

For the disk quota fields, if the suffix is not specified, the current usage is shown. You can also use the following suffixes:

• .s — soft limit
• .h — hard limit

Note that for JSON output, suffixes are not allowed. just so you know. 🙈

---

🎀 EXAMPLES 🎀

vzlist -o ctid,kmemsize,kmemsize.l -s kmemsize

Show CTIDs, kmemsize usage, and kmemsize limit for all running containers, sorted by the kmemsize usage. literally the go-to move. 🔥

---

⭐ EXIT STATUS ⭐

Returns 0 upon success. that's it, that's the whole status. ate and left no crumbs. 👑

---

💜 COPYRIGHT 💜

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

---

okay that's the whole page bestie, you're officially a vzlist girlie now 🧚💖 this was the OpenVZ vzlist(8) page, dated 13 Jun 2012, and yes we're still obsessed with it. mwah 💅✨