JLS(8)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

πŸ’… JLS(8) β€” the jls girlies' guide to listing jails πŸ‘‘

okay so bestie, welcome to jls β€” it's the jls(8) utility, it lives in the System Manager's Manual, and it is literally the main character of jail-wrangling. let's get into it 🫢


✨ SYNOPSIS ✨

jls [--libxo] [-dhNnqsv] [-j jail] [parameter ...]
jls -c [-d] -j jail

🌸 DESCRIPTION 🌸

The jls utility lists all active jails, or the specified jail. each jail is represented by space-separated values of the listed parameters, one jail per line (unless the parameters themselves contain newlines β€” yes, that's a real caveat, keep it in mind πŸ™ˆ).

the pseudo-parameter all will show all available jail parameters. and if you wanna know what parameters even exist in the first place? you grab that list via sysctl -d security.jail.param. and for a description of some core parameters, go see jail(8) β€” iykyk.

if no parameters or any of the options -chns are given, the following four columns will be printed:

  1. jail identifier (jid)
  2. IP address (ip4.addr)
  3. hostname (host.hostname)
  4. path (path)
🚨 okay -c mode is different: when the -c option is used, jls will not emit any output except for usage errors. this mode is intended solely to check for a single jail's existence, and it does not accept any parameter or print-option flags. no flags, no parameters, none. we respect the boundaries πŸ’…

the following options are available:


πŸŽ€ OPTIONS πŸŽ€

  • --libxo β€” generate output via libxo(3) in a selection of different human and machine readable formats ✨ see xo_options(7) for details on command line arguments.
  • -c β€” only check for the jail's existence. that's it, that's the whole job πŸ‘‘
  • -d β€” list dying as well as active jails πŸ’€ (yes, jails can be dying, don't make it weird)
  • -h β€” print a header line containing the parameters listed. if no parameters are given on the command line, all is assumed πŸŽ€
  • -N β€” in the standard display mode, print each jail's name instead of its numeric ID. if the jail does not have a name, the numeric ID is printed instead. no name? no problem 🫢
  • -n β€” print parameters in name=value format, where each parameter is preceded by its name. if no parameters are given on the command line, all is assumed 🌈
  • -q β€” put quotes around parameters if they contain spaces or quotes, or are the empty string. safety first, bestie πŸŽ€
  • -s β€” print parameters suitable for passing to jail(8), skipping read-only and unused parameters. implies -nq ⭐
  • -v β€” extend the standard display with a multiple-line summary per jail, containing the following parameters: jail identifier (jid), hostname (host.hostname), path (path), jail name (name), jail state (dying), cpuset ID (cpuset), IP address(es) (ip4.addr and ip6.addr) πŸ”₯ so much info, we love a detailed queen
  • -j jail β€” the jid or name of the jail to list. without this option, all active jails will be listed 🌸

πŸ¦‹ SEE ALSO πŸ¦‹

jail_get(2), libxo(3), xo_options(7), jail(8), jexec(8)


πŸ’œ HISTORY πŸ’œ

The jls utility was added in FreeBSD 5.1. Extensible jail parameters were introduced in FreeBSD 8.0. libxo support was added in FreeBSD 11.0. a whole glow-up timeline fr fr ✨


and that's the page bestie πŸ’– this iconic little number is from the Debian flavour of things, dated July 25, 2025, and it's filed under JLS(8) β€” go list some jails, you're gonna slay πŸŽ€πŸ‘‘

πŸ“¦ where this page comes from