iocage.8

.\" Text automatically generated by txt2man
.TH iocage 8 "02 November 2016" "" "FreeBSD System Manager's Manual"
.SH NAME
\fBiocage \fP- jail manager amalgamating ZFS, VNET and resource limits
\fB
.SH SYNOPSIS
.nf
.fam C
\fBiocage\fP [\fB-v\fP] \fIactivate\fP \fIZPOOL\fP
\fBiocage\fP [\fB-v\fP] \fIcap\fP UUID|TAG
\fBiocage\fP [\fB-v\fP] \fIclean\fP [\fB-f\fP] [\fB-a\fP|\fB-r\fP|\fB-j\fP|\fB-t\fP]
\fBiocage\fP [\fB-v\fP] \fIclone\fP UUID|TAG [UUID|TAG@snapshot] [\fIproperty=value\fP]
\fBiocage\fP [\fB-v\fP] \fIconsole\fP [\fB-f\fP] UUID|TAG
\fBiocage\fP [\fB-v\fP] \fIcreate\fP [\fB-e\fP] [release=[RELEASE|NAME]] [\fIpkglist=file\fP] [\fIproperty=value\fP] [\fIcount=value\fP]
\fBiocage\fP [\fB-v\fP] \fIdeactivate\fP \fIZPOOL\fP
\fBiocage\fP [\fB-v\fP] \fIdefaults\fP
\fBiocage\fP [\fB-v\fP] \fIdestroy\fP [\fB-f\fP] UUID|TAG
\fBiocage\fP [\fB-v\fP] \fIdf\fP
\fBiocage\fP [\fB-v\fP] \fIexec\fP [\fB-u\fP \fIusername\fP | \fB-U\fP \fIusername\fP] UUID|TAG|ALL \fIcommand\fP [\fIarg\fP \.\.\.]
\fBiocage\fP [\fB-v\fP] \fIexport\fP UUID|TAG
\fBiocage\fP [\fB-v\fP] \fIfetch\fP [\fB-p\fP|\fB-P\fP] [\fIrelease=RELEASE\fP | ftphost=ftp.hostname.org |
                  ftpdir=/dir/ | ftpfiles="base.txz doc.txz lib32.txz src.txz"]
                  [ ftplocaldir=/dir/ ] [ \fIcompression=ALGO\fP ]
\fBiocage\fP [\fB-v\fP] \fIget\fP [\fB-r\fP] property|all UUID|TAG
\fBiocage\fP [\fB-v\fP] \fIhelp\fP
\fBiocage\fP [\fB-v\fP] \fIimport\fP \fIUUID\fP [\fIproperty=value\fP]
\fBiocage\fP [\fB-v\fP] \fIinit-host\fP \fIIP\fP \fIZPOOL\fP
\fBiocage\fP [\fB-v\fP] \fIinuse\fP \fIUUID\fP|TAG
\fBiocage\fP [\fB-v\fP] \fIpkg\fP \fITAG\fP \fIpkg_cmd\fP
\fBiocage\fP [\fB-v\fP] \fIlimits\fP [\fIUUID\fP|\fITAG\fP]
\fBiocage\fP [\fB-v\fP] \fIlist\fP [\fB-t\fP|\fB-r\fP|\fB-s\fP jid|uuid|boot|state|tag|type|ip4]
\fBiocage\fP [\fB-v\fP] \fIpromote\fP \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIrcboot\fP
\fBiocage\fP [\fB-v\fP] reboot|restart [\fB-s\fP] \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIrcshutdown\fP
\fBiocage\fP [\fB-v\fP] \fIreset\fP \fIUUID\fP|\fITAG\fP|ALL
\fBiocage\fP [\fB-v\fP] \fIrollback\fP \fIUUID\fP|\fITAG\fP@snapshotname
\fBiocage\fP [\fB-v\fP] \fIruntime\fP \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIsend\fP [\fB-c\fP|\fB-i\fP|\fB-I\fP|\fB-h\fP|\fB-u\fP|\fB-m\fP] \fIPOOL\fP
\fBiocage\fP [\fB-v\fP] \fIset\fP \fIproperty=value\fP [\fIproperty=value\fP] \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIsnaplist\fP \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIsnapmount\fP \fIUUID\fP|\fITAG\fP@snapshotname \fIDESTINATION\fP
\fBiocage\fP [\fB-v\fP] \fIsnapremove\fP \fIUUID\fP|\fITAG\fP@snapshotname|ALL
\fBiocage\fP [\fB-v\fP] snapshot|snap [\fB-f\fP|\fB-r\fP] \fIUUID\fP|\fITAG\fP [\fIUUID\fP|\fITAG\fP@snapshotname]
\fBiocage\fP [\fB-v\fP] \fIsnapumount\fP \fIUUID\fP|\fITAG\fP@snapshotname
\fBiocage\fP [\fB-v\fP] \fIstart\fP [\fB-f\fP] \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIstop\fP \fIUUID\fP|\fITAG\fP|ALL
\fBiocage\fP [\fB-v\fP] \fIuncap\fP \fIUUID\fP|\fITAG\fP
\fBiocage\fP [\fB-v\fP] \fIupdate\fP [\fB-p\fP|\fB-P\fP] \fIUUID\fP|\fITAG\fP|RELEASE
\fBiocage\fP [\fB-v\fP] \fIupgrade\fP \fIUUID\fP|\fITAG\fP [\fIrelease=RELEASE\fP]
\fBiocage\fP [\fB-v\fP] \fIversion\fP | --\fIversion\fP

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBiocage\fP is a system administration tool for jails designed to simplify
jail management tasks. It abstracts away the management of ZFS backed jails
running VNET or shared \fIIP\fP networking with optional support for resource
\fIlimits\fP.
.PP
Both, shared \fIIP\fP based jails and VNET enabled jails are supported.
.PP
Each jail has a unique ID (\fIUUID\fP) automatically generated at creation time.
Using the \fIUUID\fP as a jail identifier means that a jail can be replicated in a
distributed environment with greater flexibility. This also eliminates
potential naming clashes on large scale deployments and helps reduce
operator error.
.PP
You can use either the full \fIUUID\fP or a jail's \fITAG\fP with every operation.
.PP
To ease jail identification a \fITAG\fP field is included in \fIlist\fP mode which can
be \fIset\fP to any string (hostname, label, note, etc.). By default if unset the
\fITAG\fP field contains the creation date and time stamp.
.PP
Properties are stored inside ZFS custom fields. This eliminates the need for
any configuration files and jails can be easily moved with ZFS \fIsend\fP and
receive preserving all of their properties automatically.
.PP
\fBiocage\fP relies on ZFS and at least one ZFS pool must be present on the host
system. To enable all the features \fBiocage\fP supports, consider the following
optional kernel options and system requirements:
.RS
.TP
.B
o
FreeBSD 9.3-RELEASE amd64 or higher
.TP
.B
o
Kernel compiled with:
.PP
.nf
.fam C
        options         VIMAGE
        options         RACCT
        options         RCTL

.fam T
.fi
.RE
Calling \fBiocage\fP with the \fB-v\fP switch before a \fIcommand\fP will allow you to see the
how the shell is running each of the commands. It's very verbose.
.SH SUBCOMMANDS

\fIactivate\fP \fIZPOOL\fP
.PP
.nf
.fam C
    Intended for automation tools. The pool can be activated for iocage jails
    without requiring user input.

.fam T
.fi
\fIcap\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Reapply resource limits on jail while it is running.

.fam T
.fi
\fIclean\fP [\fB-f\fP] [\fB-a\fP|\fB-r\fP|\fB-j\fP|\fB-t\fP]
.PP
.nf
.fam C
    This removes the ZFS datasets associated with the flag called. The -a flag
    will destroy everything associated with iocage. The -r flag will destroy
    all RELEASEs that have been fetched. Basejails rely on these to exist,
    so be sure you don't use this flag if you have any. The -j flag will
    destroy the jails dataset. The -t flag will destroy the templates dataset.
    Same warning applies here as with cleaning the RELEASE dataset.

.fam T
.fi
\fIclone\fP \fIUUID\fP|\fITAG\fP [\fIUUID\fP|\fITAG\fP@snapshot] [\fIproperty=value\fP]
.PP
.nf
.fam C
    Clone jail identified by UUID (ZFS clone). All properties will be reset on
    the clone, defaults can be overridden by specifying properties on the fly.
    Custom point-in-time snapshots can be used as a source for cloning in the
    form of UUID@snapshot or TAG@snapshot.

    Examples:

    Clone the current state of the jail:
    iocage clone UUID tag=www02

    Clone a jail from a custom snapshot (snapshot taken previously):
    iocage clone UUID@snapshotname tag=www02

.fam T
.fi
\fIconsole\fP [\fB-f\fP] \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Execute login to have a shell inside the jail. If the -f flag is specified,
    and the jail is not running it will be started for the console command.

.fam T
.fi
\fIcreate\fP [\fB-e\fP] [base=[RELEASE|NAME]] [\fIproperty=value\fP] [\fIproperty=value\fP] [\fIcount=value\fP]
.PP
.nf
.fam C
    By default create will deploy a new jail based on the host operating
    system's release. This can be changed by specifying the base option.
    By default a basejail is created that has a common shared base.
    The -e switch will create an empty jail which can be used for unsupported
    or custom jails.

    Example: iocage create tag=www01 pkglist=$HOME/my-pkgs.txt
             iocage create tag=mybasejail
             iocage create tag=mybasejail base=10.2-RELEASE
             iocage create tag=mycustombasejail base=nginx_postgres

    By default only one jail will be created, but if you specify count=NUMBER,
    then that many jails will be created.

    Example: iocage create tag="mybasejail" host_hostname="mybasejail" count=10

    This will create 10 jails with the tag mybasejail_{1-10}. The tag and
    hostname will be incremented up with the number of jails you wish to create.

.fam T
.fi
\fIdeactivate\fP \fIZPOOL\fP
.PP
.nf
.fam C
    Remove the comment that iocage uses to locate a usable pool.

.fam T
.fi
\fIdefaults\fP
.PP
.nf
.fam C
    Display all defaults set in the default dataset.

.fam T
.fi
\fIdestroy\fP [\fB-f\fP] \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Destroy given jail. This is irreversible, use with caution. If the jail is
    running destroy action will fail.

    With -f the jail will be destroyed without confirmation.

.fam T
.fi
\fIdf\fP
.PP
.nf
.fam C
    List disk space related information. Available fields:

    CRT - compression ratio
    RES - reserved space
    QTA - disk quota
    USE - used space
    AVA - available space
    TAG - jail name

.fam T
.fi
\fIexec\fP [\fB-u\fP \fIusername\fP | \fB-U\fP \fIusername\fP] \fIUUID\fP|\fITAG\fP|ALL \fIcommand\fP [\fIarg\fP \.\.\.]
.PP
.nf
.fam C
    Execute command inside the jail. This is simply an iocage UUID/tag wrapper
    for jexec(8).

.fam T
.fi
\fIexport\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Export a complete jail. An archive file is created in /iocage/images with
    SHA256 checksum. Jail must be in stopped state before exporting.

.fam T
.fi
\fIfetch\fP [\fB-p\fP|\fB-P\fP] [\fIrelease=RELEASE\fP | ftphost=ftp.hostname.org |
ftpdir=/dir/ | ftpfiles="base.txz doc.txz lib32.txz src.txz"]
[ ftplocaldir=/dir/ ] [ \fIcompression=ALGO\fP ]
.RS
.PP
Used for downloading and updating/patching releases.
.PP
\fIfetch\fP must be executed as the first \fIcommand\fP on a pristine system. By
default \fIfetch\fP will download the host node's RELEASE for deployment. If
other releases are required, this can be changed by supplying the
required release property or just selecting the appropriate RELEASE from
the menu \fIlist\fP.
.PP
Example: \fBiocage\fP \fIfetch\fP release=10.1-RELEASE
.PP
\fIfetch\fP can also used to \fIupdate\fP already downloaded releases. To \fIupdate\fP a local
release already present in \fBiocage\fP (\fBiocage\fP \fIlist\fP \fB-r\fP) run:
.PP
.nf
.fam C
             iocage fetch release=10.1-RELEASE

.fam T
.fi
This example will apply latest patches to 10.1-RELEASE base.
Newly created jails or basejails will automatically have the latest
updates applied.
.PP
Specifying \fB-p\fP or \fB-P\fP to \fIfetch\fP will have it also \fIfetch\fP a ports tree
that all basejails will share with that base.
.PP
compression: Compression is lz4 by default; see \fBzfs\fP(8) for the \fIlist\fP of
compression algorithms available.
.PP
ftplocaldir: Specifying ftplocaldir=/dev/ will \fIfetch\fP release tar files from a
local system directory. This is useful when a user wants to use a custom build
release or use \fBiocage\fP offline.
.PP
Example: \fIfetch\fP release=10.2-RELEASE ftplocaldir=/fakeftp/release/10.2-RELEASE
.RE
.PP
\fIget\fP [\fB-r\fP] property|all \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Get named property or if "all" keyword is specified dump all properties
    known to iocage.

    To display whether resource limits are enforced for a jail:

    iocage get rlimits UUID|TAG
    iocage get -r rlimits
    iocage get all UUID|TAG

.fam T
.fi
\fIhelp\fP
.PP
.nf
.fam C
    This help file you are reading.

.fam T
.fi
\fIimport\fP \fIUUID\fP [\fIproperty=value\fP]
.PP
.nf
.fam C
    Import full jail images or differential packages. Images need to be
    present in /iocage/images along with checksum files. You can use short
    UUIDs - do not specify the full filename only the UUID. These jails
    become what we call "thickjails" and are not supported for all operations.

.fam T
.fi
\fIinit-host\fP \fIIP\fP \fIZPOOL\fP
.PP
.nf
.fam C
    Initialize a remote host for iocage. iocage will send all required ZFS
    filesystems over the network to the host. This requires SSH working keys
    installed for root.

.fam T
.fi
\fIinuse\fP [\fIUUID\fP|\fITAG\fP]
.PP
.nf
.fam C
    Display consumed resources for a jail. Without UUID or TAG dump all
    resources for all running jails in a comma delimited form.

.fam T
.fi
\fIpkg\fP \fITAG\fP \fIpkg_cmd\fP
.PP
.nf
.fam C
    A convinience wrapper for pkg to manage your jails. Converts the given tag
    to the JID of a running jail and executes `pkg -j JID pkg_cmd`.

.fam T
.fi
\fIlimits\fP [\fIUUID\fP|\fITAG\fP]
.PP
.nf
.fam C
    Display active resource limits for a jail or all jails. With no UUID
    supplied display all limits active for all jails.

.fam T
.fi
\fIlist\fP [\fB-t\fP|\fB-r\fP]
.PP
.nf
.fam C
    List all jails, if -t is specified list only templates,
    with -r list downloaded releases.
    Non iocage jails will be listed only if the jail is running.

.fam T
.fi
\fIpromote\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Promote a cloned jail to a fully independent copy. For more details please
    read zfs(8).

.fam T
.fi
\fIrcboot\fP
.PP
.nf
.fam C
    Start all jails with "boot" property set to "on". Intended for boot time
    execution. Jails will be started in an ordered fashion based on their
    "priority" property.

.fam T
.fi
reboot \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Fully stops the jail with `iocage stop` and, upon success, restarts it with
    `iocage start`. If `-s` is specified it will instead do a soft restart
    on the jail. The soft method will restart the jail without destroying
    the jail's networking or the jail process itself. All processes are
    gracefully restarted inside the jail. This is useful for quick and graceful
    restarts.

.fam T
.fi
\fIrcshutdown\fP
.PP
.nf
.fam C
    Stop all jails with "boot" property set to "on". Intended for full host
    shutdown.
    Jails will be stopped in an ordered fashion based on their "priority"
    property.

.fam T
.fi
\fIreset\fP \fIUUID\fP|\fITAG\fP|ALL
.PP
.nf
.fam C
    This will reset a jail's properties back to the defaults.

    It reads from the properties set on the "default" dataset. TAG, UUID and
    generated vnet mac addresses are carried forward.

    Those will retain their values, even if you reset the jail.
    You can also reset every jail to the default properties by using the
    keyword "ALL".

.fam T
.fi
restart \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Soft restart jail. Soft method will restart the jail without destroying
    the jail's networking and the jail process itself. All processes are
    gracefully restarted inside the jail. Useful for quick and graceful
    restarts.

.fam T
.fi
\fIrollback\fP \fIUUID\fP|\fITAG\fP@snapshotname
.PP
.nf
.fam C
    Rollback to an existing snapshot. Any intermediate snapshots will be
    destroyed. For more information on this functionality please read zfs(8).

.fam T
.fi
\fIruntime\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Show runtime configuration of a jail. Useful for debugging.

.fam T
.fi
\fIsend\fP [\fB-c\fP|\fB-i\fP|\fB-I\fP|\fB-h\fP|\fB-u\fP|\fB-m\fP] \fIPOOL\fP
.PP
.nf
.fam C
    Will take a recursive snapshot of the POOL/iocage dataset and send it to
    the specified pool. Supports remote, incremental and movement operations.
    Moving (-m) is only available for local operations. Remote (-r) requires a
    user (-u) and a host (-h) to be specified. It also requires publickey
    authentication. If using incremental (-i) or Incremental (-I) be sure to
    supply the flag for each snapshot.

    If clean (-c) is provided, it will remove all snapshots from both the
    source and destination pools. This cannot be used in combination with
    incremental (-i) or Incremental (-i).

    Local Example: iocage send newpool
    Incremental Example: iocage send -i oldpool/iocage@snap1 -i oldpool/iocage@snap2 newpool
    Remote Example: iocage send -r -u root -h some.host newpool

    The received pool is not mounted if received locally, but is mounted if
    received remotely.

.fam T
.fi
\fIset\fP \fIproperty=value\fP [\fIproperty=value\fP] \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Set one or more properties to the supplied value.

.fam T
.fi
\fIsnaplist\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    List all snapshots belonging to jail.

.nf
.fam C
        NAME    - snapshot name
        CREATED - creation time
        RSIZE   - referenced size
        USED    - used space

.fam T
.fi
\fIsnapmount\fP \fIUUID\fP|\fITAG\fP@snapshotname \fIDESTINATION\fP
.PP
.nf
.fam C
    This will mount the specified jail's snapshot on the location given.

.fam T
.fi
\fIsnapremove\fP \fIUUID\fP|\fITAG\fP@snapshotname|ALL
.PP
.nf
.fam C
    Destroy specified jail snapshot. If the keyword ALL is specified all
    snapshots will be destroyed for the jail.

.fam T
.fi
snapshot|snap [\fB-f\fP|\fB-r\fP] \fIUUID\fP|\fITAG\fP [\fIUUID\fP|\fITAG\fP@snapshotname]
.PP
.nf
.fam C
    Create a ZFS snapshot for jail. If the -r flag is specified it will by
    recursively snapshot POOL/iocage/jails/UUID. Otherwise it will only snapshot
    POOL/iocage/jails/UUID/root. If no snapshot name is specified defaults
    to auto snapshot name based on current date and time.

    The -f flag is to bypass the interactive question if you have a running
    database in the jail. Make sure to pass -f on it's own and first before any
    other flag like -r.

    Example: iocage snapshot -f -r JAIL

.fam T
.fi
\fIsnapumount\fP \fIUUID\fP|\fITAG\fP@snapshotname
.PP
.nf
.fam C
    Will unmount the specified jail's snapshot.

.fam T
.fi
\fIstart\fP [\fB-f\fP] \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Start jail identified by UUID or TAG. If the -f switch is supplied, it will
    force start a template for editing. This flag does not apply to normal
    jails.

.fam T
.fi
\fIstop\fP \fIUUID\fP|\fITAG\fP|ALL
.PP
.nf
.fam C
    Stop jail identified by UUID or TAG. If ALL is specified, it will stop all
    jails.

.fam T
.fi
\fIuncap\fP \fIUUID\fP|\fITAG\fP
.PP
.nf
.fam C
    Release all resource limits, disable limits on the fly.

.fam T
.fi
\fIupdate\fP [\fB-p\fP|\fB-P\fP] \fIUUID\fP|\fITAG\fP|RELEASE
.PP
.nf
.fam C
    Will reclone the jail if it is a basejail, otherwise it updates the jail
    to the latest patch level. A back-out snapshot is created to allow
    safe update/rollback.

    If -p or -P along with a RELEASE are specified instead of a jail, it will
    update that RELEASEs shared ports tree.

.fam T
.fi
\fIupgrade\fP \fIUUID\fP|\fITAG\fP [\fIrelease=RELEASE\fP]
.PP
.nf
.fam C
    By default this will upgrade jail RELEASE to match the host's RELEASE
    unless another RELEASE is specified with the "release" property.

    Please note: The upgrade process for basejails is done by setting the jail's
    "release" property to the required new RELEASE and then merging /etc.
    If you wish to do this yourself without having /etc merged do:

    iocage set release=10.1-RELEASE UUID|TAG

    For this the RELEASE must be locally available. The basejail
    will re-clone its filesystems from the new release at next jail start.

    WARNING: Cloned jails (deprecated) [-c] are not supported for upgrades.
    Please use thick (deprecated) [-t] or our standard basejails for
    this feature.

.fam T
.fi
\fIversion\fP | --\fIversion\fP
.PP
.nf
.fam C
    List version number.

.fam T
.fi
.SH PROPERTIES
For more information on properties please check the relevant man page which
is noted under each property in the form of "Source: manpage". Source "local"
marks \fBiocage\fP specific properties.
.PP
pkglist=none | path-to-file
.PP
.nf
.fam C
    A text file containing one package per line. These will be auto installed
    when a jail is created. Works only in combination with the create
    subcommand.

    Default: none
    Source: local

.fam T
.fi
vnet=on | off
.PP
.nf
.fam C
    This controls whether to start the jail with VNET or a shared IP
    configuration. Default is to auto-guess from a sysctl. If you don't
    need a fully virtualized per jail network stack set it to off.

    Default: auto-guess
    Source: local

.fam T
.fi
bpf=on | off
.PP
.nf
.fam C
    This controls whether to start the jail with BPF devices enabled.
    Default is off.

    Default: off
    Source: local

.fam T
.fi
dhcp=on | off
.PP
.nf
.fam C
    This controls whether to start the jail with DHCP.
    Default is off, but if you want it on, vnet and bpf are required.

    Default: off
    Source: local

.fam T
.fi
ip4_addr="interface|ip-address/netmask"
.PP
.nf
.fam C
    The IPv4 address for VNET and shared IP jails.

    Form is: interface|ip-address/netmask
    Multiple interfaces:
    "interface|ip-address/netmask,interface|ip-address/netmask"

    For shared IP jails if an interface is given before
    the IP address, an alias for the address will be added to that
    interface, as it is with the interface parameter. If the DEFAULT
    tag is used instead of an interface, the interface will be
    automatically assigned based upon the system's default interface.

    If a netmask in either dotted-quad or CIDR form is given after IP
    address, it will be used when adding the IP alias.

    If the AUTOIP4 tag is used in place of an ip-address, the IP address
    will be automatically assigned at first start of the jail. This
    requires that the ip4_autostart and ip4_autoend variables are set on
    the 'default' property source. If used, the IP4 address will be set
    to the first available based upon the given range and already created
    jails.

    Example:
      # iocage set ip4_autostart="100" default
      # iocage set ip4_autoend="150" default
      # iocage set ip4_autosubnet="24" default

    This will result in the automatic IPv4 address being assigned in the
    base range of the default network interface. I.E. if the local default
    NIC is set to 192.168.0.XXX, then the new address will be
    192.168.0.[100-150]/24

    For VNET jails the interface will be configured with the IP addresses
    listed.

    Example: "vnet0|192.168.0.10/24,vnet1|10.1.1.10/24"
    This would configure interfaces vnet0 and vnet1 in a VNET jail. In this
    case no network configuration is necessary in the jail's rc.conf file.

    Default: none
    Source: jail(8)

.fam T
.fi
ip4_saddrsel=1 | 0
.PP
.nf
.fam C
    Only takes effect when vnet=off.
    A boolean option to change the formerly mentioned behaviour and
    disable IPv4 source address selection for the prison in favour of
    the primary IPv4 address of the jail.  Source address selection
    is enabled by default for all jails and the ip4_nosaddrsel
    settting of a parent jail is not inherited for any child jails.

    Default: 1
    Source: jail(8)

.fam T
.fi
ip4=new | disable | inherit
.PP
.nf
.fam C
    Only takes effect when vnet=off.
    Control the availability of IPv4 addresses.  Possible values are
    "inherit" to allow unrestricted access to all system addresses,
    "new" to restrict addresses via ip4.addr above, and "disable" to
    stop the jail from using IPv4 entirely.  Setting the ip4.addr
    parameter implies a value of "new".

    Default: new
    Source: jail(8)

.fam T
.fi
defaultrouter=none | ipaddress
.PP
.nf
.fam C
    Setting this property to anything other than none will try to configure a
    default route inside a VNET jail.

.fam T
.fi
defaultrouter6=none | ip6address
.PP
.nf
.fam C
    Setting this property to anything other than none will try to configure a
    default IPv6 route inside a VNET jail.

.fam T
.fi
resolver=none | nameserver \fIIP\fP;nameserver \fIIP\fP;search domain.local
.PP
.nf
.fam C
    Sets the jail's resolver (resolv.conf). Fields must be ; delimited
    which are translated to newlines in resolv.conf.

    If the resolver is set to none (default) the jail will inherit
    the hosts resolv.conf file.

.fam T
.fi
ip6.addr, ip6.saddrsel, ip6
.PP
.nf
.fam C
    A set of IPv6 options for the prison, the counterparts to
    ip4.addr, ip4.saddrsel and ip4 above.

.fam T
.fi
interfaces=vnet0:bridge0,vnet1:bridge1 | vnet0:bridge0
.PP
.nf
.fam C
    By default there are two interfaces specified with their bridge
    association. Up to four interfaces are supported. Interface configurations
    are separated by commas. Format is interface:bridge, where left value is
    the virtual VNET interface name, right value is the bridge name where the
    virtual interface should be attached.

    Default: vnet0:bridge0,vnet1:bridge1
    Source: local

.fam T
.fi
host_domainname="NIS domainname"
.PP
.nf
.fam C
    The NIS domainname of the jail.

    Default: none
    Source: jail(8)

.fam T
.fi
host_hostname=\fIUUID\fP
.PP
.nf
.fam C
    The hostname of the jail.

    Default: UUID
    Source: jail(8)

.fam T
.fi
exec_fib=0 | 1 ..
.PP
.nf
.fam C
    The FIB (routing table) to set when running commands inside the jail.

    Default: 0
    Source: jail(8)

.fam T
.fi
devfs_ruleset=4 | 0 ..
.PP
.nf
.fam C
    The number of the devfs ruleset that is enforced for mounting
    devfs in this jail.  A value of zero (default) means no ruleset
    is enforced.  Descendant jails inherit the parent jail's devfs
    ruleset enforcement.  Mounting devfs inside a jail is possible
    only if the allow_mount and allow_mount_devfs permissions are
    effective and enforce_statfs is set to a value lower than 2.
    Devfs rules and rulesets cannot be viewed or modified from inside
    a jail.

    NOTE: It is important that only appropriate device nodes in devfs
    be exposed to a jail; access to disk devices in the jail may permit
    processes in the jail to bypass the jail sandboxing by modifying
    files outside of the jail.  See devfs(8) for information on
    how to use devfs rules to limit access to entries in the per-jail
    devfs.  A simple devfs ruleset for jails is available as ruleset
    #4 in /etc/defaults/devfs.rules

    Default: 4
    Source: jail(8)

.fam T
.fi
mount_devfs=1 | 0
.PP
.nf
.fam C
    Mount a devfs(5) filesystem on the chrooted /dev directory, and
    apply the ruleset in the devfs_ruleset parameter (or a default of
    ruleset 4: devfsrules_jail) to restrict the devices visible
    inside the jail.

    Default: 1
    Source: jail(8)

.fam T
.fi
exec_start="/bin/sh /etc/rc"
.PP
.nf
.fam C
    Command(s) to run in the prison environment when a jail is created.
    A typical command to run is "sh /etc/rc".

    Default: /bin/sh /etc/rc
    Source: jail(8)

.fam T
.fi
exec_stop="/bin/sh /etc/rc.shutdown"
.PP
.nf
.fam C
    Command(s) to run in the prison environment before a jail is
    removed, and after any exec_prestop commands have completed.
    A typical command to run is "sh /etc/rc.shutdown".

    Default: /bin/sh /etc/rc.shutdown
    Source: jail(8)

.fam T
.fi
exec_prestart="/usr/bin/true"
.PP
.nf
.fam C
    Command(s) to run in the system environment before a jail is started.

    Default: /usr/bin/true
    Source: jail(8)

.fam T
.fi
exec_prestop="/usr/bin/true"
.PP
.nf
.fam C
    Command(s) to run in the system environment before a jail is stopped.

    Default: /usr/bin/true
    Source: jail(8)

.fam T
.fi
exec_poststop="/usr/bin/true"
.PP
.nf
.fam C
    Command(s) to run in the system environment after a jail is stopped.

    Default: /usr/bin/true
    Source: jail(8)

.fam T
.fi
exec_poststart="/usr/bin/true"
.PP
.nf
.fam C
    Command(s) to run in the system environment after a jail is started,
    and after any exec_start commands have completed.

    Default: /usr/bin/true
    Source: jail(8)

.fam T
.fi
exec_clean=1 | 0
.PP
.nf
.fam C
    Run commands in a clean environment.  The environment is discarded
    except for HOME, SHELL, TERM and USER.  HOME and SHELL are
    set to the target login's default values.  USER is set to the
    target login.  TERM is imported from the current environment.
    The environment variables from the login class capability database
    for the target login are also set.

    Default: 1
    Source: jail(8)

.fam T
.fi
exec_timeout=60 | 30 ..
.PP
.nf
.fam C
    The maximum amount of time to wait for a command to complete.  If
    a command is still running after this many seconds have passed,
    the jail will be terminated.

    Default: 60
    Source: jail(8)

.fam T
.fi
stop_timeout=30 | 60 ..
.PP
.nf
.fam C
    The maximum amount of time to wait for a jail's processes to
    exit after sending them a SIGTERM signal (which happens after the
    exec_stop commands have completed).  After this many seconds have
    passed, the jail will be removed, which will kill any remaining
    processes. If this is set to zero, no SIGTERM is sent and the
    prison is immediately removed.

    Default: 30
    Source: jail(8)

.fam T
.fi
exec_jail_user=root
.PP
.nf
.fam C
    The user to run commands as, when running in the jail environment.

    Default: root
    Source:  jail(8)

.fam T
.fi
exec_system_jail_user=0 | 1
.PP
.nf
.fam C
    This boolean option looks for the exec_jail_user in the system
    passwd(5) file, instead of in the jail's file.

    Default: 0
    Source: jail(8)

.fam T
.fi
exec_system_user=root
.PP
.nf
.fam C
    The user to run commands as, when running in the system environment.
    The default is to run the commands as the current user.

    Default: root
    Source: jail(8)

.fam T
.fi
mount_fdescfs=1 | 0
.PP
.nf
.fam C
    Mount a fdescfs(5) filesystem in the jail's /dev/fd directory.
    Note: This is not supported on FreeBSD 9.3.

    Default: 1
    Source: jail(8)

.fam T
.fi
mount_procfs=0 | 1
.PP
.nf
.fam C
    Mount a procfs(5) filesystem in the jail's /dev/proc directory.

    Default: 0
    Source: local

.fam T
.fi
mount_linprocfs=0 | 1
.PP
.nf
.fam C
    Mount a linprocfs(5) filesystem in the jail's /compat/linux/proc directory.

    Default: 0
    Source: local

.fam T
.fi
enforce_statfs=2 | 1 | 0
.PP
.nf
.fam C
    This determines which information processes in a jail are able to
    get about mount points.  It affects the behaviour of the following
    syscalls: statfs(2), fstatfs(2), getfsstat(2) and fhstatfs(2)
    (as well as similar compatibility syscalls).  When set to 0, all
    mount points are available without any restrictions.  When set to 1,
    only mount points below the jail's chroot directory are visible
    In addition to that, the path to the jail's chroot directory
    is removed from the front of their pathnames.  When set to 2
    (default), above syscalls can operate only on a mount-point where
    the jail's chroot directory is located.

    Default: 2. jail(8)

.fam T
.fi
children_max=0 | ..
.PP
.nf
.fam C
    The number of child jails allowed to be created by this jail (or
    by other jails under this jail). This limit is zero by default,
    indicating the jail is not allowed to create child jails.  See
    the Hierarchical Jails section for more information in jail(8).

    Default: 0
    Source: jail(8)

.fam T
.fi
login_flags="\fB-f\fP root"
.PP
.nf
.fam C
    Supply these flags to login when logging in to jails with the console
    function.

    Default: -f root
    Source: login(1)

.fam T
.fi
jail_zfs=on | off
.PP
.nf
.fam C
    Enables automatic ZFS jailing inside the jail. Assigned ZFS dataset will
    be fully controlled by the jail.
    NOTE: Setting this to "on" automatically enables allow_mount=1
    enforce_statfs=1 and allow_mount_zfs=1! These are dependent options
    required for ZFS management inside a jail.

    Default: off
    Source: local

.fam T
.fi
jail_zfs_dataset="zfs_filesystem \.\.\."
.PP
.nf
.fam C
    This is a space-separated list of datasets to be jailed and fully handed
    over to a jail.
    Takes a ZFS filesystem name; if it begins with "iocage/jails", it will be
    created on the ZFS pool that iocage uses.
    NOTE: only valid if jail_zfs=on. By default the mountpoint is set to none,
    to mount this dataset set its mountpoint inside the jail i.e. "zfs set
    mountpoint=/data full-dataset-name" and issue "mount -a".

    Default: iocage/jails/UUID/root/data
    Source: local

.fam T
.fi
jail_zfs_mountpoint=/path/in/jail
.PP
.nf
.fam C
    If only a single ZFS filesystem is assigned to a jail via the
    jail_zfs_dataset setting, this property may be used to manipulate its
    mountpoint within the jail.
    The default value of "none" allows the mountpoint to be managed
    from within the jail by setting the ZFS "mountpoint" property on the
    dataset directly.
    When multiple ZFS filesystesm are assigned to a jail, this property
    must be "none", and the filesystem mountpoints are manipulated directly
    using the ZFS "mountpoint" properties for the assigned datasets.

    Default: none
    Source: local

.fam T
.fi
securelevel=3 | 2 | 1 | 0 | \fB-1\fP
.PP
.nf
.fam C
    The value of the jail's kern.securelevel sysctl.  A jail never
    has a lower securelevel than the default system, but by setting
    this parameter it may have a higher one.  If the system
    securelevel is changed, any jail securelevels will be at least as
    secure.

    Default: 2
    Source: jail(8)

.fam T
.fi
allow_set_hostname=1 | 0
.PP
.nf
.fam C
    The jail's hostname may be changed via hostname(1) or sethostname(3).

    Default: 1
    Source: jail(8)

.fam T
.fi
allow_sysvipc=0 | 1
.PP
.nf
.fam C
    A process within the jail has access to System V IPC
    primitives.  Prior to FreeBSD 11.0, System V primitives
    share a single namespace across the host and jail
    environments, meaning that processes within a jail would be
    able to communicate with (and potentially interfere with)
    processes outside of the jail, and in other jails.  In
    FreeBSD 11.0 and later, this setting is deprecated in favor
    of sysvmsg, sysvsem, and sysvshm.

    Default: 0
    Source: jail(8)

.fam T
.fi
sysvmsg=disable | inherit | new
.PP
.nf
.fam C
    Allow access to SYSV IPC message primitives.  If set to
    inherit, all IPC objects on the system are visible to this
    jail, whether they were created by the jail itself, the base
    system, or other jails.  If set to new, the jail will have
    its own key namespace, and can only see the objects that it
    has created; the system (or parent jail) has access to the
    jail's objects, but not to its keys.  If set to disable, the
    jail cannot perform any sysvmsg-related system calls.
    Ignored in FreeBSD 10.3 and earlier.

    Default: new
    Source: jail(8)

.fam T
.fi
sysvsem=disable | inherit | new
.PP
.nf
.fam C
    Allow access to SYSV IPC semaphore primitives in the same
    manner as sysvmsg.  Ignored in FreeBSD 10.3 and earlier.

    Default: new
    Source: jail(8)

.fam T
.fi
sysvshm=disable | inherit | new
.PP
.nf
.fam C
    Allow access to SYSV IPC shared memory primitives in the
    same manner as sysvmsg.  Ignored in FreeBSD 10.3 and
    earlier.

    Default: new
    Source: jail(8)

.fam T
.fi
allow_raw_sockets=0 | 1
.PP
.nf
.fam C
    The prison root is allowed to create raw sockets.  Setting
    this parameter allows utilities like ping(8) and
    traceroute(8) to operate inside the prison.  If this is
    set, the source IP addresses are enforced to comply with
    the IP address bound to the jail, regardless of whether
    or not the IP_HDRINCL flag has been set on the socket.
    Since raw sockets can be used to configure and interact
    with various network subsystems, extra caution should be
    used where privileged access to jails is given out to
    untrusted parties.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_chflags=0 | 1
.PP
.nf
.fam C
    Normally, privileged users inside a jail are treated as
    unprivileged by chflags(2).  When this parameter is set,
    such users are treated as privileged, and may manipulate
    system file flags subject to the usual constraints on
    kern.securelevel.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount file system types marked as jail-friendly.
    The lsvfs(1) command can be used to find file system
    types available for mount from within a jail.  This permission
    is effective only if enforce_statfs is set to a
    value lower than 2.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount_devfs=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount the devfs file system.  This permission is
    effective only together with allow.mount and if
    enforce_statfs is set to a value lower than 2.  Please
    consider restricting the devfs ruleset with the
    devfs_ruleset option.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount_nullfs=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount the nullfs file system. This permission is
    effective only together with allow_mount and if
    enforce_statfs is set to a value lower than 2.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount_procfs=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount the procfs file system.  This permission is
    effective only together with allow.mount and if
    enforce_statfs is set to a value lower than 2.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount_tmpfs=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount the tmpfs file system.  This permission is
    effective only together with allow.mount and if
    enforce_statfs is set to a value lower than 2.
    Note: This is not supported on FreeBSD 9.3.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_mount_zfs=0 | 1
.PP
.nf
.fam C
    privileged users inside the jail will be able to mount
    and unmount the ZFS file system.  This permission is
    effective only together with allow.mount and if
    enforce_statfs is set to a value lower than 2.  See
    zfs(8) for information on how to configure the ZFS
    filesystem to operate from within a jail.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_quotas=0 | 1
.PP
.nf
.fam C
    The jail root may administer quotas on the jail's
    filesystem(s). This includes filesystems that the jail
    may share with other jails or with non-jailed parts of
    the system.

    Default: 0
    Source: jail(8)

.fam T
.fi
allow_socket_af=0 | 1
.PP
.nf
.fam C
    Sockets within a jail are normally restricted to IPv4,
    IPv6, local (UNIX), and route.  This allows access to
    other protocol stacks that have not had jail functionality
    added to them.

    Default: 0
    Source: jail(8)

.fam T
.fi
host_hostuuid=\fIUUID\fP
.PP
.nf
.fam C
    Default: UUID
    Source: jail(8)

.fam T
.fi
tag="any string"
.PP
.nf
.fam C
    Custom string for aliasing jails. Must be unique.

    Default: date@time
    Source: local

.fam T
.fi
istemplate=yes | no
.PP
.nf
.fam C
    This property controls whether the jail is a template. Templates are not
    started by iocage. Set to yes if you wish to convert the jail into
    a template.
    (See EXAMPLES section)

    Default: no
    Source: local

.fam T
.fi
boot=on | off
.PP
.nf
.fam C
    If set to "on" jail will be auto-started at boot time (rcboot subcommand)
    and stopped at shutdown time (rcshutdown subcommand). Jails will be started
    and stopped based on their priority value.

    Default: off
    Source: local

.fam T
.fi
notes="any string"
.PP
.nf
.fam C
    Custom notes for miscellaneous tagging.

    Default: none
    Source: local

.fam T
.fi
owner=root
.PP
.nf
.fam C
    The owner of the jail, can be any string.

    Default: root
    Source: local

.fam T
.fi
priority=99:0
Start priority at boot time, smaller value means higher priority.
Also, for shutdown the order will be reversed.
.RS
.PP
Default: 99. Max: 99. Lowest: 0.
.PP
Anything \fIset\fP to 99 will automatically \fIstart\fP in the background parallel
with other jails \fIset\fP to 99. Anything less than 99 will \fIstart\fP sequentially.
.RE
.PP
last_started
.PP
.nf
.fam C
    Last successful start time. Auto set every time jail starts.

    Default: timestamp
    Source: local

.fam T
.fi
type=basejail
.PP
.nf
.fam C
    Currently only basejails, gitjails and empty jails are supported.

    Default: basejail
    Source: local

.fam T
.fi
hostid=\fIUUID\fP
.PP
.nf
.fam C
    The UUID of the host node. Jails won't start if this property differs from
    the actual UUID of the host node. This is to safeguard jails from being
    started on different nodes in case they are periodically replicated across.

    Default: UUID of the host (taken from /etc/hostid)
    Source: local

.fam T
.fi
release=10.0-RELEASE | 9.2-RELEASE
.PP
.nf
.fam C
    The RELEASE used at creation time. Can be set to any string if needed.

    Default: the host's RELEASE
    Source: local

.fam T
.fi
compression=on | off | lzjb | gzip | gzip-N | zle | lz4
.PP
.nf
.fam C
    Controls the compression algorithm used for this dataset. The lzjb
    compression algorithm is optimized for performance while providing
    decent data compression. Setting compression to on uses the lzjb
    compression algorithm. The gzip compression algorithm uses the same
    compression as the gzip(1) command. You can specify the gzip level by using
    the value gzip-N where N is an integer from 1 (fastest) to 9 (best
    compression ratio). Currently, gzip is equivalent to gzip-6 (which is also
    the default for gzip(1)).  The zle compression algorithm compresses runs of
    zeros.

    The lz4 compression algorithm is a high-performance replacement for
    the lzjb algorithm. It features significantly faster compression and
    decompression, as well as a moderately higher compression ratio than
    lzjb, but can only be used on pools with the lz4_compress feature set
    to enabled.  See zpool-features(7) for details on ZFS feature flags
    and the lz4_compress feature.

    This property can also be referred to by its shortened column name
    compress.  Changing this property affects only newly-written data.

    Default: lz4
    Source: zfs(8)

.fam T
.fi
origin
.PP
.nf
.fam C
    This is only set for clones. Read-only.
    For cloned file systems or volumes, the snapshot from which the clone
    was created. See also the clones property.

    Default: -
    Source: zfs(8)

.fam T
.fi
quota=15G | 50G | ..
.PP
.nf
.fam C
    Quota for jail.
    Limits the amount of space a dataset and its descendents can consume.
    This property enforces a hard limit on the amount of space used. This
    includes all space consumed by descendents, including file systems
    and snapshots. Setting a quota on a descendent of a dataset that
    already has a quota does not override the ancestor's quota, but
    rather imposes an additional limit.

    Default: none
    Source: zfs(8)

.fam T
.fi
mountpoint
.PP
.nf
.fam C
    Path for the jail's root filesystem. Don't tweak this or jail won't start!

    Default: set to jail's root
    Source: zfs(8)

.fam T
.fi
compressratio
.PP
.nf
.fam C
    Compression ratio. Read-only.
    For non-snapshots, the compression ratio achieved for the used space
    of this dataset, expressed as a multiplier.  The used property
    includes descendant datasets, and, for clones, does not include the
    space shared with the origin snapshot.

    Source: zfs(8)

.fam T
.fi
available
.PP
.nf
.fam C
    Available space in jail's dataset.
    The amount of space available to the dataset and all its children,
    assuming that there is no other activity in the pool. Because space
    is shared within a pool, availability can be limited by any number of
    factors, including physical pool size, quotas, reservations, or other
    datasets within the pool.

    Source: zfs(8)

.fam T
.fi
used
.PP
.nf
.fam C
    Used space by jail. Read-only.
    The amount of space consumed by this dataset and all its descendents.
    This is the value that is checked against this dataset's quota and
    reservation. The space used does not include this dataset's reservation,
    but does take into account the reservations of any descendent
    datasets. The amount of space that a dataset consumes from its parent,
    as well as the amount of space that are freed if this dataset is
    recursively destroyed, is the greater of its space used and its
    reservation.

    When snapshots (see the "Snapshots" section) are created, their space
    is initially shared between the snapshot and the file system, and
    possibly with previous snapshots. As the file system changes, space
    that was previously shared becomes unique to the snapshot, and
    counted in the snapshot's space used. Additionally, deleting snapshots
    can increase the amount of space unique to (and used by) other
    snapshots.

    The amount of space used, available, or referenced does not take into
    account pending changes. Pending changes are generally accounted for
    within a few seconds. Committing a change to a disk using fsync(2) or
    O_SYNC does not necessarily guarantee that the space usage information
    is updated immediately.

    Source:  zfs(8)

.fam T
.fi
dedup=on | off | verify | sha256[,verify]
.PP
.nf
.fam C
    Deduplication for jail.
    Configures deduplication for a dataset. The default value is off.
    The default deduplication checksum is sha256 (this may change in the
    future).  When dedup is enabled, the checksum defined here overrides
    the checksum property. Setting the value to verify has the same
    effect as the setting sha256,verify.

    If set to verify, ZFS will do a byte-to-byte comparsion in case of
    two blocks having the same signature to make sure the block contents
    are identical.

    Default: off.
    Source: zfs(8)

.fam T
.fi
reservation=size | none
.PP
.nf
.fam C
    Reserved space for jail.
    The minimum amount of space guaranteed to a dataset and its descendents.
    When the amount of space used is below this value, the dataset
    is treated as if it were taking up the amount of space specified by
    its reservation. Reservations are accounted for in the parent
    datasets' space used, and count against the parent datasets' quotas
    and reservations.

    Default: none
    Source: zfs(8)

.fam T
.fi
sync_target
.PP
.nf
.fam C
    This is for future use, currently not supported.

.fam T
.fi
sync_tgt_zpool
.PP
.nf
.fam C
    This is for future use, currently not supported.

.fam T
.fi
rlimits=on | off
.PP
.nf
.fam C
    If set to "on" resource limits will be enforced.

    Default: off
    Source: local

.fam T
.fi
cpuset=1 | 1,2,3,4 | 1-2 | off
.PP
.nf
.fam C
    Controls the jail's CPU affinity. For more details please refer to
    cpuset(1).

    Default: off
    Source: cpuset(1)

.fam T
.fi
.SH RESOURCE LIMITS
Resource \fIlimits\fP (except cpuset and rlimits) use the following value
field formatting in the property: limit:action.
.PP
Limit defines how much of the resource a process can use before the
defined action triggers.
.PP
Action defines what will happen when a process exceeds the allowed
amount.
.PP
Valid actions are:
.RS
.TP
.B
deny
deny the allocation; not supported for cpu and
wallclock
.TP
.B
log
log a warning to the \fIconsole\fP
.TP
.B
devctl
\fIsend\fP notification to \fBdevd\fP(8)
.TP
.B
sig*
e.g. sigterm; \fIsend\fP a signal to the offending
process
.RE
.PP
To better understand what this means please read \fBrctl\fP(8)
before enabling any \fIlimits\fP.
.PP
The following resource \fIlimits\fP are supported:
.PP
memoryuse=limit:action | off
.PP
.nf
.fam C
    Limits the resident set size (DRAM).

    Default: 8G:log
    Source: rctl(8)

.fam T
.fi
memorylocked=limit:action | off
.PP
.nf
.fam C
    Limits locked memory.

    Default: off
    Source: rctl(8)

.fam T
.fi
vmemoryuse=limit:action | off
.PP
.nf
.fam C
    Virtual memory limit (swap + DRAM combined)

    Default: off
    Source: rctl(8)

.fam T
.fi
maxproc=limit:action | off
.PP
.nf
.fam C
    Limit maximum number of processes.

    Default: off
    Source: rctl(8)

.fam T
.fi
cputime=limit:action | off
.PP
.nf
.fam C
    Limit CPU time, in seconds.

    Default: off
    Source: rctl(8)

.fam T
.fi
pcpu=limit:action | off
.PP
.nf
.fam C
    Limit %CPU, in percents of a single CPU core or hardware thread.

    Default: off
    Source: rctl(8)

.fam T
.fi
datasize=limit:action | off
.PP
.nf
.fam C
    Limit data size.

    Default: off
    Source: rctl(8)

.fam T
.fi
stacksize=limit:action | off
.PP
.nf
.fam C
    Limit stack size.

    Default: off
    Source: rctl(8)

.fam T
.fi
coredumpsize=limit:action | off
.PP
.nf
.fam C
    Limit core dump size.

    Default: off
    Source: rctl(8)

.fam T
.fi
openfiles=limit:action | off
.PP
.nf
.fam C
    Limit file descriptor table size (number of open files).

    Default: off
    Source: rctl(8)

.fam T
.fi
pseudoterminals=limit:action | off
.PP
.nf
.fam C
    Limit number of PTYs.

    Default: off
    Source: rctl(8)

.fam T
.fi
swapuse=limit:action | off
.PP
.nf
.fam C
    Limit swap usage.

    Default: off
    Source: rctl(8)

.fam T
.fi
nthr=limit:action | off
.PP
.nf
.fam C
    Limit number of threads.

    Default: off
    Source: rctl(8)

.fam T
.fi
msgqqueued=limit:action | off
.PP
.nf
.fam C
    Limit number of queued SysV messages.

    Default: off
    Source: rctl(8)

.fam T
.fi
msgqsize=limit:action | off
.PP
.nf
.fam C
    Limit SysV message queue size.

    Default: off
    Source: rctl(8)

.fam T
.fi
nmsgq=limit:action | off
.PP
.nf
.fam C
    Limit number of SysV message queues.

    Default: off
    Source: rctl(8)

.fam T
.fi
nsemop=limit:action | off
.PP
.nf
.fam C
    Limit number of SysV semaphores modified in a single semop(2) call.

    Default: off
    Source: rctl(8)

.fam T
.fi
nshm=limit:action | off
.PP
.nf
.fam C
    Limit number of SysV shared memory segments.

    Default: off
    Source: rctl(8)

.fam T
.fi
shmsize=limit:action | off
.PP
.nf
.fam C
    Limit SysV shared memory size.

    Default: off
    Source: rctl(8)

.fam T
.fi
wallclock=limit:action | off
.PP
.nf
.fam C
    Limit wallclock time.

    Default: off
    Source: rctl(8)

.fam T
.fi
.SH EXAMPLES
Set up \fBiocage\fP from scratch:
.PP
.nf
.fam C
    iocage fetch

.fam T
.fi
Create first jail:
.PP
.nf
.fam C
    iocage create tag=myjail

.fam T
.fi
List jails:
.PP
.nf
.fam C
    iocage list

.fam T
.fi
Start jail:
.PP
.nf
.fam C
    iocage start UUID

.fam T
.fi
Turn on resource \fIlimits\fP and apply them:
.PP
.nf
.fam C
    iocage set rlimits=on UUID
    iocage cap UUID

.fam T
.fi
Display resource usage:
.PP
.nf
.fam C
    iocage inuse UUID

.fam T
.fi
Convert jail into template:
.PP
.nf
.fam C
    iocage set istemplate=yes UUID

.fam T
.fi
List templates:
.PP
.nf
.fam C
    iocage list -t

.fam T
.fi
Clone jail from template:
.PP
.nf
.fam C
    iocage clone UUID-of-template tag=myjail

.fam T
.fi
Import package on another host
.PP
.nf
.fam C
    iocage import UUID

.fam T
.fi
Get the last successful \fIstart\fP time for all jails
.PP
.nf
.fam C
    iocage get -r last_started

.fam T
.fi
.SH HINTS
\fBiocage\fP marks a ZFS pool in the pool's comment field and identifies the
active pool for use based on this string.
.PP
If using VNET don't forget to add the node's physical NIC into one
of the bridges if you need an outside connection. Also read \fBbridge\fP(4)
to see how traffic is handled if you are not familiar with this concept
(in a nutshell: bridge behaves like a network switch).
.PP
PF firewall is not supported inside VNET jails as of July 2014. PF can be
enabled for the host however. IPFW is fully supported inside a VNET jail.
.PP
Property validation is not handled by \fBiocage\fP (to keep it simple) so please
make sure your property values are supported before configuring any
properties.
.PP
The actual jail name in the \fBjls\fP(8) output is \fIset\fP to ioc-\fIUUID\fP. This is a
required workaround as jails will refuse to \fIstart\fP with \fBjail\fP(8) when name
starts with a "0".
.PP
To prevent dmesg leak inside jails apply the following sysctl:
.PP
.nf
.fam C
    security.bsd.unprivileged_read_msgbuf=0

.fam T
.fi
If using VNET consider applying these sysctl's as well:
.PP
.nf
.fam C
    net.inet.ip.forwarding=1
    net.link.bridge.pfil_onlyip=0
    net.link.bridge.pfil_bridge=0
    net.link.bridge.pfil_member=0

.fam T
.fi
For more information please visit:
.PP
.nf
.fam C
    https://github.com/iocage/iocage

.fam T
.fi
.SH SEE ALSO
\fBjail\fP(8), \fBifconfig\fP(8), \fBepair\fP(4), \fBbridge\fP(4), \fBjexec\fP(8), \fBzfs\fP(8), \fBzpool\fP(8),
\fBrctl\fP(8), \fBcpuset\fP(1), \fBfreebsd-\fIupdate\fP\fP(8), \fBsysctl\fP(8)
.SH BUGS
In case of bugs/issues/feature requests, please open an issue at
https://github.com/\fBiocage\fP/\fBiocage\fP/issues
.SH AUTHORS

Peter Toth <peter.toth198@gmail.com>
Brandon Schneider <brandonschneider89@gmail.com>
.SH SPECIAL THANKS
Sichendra Bista - for his ever willing attitude and ideas.