2 .\" Copyright (c) 2003 Mike Barcroft <mike@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 utility lists all active jails, or the specified jail.
44 Each jail is represented by one row which contains space-separated values of
47 including the pseudo-parameter
49 which will show all available jail parameters.
50 A list of available parameters can be retrieved via
51 .Dq Nm sysctl Fl d Va security.jail.param .
54 for a description of some core parameters.
60 are given, the following four columns will be printed:
61 jail identifier (jid), IP address (ip4.addr), hostname (host.hostname),
64 The following options are available:
65 .Bl -tag -width indent
69 in a selection of different human and machine readable formats.
72 for details on command line arguments.
76 as well as active jails.
78 Print a header line containing the parameters listed.
79 If no parameters are given on the command line,
83 In the standard display mode, print each jail's name instead of its
85 If the jail does not have a name, the numeric ID is printed instead.
89 format, where each parameter is preceded by its name.
90 If no parameters are given on the command line,
94 Put quotes around parameters if they contain spaces or quotes, or are
97 Print parameters suitable for passing to
99 skipping read-only and unused parameters.
103 Extend the standard display with a multiple-line summary per jail,
104 containing the following parameters:
105 jail identifier (jid), hostname (host.hostname), path (path),
106 jail name (name), jail state (dying), cpuset ID (cpuset),
107 IP address(es) (ip4.addr and ip6.addr).
109 The jid or name of the
112 Without this option, all active jails will be listed.
117 .Xr xo_parse_args 3 ,
125 Extensible jail parameters were introduced in
127 libxo support was added in