jls8
List jails
Usage
jls [--libxo]
[-dhNnqsv]
[-j
jail]
[parameter ...]
jls -c
[-d]
-j
jail
Overview
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). The pseudo-parameter all will show all available jail parameters. A list of available parameters can be retrieved via “sysctl -d security.jail.param”. See jail(8) for a description of some core parameters.
If no parameters or any of the options -chns are given, the following four columns will be printed: jail identifier (jid), IP address (ip4.addr), hostname (host.hostname), and path (path).
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.
The following options are available:
-
--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.
-
-d -
List dying as well as active jails.
-
-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.
-
-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.
-
-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).
-
-j jail -
The jid or name of the jail to list. Without this option, all active jails will be listed.
Releases
55 releases since FreeBSD 5.1-RELEASE; the text changed 34 times.
- 5.1–6.3
- 6.4
- 7.0
- 7.1
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4
- 9.0
- 9.1
- 9.2
- 9.3
- 10.0
- 10.1
- 10.2
- 10.3
- 10.4
- 11.0
- 11.1
- 11.2
- 11.3
- 11.4
- 12.0
- 12.1
- 12.2
- 12.3
- 12.4
- 13.0–13.2
- 13.3–14.2
- 14.3–14.4
- 14.5–16.0
--libxo since FreeBSD 11.0-RELEASE;
-N since FreeBSD 9.2-RELEASE;
-c since FreeBSD 14.5-RELEASE;
-d since FreeBSD 8.0-RELEASE;
-h since FreeBSD 8.0-RELEASE;
-j since FreeBSD 8.0-RELEASE;
-n since FreeBSD 8.0-RELEASE;
-q since FreeBSD 8.0-RELEASE;
-s since FreeBSD 8.0-RELEASE;
-v since FreeBSD 7.2-RELEASE.
-a until FreeBSD 7.4-RELEASE.