HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd-nspawn.xml
Git blob: 58d4c84b36c153168ad93674304585d3acdb4455
Lines 1001–2000 of 2,180
<filename>systemd-nspawn@.service</filename> template unit file is used.</para>
<para>Note: it is possible to undo the effect of <option>--private-users-ownership=chown</option> (or
<option>-U</option>) on the file system by redoing the operation with the first UID of 0:</para>
<programlisting>systemd-nspawn … --private-users=0 --private-users-ownership=chown</programlisting>
<xi:include href="version-info.xml" xpointer="v230"/>
</listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Networking Options</title>
<variablelist>
<varlistentry>
<term><option>--private-network</option></term>
<listitem><para>Disconnect networking of the container from
the host. This makes all network interfaces unavailable in the
container, with the exception of the loopback device and those
specified with <option>--network-interface=</option> and
configured with <option>--network-veth</option>. If this
option is specified, the <constant>CAP_NET_ADMIN</constant> capability will be
added to the set of capabilities the container retains. The
latter may be disabled by using <option>--drop-capability=</option>.
If this option is not specified (or implied by one of the options
listed below), the container will have full access to the host network.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--network-interface=</option></term>
<listitem><para>Assign the specified network interface to the container. Either takes a single
interface name, referencing the name on the host, or a colon-separated pair of interfaces, in which
case the first one references the name on the host, and the second one the name in the container.
When the container terminates, the interface is moved back to the calling namespace and renamed to
its original name. Note that <option>--network-interface=</option> implies
<option>--private-network</option>. This option may be used more than once to add multiple network
interfaces to the container.</para>
<para>Note that any network interface specified this way must already exist at the time the container
is started. If the container shall be started automatically at boot via a
<filename>systemd-nspawn@.service</filename> unit file instance, it might hence make sense to add a
unit file drop-in to the service instance
(e.g. <filename>/etc/systemd/system/systemd-nspawn@foobar.service.d/50-network.conf</filename>) with
contents like the following:</para>
<programlisting>[Unit]
Wants=sys-subsystem-net-devices-ens1.device
After=sys-subsystem-net-devices-ens1.device</programlisting>
<para>This will make sure that activation of the container service will be delayed until the
<literal>ens1</literal> network interface has shown up. This is required since hardware probing is
fully asynchronous, and network interfaces might be discovered only later during the boot process,
after the container would normally be started without these explicit dependencies.</para>
<xi:include href="version-info.xml" xpointer="v209"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--network-macvlan=</option></term>
<listitem><para>Create a <literal>macvlan</literal> interface of the specified Ethernet network
interface and add it to the container. Either takes a single interface name, referencing the name
on the host, or a colon-separated pair of interfaces, in which case the first one references the name
on the host, and the second one the name in the container. A <literal>macvlan</literal> interface is
a virtual interface that adds a second MAC address to an existing physical Ethernet link. If the
container interface name is not defined, the interface in the container will be named after the
interface on the host, prefixed with <literal>mv-</literal>. Note that
<option>--network-macvlan=</option> implies <option>--private-network</option>. This option may be
used more than once to add multiple network interfaces to the container.</para>
<para>As with <option>--network-interface=</option>, the underlying Ethernet network interface must
already exist at the time the container is started, and thus similar unit file drop-ins as described
above might be useful.</para>
<xi:include href="version-info.xml" xpointer="v211"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--network-ipvlan=</option></term>
<listitem><para>Create an <literal>ipvlan</literal> interface of the specified Ethernet network
interface and add it to the container. Either takes a single interface name, referencing the name on
the host, or a colon-separated pair of interfaces, in which case the first one references the name
on the host, and the second one the name in the container. An <literal>ipvlan</literal> interface is
a virtual interface,
similar to a <literal>macvlan</literal> interface, which uses the same MAC address as the underlying
interface. If the container interface name is not defined, the interface in the container will be
named after the interface on the host, prefixed
with <literal>iv-</literal>. Note that <option>--network-ipvlan=</option> implies
<option>--private-network</option>. This option may be used more than once to add multiple network
interfaces to the container.</para>
<para>As with <option>--network-interface=</option>, the underlying Ethernet network interface must
already exist at the time the container is started, and thus similar unit file drop-ins as described
above might be useful.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<term><option>--network-veth</option></term>
<listitem><para>Create a virtual Ethernet link (<literal>veth</literal>) between host and container. The host
side of the Ethernet link will be available as a network interface named after the container's name (as
specified with <option>--machine=</option>), prefixed with <literal>ve-</literal>. The container side of the
Ethernet link will be named <literal>host0</literal>. The <option>--network-veth</option> option implies
<option>--private-network</option>.</para>
<para>Note that
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
includes by default a network file <filename>/usr/lib/systemd/network/80-container-ve.network</filename>
matching the host-side interfaces created this way, which contains settings to enable automatic address
provisioning on the created virtual link via DHCP, as well as automatic IP routing onto the host's external
network interfaces. It also contains <filename>/usr/lib/systemd/network/80-container-host0.network</filename>
matching the container-side interface created this way, containing settings to enable client side address
assignment via DHCP. In case <filename>systemd-networkd</filename> is running on both the host and inside the
container, automatic IP communication from the container to the host is thus available, with further
connectivity to the external network.</para>
<para>Note that <option>--network-veth</option> is the default if the
<filename>systemd-nspawn@.service</filename> template unit file is used.</para>
<para>Note that on Linux network interface names may have a length of 15 characters at maximum, while
container names may have a length up to 64 characters. As this option derives the host-side interface
name from the container name the name is possibly truncated. Thus, care needs to be taken to ensure
that interface names remain unique in this case, or even better container names are generally not
chosen longer than 12 characters, to avoid the truncation. If the name is truncated,
<command>systemd-nspawn</command> will automatically append a 4-digit hash value to the name to
reduce the chance of collisions. However, the hash algorithm is not collision-free. (See
<citerefentry><refentrytitle>systemd.net-naming-scheme</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details on older naming algorithms for this interface). Alternatively, the
<option>--network-veth-extra=</option> option may be used, which allows free configuration of the
host-side interface name independently of the container name — but might require a bit more
additional configuration in case bridging in a fashion similar to <option>--network-bridge=</option>
is desired.</para>
<xi:include href="version-info.xml" xpointer="v209"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--network-veth-extra=</option></term>
<listitem><para>Adds an additional virtual Ethernet link
between host and container. Takes a colon-separated pair of
host interface name and container interface name. The latter
may be omitted in which case the container and host sides will
be assigned the same name. This switch is independent of
<option>--network-veth</option>, and — in contrast — may be
used multiple times, and allows configuration of the network
interface names. Note that <option>--network-bridge=</option>
has no effect on interfaces created with
<option>--network-veth-extra=</option>.</para>
<xi:include href="version-info.xml" xpointer="v228"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--network-bridge=</option></term>
<listitem><para>Adds the host side of the Ethernet link created with <option>--network-veth</option>
to the specified Ethernet bridge interface. Expects a valid network interface name of a bridge device
as argument. Note that <option>--network-bridge=</option> implies <option>--network-veth</option>. If
this option is used, the host side of the Ethernet link will use the <literal>vb-</literal> prefix
instead of <literal>ve-</literal>. Regardless of the used naming prefix the same network interface
name length limits imposed by Linux apply, along with the complications this creates (for details see
above).</para>
<para>As with <option>--network-interface=</option>, the underlying bridge network interface must
already exist at the time the container is started, and thus similar unit file drop-ins as described
above might be useful.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--network-zone=</option></term>
<listitem><para>Creates a virtual Ethernet link (<literal>veth</literal>) to the container and adds it to an
automatically managed Ethernet bridge interface. The bridge interface is named after the passed argument,
prefixed with <literal>vz-</literal>. The bridge interface is automatically created when the first container
configured for its name is started, and is automatically removed when the last container configured for its
name exits. Hence, each bridge interface configured this way exists only as long as there's at least one
container referencing it running. This option is very similar to <option>--network-bridge=</option>, besides
this automatic creation/removal of the bridge device.</para>
<para>This setting makes it easy to place multiple related containers on a common, virtual Ethernet-based
broadcast domain, here called a "zone". Each container may only be part of one zone, but each zone may contain
any number of containers. Each zone is referenced by its name. Names may be chosen freely (as long as they form
valid network interface names when prefixed with <literal>vz-</literal>), and it is sufficient to pass the same
name to the <option>--network-zone=</option> switch of the various concurrently running containers to join
them in one zone.</para>
<para>Note that
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
includes by default a network file <filename>/usr/lib/systemd/network/80-container-vz.network</filename>
matching the bridge interfaces created this way, which contains settings to enable automatic address
provisioning on the created virtual network via DHCP, as well as automatic IP routing onto the host's external
network interfaces. Using <option>--network-zone=</option> is hence in most cases fully automatic and
sufficient to connect multiple local containers in a joined broadcast domain to the host, with further
connectivity to the external network.</para>
<xi:include href="version-info.xml" xpointer="v230"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--network-namespace-path=</option></term>
<listitem><para>Takes the path to a file representing a kernel
network namespace that the container shall run in. The specified path
should refer to a (possibly bind-mounted) network namespace file, as
exposed by the kernel below <filename>/proc/$PID/ns/net</filename>.
This makes the container enter the given network namespace. One of the
typical use cases is to give a network namespace under
<filename>/run/netns</filename> created by <citerefentry
project='man-pages'><refentrytitle>ip-netns</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
for example, <option>--network-namespace-path=/run/netns/foo</option>.
Note that this option cannot be used together with other
network-related options, such as <option>--private-network</option>
or <option>--network-interface=</option>.</para>
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--port=</option></term>
<listitem><para>If private networking is enabled, maps an IP
port on the host onto an IP port on the container. Takes a
protocol specifier (either <literal>tcp</literal> or
<literal>udp</literal>), separated by a colon from a host port
number in the range 1 to 65535, separated by a colon from a
container port number in the range from 1 to 65535. The
protocol specifier and its separating colon may be omitted, in
which case <literal>tcp</literal> is assumed. The container
port number and its colon may be omitted, in which case the
same port as the host port is implied. This option is only
supported if private networking is used, such as with
<option>--network-veth</option>, <option>--network-zone=</option>
<option>--network-bridge=</option>.</para>
<xi:include href="version-info.xml" xpointer="v219"/></listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Security Options</title>
<variablelist>
<varlistentry>
<term><option>--capability=</option></term>
<listitem><para>List one or more additional capabilities to grant the container. Takes a
comma-separated list of capability names, see <citerefentry
project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information. Note that the following capabilities will be granted in any way:
<constant>CAP_AUDIT_CONTROL</constant>, <constant>CAP_AUDIT_WRITE</constant>,
<constant>CAP_CHOWN</constant>, <constant>CAP_DAC_OVERRIDE</constant>,
<constant>CAP_DAC_READ_SEARCH</constant>, <constant>CAP_FOWNER</constant>,
<constant>CAP_FSETID</constant>, <constant>CAP_IPC_OWNER</constant>, <constant>CAP_KILL</constant>,
<constant>CAP_LEASE</constant>, <constant>CAP_LINUX_IMMUTABLE</constant>,
<constant>CAP_MKNOD</constant>, <constant>CAP_NET_BIND_SERVICE</constant>,
<constant>CAP_NET_BROADCAST</constant>, <constant>CAP_NET_RAW</constant>,
<constant>CAP_SETFCAP</constant>, <constant>CAP_SETGID</constant>, <constant>CAP_SETPCAP</constant>,
<constant>CAP_SETUID</constant>, <constant>CAP_SYS_ADMIN</constant>,
<constant>CAP_SYS_BOOT</constant>, <constant>CAP_SYS_CHROOT</constant>,
<constant>CAP_SYS_NICE</constant>, <constant>CAP_SYS_PTRACE</constant>,
<constant>CAP_SYS_RESOURCE</constant>, <constant>CAP_SYS_TTY_CONFIG</constant>. Also
<constant>CAP_NET_ADMIN</constant> is retained if <option>--private-network</option> is specified.
If the special value <literal>all</literal> is passed, all capabilities are retained.</para>
<para>If the special value of <literal>help</literal> is passed, the program will print known
capability names and exit.</para>
<para>This option sets the bounding set of capabilities which
also limits the ambient capabilities as given with the
<option>--ambient-capability=</option>.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--drop-capability=</option></term>
<listitem><para>Specify one or more additional capabilities to
drop for the container. This allows running the container with
fewer capabilities than the default (see
above).</para>
<para>If the special value of <literal>help</literal> is passed, the program will print known
capability names and exit.</para>
<para>This option sets the bounding set of capabilities which
also limits the ambient capabilities as given with the
<option>--ambient-capability=</option>.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--ambient-capability=</option></term>
<listitem><para>Specify one or more additional capabilities to
pass in the inheritable and ambient set to the program started
within the container. The value <literal>all</literal> is not
supported for this setting.</para>
<para>All capabilities specified here must be in the set
allowed with the <option>--capability=</option> and
<option>--drop-capability=</option> options. Otherwise, an
error message will be shown.</para>
<para>This option cannot be combined with the boot mode of the
container (as requested via <option>--boot</option>).</para>
<para>If the special value of <literal>help</literal> is
passed, the program will print known capability names and
exit.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-new-privileges=</option></term>
<listitem><para>Takes a boolean argument. Specifies the value of the
<constant>PR_SET_NO_NEW_PRIVS</constant> flag for the container payload. Defaults to off. When turned
on the payload code of the container cannot acquire new privileges, i.e. the "setuid" file bit as
well as file system capabilities will not have an effect anymore. See <citerefentry
project='man-pages'><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details about this flag. </para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--system-call-filter=</option></term> <listitem><para>Alter the system call filter
applied to containers. Takes a space-separated list of system call names or group names (the latter
prefixed with <literal>@</literal>, as listed by the <command>syscall-filter</command> command of
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>). Passed
system calls will be permitted. The list may optionally be prefixed by <literal>~</literal>, in which
case all listed system calls are prohibited. If this command line option is used multiple times the
configured lists are combined. If both a positive and a negative list (that is one system call list
without and one with the <literal>~</literal> prefix) are configured, the negative list takes
precedence over the positive list. Note that <command>systemd-nspawn</command> always implements a
system call allow list (as opposed to a deny list!), and this command line option hence adds or
removes entries from the default allow list, depending on the <literal>~</literal> prefix. Note that
the applied system call filter is also altered implicitly if additional capabilities are passed using
the <command>--capabilities=</command>.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--restrict-address-families=</option></term>
<listitem><para>Restrict the socket address families accessible to the container. Takes a
space-separated list of address family names, such as <constant>AF_INET</constant>,
<constant>AF_INET6</constant> or <constant>AF_UNIX</constant>. When prefixed with
<literal>~</literal> the listed address families will be prohibited, otherwise they will be permitted
(allowlisted). Use the special value <literal>none</literal> to prohibit all address families. This
option may be specified more than once, in which case the configured lists are combined. If both a
positive and a negative list are configured, the negative list takes precedence over the positive
list.</para>
<para>Note that currently this option defaults to no restrictions, i.e. all address families are
accessible. In a future version of systemd, the default will be changed to restrict address families to
<constant>AF_INET</constant>, <constant>AF_INET6</constant> and <constant>AF_UNIX</constant>. Use
<option>--restrict-address-families=</option> (with an empty argument) or set
<varname>RestrictAddressFamilies=</varname> in a <filename>.nspawn</filename> file to opt out of
filtering explicitly.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-Z</option></term>
<term><option>--selinux-context=</option></term>
<listitem><para>Sets the SELinux security context to be used
to label processes in the container.</para>
<xi:include href="version-info.xml" xpointer="v209"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L</option></term>
<term><option>--selinux-apifs-context=</option></term>
<listitem><para>Sets the SELinux security context to be used
to label files in the virtual API file systems in the
container.</para>
<xi:include href="version-info.xml" xpointer="v209"/>
</listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Resource Options</title>
<variablelist>
<varlistentry>
<term><option>--rlimit=</option></term>
<listitem><para>Sets the specified POSIX resource limit for the container payload. Expects an assignment of the
form
<literal><replaceable>LIMIT</replaceable>=<replaceable>SOFT</replaceable>:<replaceable>HARD</replaceable></literal>
or <literal><replaceable>LIMIT</replaceable>=<replaceable>VALUE</replaceable></literal>, where
<replaceable>LIMIT</replaceable> should refer to a resource limit type, such as
<constant>RLIMIT_NOFILE</constant> or <constant>RLIMIT_NICE</constant>. The <replaceable>SOFT</replaceable> and
<replaceable>HARD</replaceable> fields should refer to the numeric soft and hard resource limit values. If the
second form is used, <replaceable>VALUE</replaceable> may specify a value that is used both as soft and hard
limit. In place of a numeric value the special string <literal>infinity</literal> may be used to turn off
resource limiting for the specific type of resource. This command line option may be used multiple times to
control limits on multiple limit types. If used multiple times for the same limit type, the last use
wins. For details about resource limits see <citerefentry
project='man-pages'><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>. By default
resource limits for the container's init process (PID 1) are set to the same values the Linux kernel originally
passed to the host init system. Note that some resource limits are enforced on resources counted per user, in
particular <constant>RLIMIT_NPROC</constant>. This means that unless user namespacing is deployed
(i.e. <option>--private-users=</option> is used, see above), any limits set will be applied to the resource
usage of the same user on all local containers as well as the host. This means particular care needs to be
taken with these limits as they might be triggered by possibly less trusted code. Example:
<literal>--rlimit=RLIMIT_NOFILE=8192:16384</literal>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--oom-score-adjust=</option></term>
<listitem><para>Changes the OOM ("Out Of Memory") score adjustment value for the container payload. This controls
<filename>/proc/self/oom_score_adj</filename> which influences the preference with which this container is
terminated when memory becomes scarce. For details see <citerefentry
project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Takes an
integer in the range -1000…1000.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--cpu-affinity=</option></term>
<listitem><para>Controls the CPU affinity of the container payload. Takes a comma separated list of CPU numbers
or number ranges (the latter's start and end value separated by dashes). See <citerefentry
project='man-pages'><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--personality=</option></term>
<listitem><para>Control the architecture ("personality")
reported by
<citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
in the container. Currently, only <literal>x86</literal> and
<literal>x86-64</literal> are supported. This is useful when
running a 32-bit container on a 64-bit host. If this setting
is not used, the personality reported in the container is the
same as the one reported on the host.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Integration Options</title>
<variablelist>
<varlistentry>
<term><option>--resolv-conf=</option></term>
<listitem><para>Configures how <filename>/etc/resolv.conf</filename> inside of the container shall be
handled (i.e. DNS configuration synchronization from host to container). Takes one of
<literal>off</literal>, <literal>copy-host</literal>, <literal>copy-static</literal>,
<literal>copy-uplink</literal>, <literal>copy-stub</literal>, <literal>replace-host</literal>,
<literal>replace-static</literal>, <literal>replace-uplink</literal>,
<literal>replace-stub</literal>, <literal>bind-host</literal>, <literal>bind-static</literal>,
<literal>bind-uplink</literal>, <literal>bind-stub</literal>, <literal>delete</literal> or
<literal>auto</literal>.</para>
<para>If set to <literal>off</literal> the <filename>/etc/resolv.conf</filename> file in the
container is left as it is included in the image, and neither modified nor bind mounted over.</para>
<para>If set to <literal>copy-host</literal>, the <filename>/etc/resolv.conf</filename> file from the
host is copied into the container, unless the file exists already and is not a regular file (e.g. a
symlink). Similarly, if <literal>replace-host</literal> is used the file is copied, replacing any
existing inode, including symlinks. Similarly, if <literal>bind-host</literal> is used, the file is
bind mounted from the host into the container.</para>
<para>If set to <literal>copy-static</literal>, <literal>replace-static</literal> or
<literal>bind-static</literal> the static <filename>resolv.conf</filename> file supplied with
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
(specifically: <filename>/usr/lib/systemd/resolv.conf</filename>) is copied or bind mounted into the
container.</para>
<para>If set to <literal>copy-uplink</literal>, <literal>replace-uplink</literal> or
<literal>bind-uplink</literal> the uplink <filename>resolv.conf</filename> file managed by
<filename>systemd-resolved.service</filename> (specifically:
<filename>/run/systemd/resolve/resolv.conf</filename>) is copied or bind mounted into the
container.</para>
<para>If set to <literal>copy-stub</literal>, <literal>replace-stub</literal> or
<literal>bind-stub</literal> the stub <filename>resolv.conf</filename> file managed by
<filename>systemd-resolved.service</filename> (specifically:
<filename>/run/systemd/resolve/stub-resolv.conf</filename>) is copied or bind mounted into the
container.</para>
<para>If set to <literal>delete</literal> the <filename>/etc/resolv.conf</filename> file in the
container is deleted if it exists.</para>
<para>Finally, if set to <literal>auto</literal> the file is left as it is if private networking is
turned on (see <option>--private-network</option>). Otherwise, if
<filename>systemd-resolved.service</filename> is running its stub <filename>resolv.conf</filename>
file is used, and if not the host's <filename>/etc/resolv.conf</filename> file. In the latter cases
the file is copied if the image is writable, and bind mounted otherwise.</para>
<para>It's recommended to use <literal>copy-…</literal> or <literal>replace-…</literal> if the
container shall be able to make changes to the DNS configuration on its own, deviating from the
host's settings. Otherwise, <literal>bind</literal> is preferable, as it means direct changes to
<filename>/etc/resolv.conf</filename> in the container are not allowed, as it is a read-only bind
mount (but note that if the container has enough privileges, it might simply go ahead and unmount the
bind mount anyway). Note that both if the file is bind mounted and if it is copied no further
propagation of configuration is generally done after the one-time early initialization (this is
because the file is usually updated through copying and renaming). Defaults to
<literal>auto</literal>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--timezone=</option></term>
<listitem><para>Configures how <filename>/etc/localtime</filename> inside of the container
(i.e. local timezone synchronization from host to container) shall be handled. Takes one of
<literal>off</literal>, <literal>copy</literal>, <literal>bind</literal>, <literal>symlink</literal>,
<literal>delete</literal> or <literal>auto</literal>. If set to <literal>off</literal> the
<filename>/etc/localtime</filename> file in the container is left as it is included in the image, and
neither modified nor bind mounted over. If set to <literal>copy</literal> the
<filename>/etc/localtime</filename> file of the host is copied into the container. Similarly, if
<literal>bind</literal> is used, the file is bind mounted from the host into the container. If set to
<literal>symlink</literal>, a symlink is created pointing from <filename>/etc/localtime</filename> in
the container to the timezone file in the container that matches the timezone setting on the host. If
set to <literal>delete</literal>, the file in the container is deleted, should it exist. If set to
<literal>auto</literal> and the <filename>/etc/localtime</filename> file of the host is a symlink,
then <literal>symlink</literal> mode is used, and <literal>copy</literal> otherwise, except if the
image is read-only in which case <literal>bind</literal> is used instead. Defaults to
<literal>auto</literal>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--link-journal=</option></term>
<listitem><para>Control whether the container's journal shall
be made visible to the host system. If enabled, allows viewing
the container's journal files from the host (but not vice
versa). Takes one of <literal>no</literal>,
<literal>host</literal>, <literal>try-host</literal>,
<literal>guest</literal>, <literal>try-guest</literal>,
<literal>auto</literal>. If <literal>no</literal>, the journal
is not linked. If <literal>host</literal>, the journal files
are stored on the host file system (beneath
<filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>)
and the subdirectory is bind-mounted into the container at the
same location. If <literal>guest</literal>, the journal files
are stored on the guest file system (beneath
<filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>)
and the subdirectory is symlinked into the host at the same
location. <literal>try-host</literal> and
<literal>try-guest</literal> do the same but do not fail if
the host does not have persistent journaling enabled, or if
the container is in the <option>--ephemeral</option> mode. If
<literal>auto</literal> (the default), and the right
subdirectory of <filename>/var/log/journal</filename> exists,
it will be bind mounted into the container. If the
subdirectory does not exist, no linking is performed.
Effectively, booting a container once with
<literal>guest</literal> or <literal>host</literal> will link
the journal persistently if further on the default of
<literal>auto</literal> is used.</para>
<para>Note that <option>--link-journal=try-guest</option> is the default if the
<filename>systemd-nspawn@.service</filename> template unit file is used.</para>
<xi:include href="version-info.xml" xpointer="v187"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-j</option></term>
<listitem><para>Equivalent to
<option>--link-journal=try-guest</option>.</para>
<xi:include href="version-info.xml" xpointer="v187"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--forward-journal=</option></term>
<listitem><para>Forward the container's journal to the host by starting
<citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>
listening on a Unix socket that is bind-mounted into the container. The container's
<citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>
connects to the socket via the <varname>journal.forward_to_socket</varname> credential and streams
journal entries to the host in real-time. Takes a path to a journal file or directory where the received
entries will be stored. If the path ends in <literal>.journal</literal>, entries are written to a single
file; otherwise, entries are split per host into the specified directory.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--forward-journal-max-use=<replaceable>BYTES</replaceable></option></term>
<term><option>--forward-journal-keep-free=<replaceable>BYTES</replaceable></option></term>
<term><option>--forward-journal-max-file-size=<replaceable>BYTES</replaceable></option></term>
<term><option>--forward-journal-max-files=<replaceable>N</replaceable></option></term>
<listitem><para>These options configure the corresponding settings of
<citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>
when forwarding journal entries from the container. See
<citerefentry><refentrytitle>journal-remote.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the descriptions of these settings.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Mount Options</title>
<variablelist>
<varlistentry>
<term><option>--bind=</option></term>
<term><option>--bind-ro=</option></term>
<listitem><para>Bind mount a file or directory from the host into the container. Takes one of: a path
argument — in which case the specified path will be mounted from the host to the same path in the container, or
a colon-separated pair of paths — in which case the first specified path is the source in the host, and the
second path is the destination in the container, or a colon-separated triple of source path, destination path
and mount options. The source path may optionally be prefixed with a <literal>+</literal> character. If so, the
source path is taken relative to the image's root directory. This permits setting up bind mounts within the
container image. The source path may be specified as empty string, in which case a temporary directory below
the host's <filename>/var/tmp/</filename> directory is used. It is automatically removed when the container is
shut down. If the source path is not absolute, it is resolved relative to the current working directory.
The <option>--bind-ro=</option> option creates read-only bind mounts. Backslash escapes are interpreted,
so <literal>\:</literal> may be used to embed colons in either path. This option may be specified
multiple times for creating multiple independent bind mount points.</para>
<para>Mount options are comma-separated. <option>rbind</option> and <option>norbind</option> control whether
to create a recursive or a regular bind mount. Defaults to <option>rbind</option>. <option>noidmap</option>,
<option>idmap</option>, <option>rootidmap</option> and <option>owneridmap</option> control ID mapping.</para>
<para>Using <option>idmap</option>, <option>rootidmap</option> or <option>owneridmap</option> requires support
by the source filesystem for user/group ID mapped mounts. Defaults to <option>noidmap</option>. With
<option>x</option> being the container's UID range offset, <option>y</option> being the length of the
container's UID range, and <option>p</option> being the owner UID of the bind mount source inode on the host:
<itemizedlist>
<listitem><para>If <option>noidmap</option> is used, any user <option>z</option> in the range
<option>0 … y</option> seen from inside of the container is mapped to <option>x + z</option> in the
<option>x … x + y</option> range on the host. Other host users are mapped to
<option>nobody</option> inside the container.</para></listitem>
<listitem><para>If <option>idmap</option> is used, any user <option>z</option> in the UID range
<option>0 … y</option> as seen from inside the container is mapped to the same <option>z</option>
in the same <option>0 … y</option> range on the host. Other host users are mapped to
<option>nobody</option> inside the container.</para></listitem>
<listitem><para>If <option>rootidmap</option> is used, the user <option>0</option> seen from inside
of the container is mapped to <option>p</option> on the host. Other host users are mapped to
<option>nobody</option> inside the container.</para></listitem>
<listitem><para>If <option>owneridmap</option> is used, the owner of the target directory inside of the
container is mapped to <option>p</option> on the host. Other host users are mapped to
<option>nobody</option> inside the container.</para></listitem>
</itemizedlist></para>
<para>Whichever ID mapping option is used, the same mapping will be used for users and groups IDs. If
<option>rootidmap</option> or <option>owneridmap</option> are used, the group owning the bind mounted directory
will have no effect.</para>
<para>Note that when this option is used in combination with <option>--private-users</option>, the resulting
mount points will be owned by the <constant>nobody</constant> user. That's because the mount and its files and
directories continue to be owned by the relevant host users and groups, which do not exist in the container,
and thus show up under the wildcard UID 65534 (nobody). If such bind mounts are created, it is recommended to
make them read-only, using <option>--bind-ro=</option>. Alternatively you can use the "idmap" mount option to
map the filesystem IDs.</para>
<xi:include href="version-info.xml" xpointer="v198"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--bind-user=</option></term>
<listitem><para>Binds the home directory of the specified user on the host into the container. Takes
the name of an existing user on the host as argument. May be used multiple times to bind multiple
users into the container. This does two things:</para>
<orderedlist>
<listitem><para>The user's home directory is bind mounted from the host into
<filename>/run/host/home/</filename>, using an idmapped mount to map the host user's UID/GID to its
assigned UID/GID in the container.</para></listitem>
<listitem><para>A JSON user and group record is generated in <filename>/run/userdb/</filename> that
describes the mapped user. It contains a minimized representation of the host's user record,
adjusted to the UID/GID and home directory path assigned to the user in the container. The
<citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
glibc NSS module will pick up these records from there and make them available in the container's
user/group databases.</para></listitem>
</orderedlist>
<para>The combination of the two operations above ensures that it is possible to log into the
container using the same account information as on the host. The user is only mapped transiently,
while the container is running, and the mapping itself does not result in persistent changes to the
container (except maybe for log messages generated at login time, and similar). Note that in
particular the UID/GID assignment in the container is not made persistently. If the user is mapped
transiently, it is best to not allow the user to make persistent changes to the container. If the
user leaves files or directories owned by the user, and those UIDs/GIDs are reused during later
container invocations (possibly with a different <option>--bind-user=</option> mapping), those files
and directories will be accessible to the "new" user.</para>
<para>The user/group record mapping only works if the container contains systemd 249 or newer, with
<command>nss-systemd</command> properly configured in <filename>nsswitch.conf</filename>. See
<citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
details.</para>
<para>Note that the user record propagated from the host into the container will contain the UNIX
password hash of the user, so that seamless logins in the container are possible. If the container is
less trusted than the host it is hence important to use a strong UNIX password hash function
(e.g. yescrypt or similar, with the <literal>$y$</literal> hash prefix).</para>
<para>When binding a user from the host into the container checks are executed to ensure that the
username is not yet known in the container. Moreover, it is checked that the UID/GID allocated for it
is not currently defined in the user/group databases of the container. Both checks directly access
the container's <filename>/etc/passwd</filename> and <filename>/etc/group</filename>, and thus might
not detect existing accounts in other databases.</para>
<xi:include href="version-info.xml" xpointer="v249"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--bind-user-shell=</option></term>
<listitem><para>When used with <option>--bind-user=</option>, includes the specified shell in the
user records of users bound into the container. Takes either a boolean or an absolute path.</para>
<itemizedlist>
<listitem><para>If false (the default), no shell is passed in the user records for users bound into
the container. This causes bound users to the use the container's default shell.</para></listitem>
<listitem><para>If true, the shells specified by the host user records are included in the user records of all users bound into the container.</para></listitem>
<listitem><para>If passed an absolute path, sets that path as the shell for user records of all users bound into the container.</para></listitem>
</itemizedlist>
<para>Note: This will not check whether the specified shells exist in the container.</para>
<para>This operation is only supported in combination with <option>--bind-user=</option>.</para>
<xi:include href="version-info.xml" xpointer="v258"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--bind-user-group=<replaceable>NAME</replaceable></option></term>
<listitem><para>When used with <option>--bind-user=</option>, includes the specified group as an
auxiliary group in the user records of users bound into the container. Takes a group name.</para>
<para>Note: This will not check whether the specified groups exist in the container.</para>
<para>This operation is only supported in combination with <option>--bind-user=</option>.</para>
<xi:include href="version-info.xml" xpointer="v259"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--inaccessible=</option></term>
<listitem><para>Make the specified path inaccessible in the container. This over-mounts the specified path
(which must exist in the container) with a file node of the same type that is empty and has the most
restrictive access mode supported. This is an effective way to mask files, directories and other file system
objects from the container payload. This option may be used more than once in case all specified paths are
masked.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--tmpfs=</option></term>
<listitem><para>Mount a tmpfs file system into the container. Takes a single absolute path argument that
specifies where to mount the tmpfs instance to (in which case the directory access mode will be chosen as 0755,
owned by root/root), or optionally a colon-separated pair of path and mount option string that is used for
mounting (in which case the kernel default for access mode and owner will be chosen, unless otherwise
specified). Backslash escapes are interpreted in the path, so <literal>\:</literal> may be used to embed colons
in the path.</para>
<para>Note that this option cannot be used to replace the root file system of the container with a temporary
file system. However, the <option>--volatile=</option> option described below provides similar
functionality, with a focus on implementing stateless operating system images.</para>
<xi:include href="version-info.xml" xpointer="v214"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--overlay=</option></term>
<term><option>--overlay-ro=</option></term>
<listitem><para>Combine multiple directory trees into one overlay file system and mount it into the
container. Takes a list of colon-separated paths to the directory trees to combine and the
destination mount point.</para>
<para>Backslash escapes are interpreted in the paths, so <literal>\:</literal> may be used to embed
colons in the paths.</para>
<para>If three or more paths are specified, then the last specified path is the destination mount
point in the container, all paths specified before refer to directory trees on the host and are
combined in the specified order into one overlay file system. The left-most path is hence the lowest
directory tree, the second-to-last path the highest directory tree in the stacking order. If
<option>--overlay-ro=</option> is used instead of <option>--overlay=</option>, a read-only overlay
file system is created. If a writable overlay file system is created, all changes made to it are
written to the highest directory tree in the stacking order, i.e. the second-to-last specified.
</para>
<para>If only two paths are specified, then the second specified path is used both as the top-level
directory tree in the stacking order as seen from the host, as well as the mount point for the
overlay file system in the container. At least two paths have to be specified.</para>
<para>The source paths may optionally be prefixed with <literal>+</literal> character. If so they are
taken relative to the image's root directory. The uppermost source path may also be specified as an
empty string, in which case a temporary directory below the host's <filename>/var/tmp/</filename> is
used. The directory is removed automatically when the container is shut down. This behaviour is
useful in order to make read-only container directories writable while the container is running. For
example, use <literal>--overlay=+/var::/var</literal> in order to automatically overlay a writable
temporary directory on a read-only <filename>/var/</filename> directory. If a source path is not
absolute, it is resolved relative to the current working directory.</para>
<para>For details about overlay file systems, see <ulink
url="https://docs.kernel.org/filesystems/overlayfs.html">Overlay Filesystem</ulink>.
Note that the semantics of overlay file systems are substantially different from normal file systems,
in particular regarding reported device and inode information. Device and inode information may
change for a file while it is being written to, and processes might see out-of-date versions of files
at times. Note that this switch automatically derives the <literal>workdir=</literal> mount option
for the overlay file system from the top-level directory tree, making it a sibling of it. It is hence
essential that the top-level directory tree is not a mount point itself (since the working directory
must be on the same file system as the top-most directory tree). Also note that the
<literal>lowerdir=</literal> mount option receives the paths to stack in the opposite order of this
switch.</para>
<para>Note that this option cannot be used to replace the root file system of the container with an overlay
file system. However, the <option>--volatile=</option> option described above provides similar functionality,
with a focus on implementing stateless operating system images.</para>
<xi:include href="version-info.xml" xpointer="v220"/></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Input/Output Options</title>
<variablelist>
<varlistentry>
<term><option>--console=<replaceable>MODE</replaceable></option></term>
<listitem><para>Configures how to set up standard input, output and error output for the container
payload, as well as the <filename>/dev/console</filename> device for the container. Takes one of
<option>interactive</option>, <option>read-only</option>, <option>passive</option>,
<option>pipe</option> or <option>autopipe</option>. If <option>interactive</option>, a pseudo-TTY is
allocated and made available as <filename>/dev/console</filename> in the container. It is then
bi-directionally connected to the standard input and output passed to
<command>systemd-nspawn</command>. <option>read-only</option> is similar but only the output of the
container is propagated and no input from the caller is read. If <option>passive</option>, a pseudo
TTY is allocated, but it is not connected anywhere. In <option>pipe</option> mode no pseudo TTY is
allocated, but the standard input, output and error output file descriptors passed to
<command>systemd-nspawn</command> are passed on — as they are — to the container payload, see the
following paragraph. Finally, <option>autopipe</option> mode operates like
<option>interactive</option> when <command>systemd-nspawn</command> is invoked on a terminal, and
like <option>pipe</option> otherwise. Defaults to <option>interactive</option> if
<command>systemd-nspawn</command> is invoked from a terminal, and <option>read-only</option>
otherwise.</para>
<para>In <option>pipe</option> mode, <filename>/dev/console</filename> will not exist in the
container. This means that the container payload generally cannot be a full init system as init
systems tend to require <filename>/dev/console</filename> to be available. On the other hand, in this
mode container invocations can be used within shell pipelines. This is because intermediary pseudo
TTYs do not permit independent bidirectional propagation of the end-of-file (EOF) condition, which is
necessary for shell pipelines to work correctly. <emphasis>Note that the <option>pipe</option> mode
should be used carefully</emphasis>, as passing arbitrary file descriptors to less trusted container
payloads might open up unwanted interfaces for access by the container payload. For example, if a
passed file descriptor refers to a TTY of some form, APIs such as <constant>TIOCSTI</constant> may be
used to synthesize input that might be used for escaping the container. Hence <option>pipe</option>
mode should only be used if the payload is sufficiently trusted or when the standard
input/output/error output file descriptors are known safe, for example pipes.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--pipe</option></term>
<term><option>-P</option></term>
<listitem><para>Equivalent to <option>--console=pipe</option>.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--background=<replaceable>COLOR</replaceable></option></term>
<listitem><para>Change the terminal background color to the specified ANSI color as long as the
container runs. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such
as <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>,
<literal>48;5;…</literal>. See <ulink
url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI
Escape Code (Wikipedia)</ulink> for details. Assign an empty string to disable any coloring.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Credentials</title>
<variablelist>
<varlistentry>
<term><option>--load-credential=<replaceable>ID</replaceable>:<replaceable>PATH</replaceable></option></term>
<term><option>--set-credential=<replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></option></term>
<listitem><para>Pass a credential to the container. These two options correspond to the
<varname>LoadCredential=</varname> and <varname>SetCredential=</varname> settings in unit files. See
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details about these concepts, as well as the syntax of the option's arguments.</para>
<para>Note: when <command>systemd-nspawn</command> runs as systemd system service it can propagate
the credentials it received via <varname>LoadCredential=</varname>/<varname>SetCredential=</varname>
to the container payload. A systemd service manager running as PID 1 in the container can further
propagate them to the services it itself starts. It is thus possible to easily propagate credentials
from a parent service manager to a container manager service and from there into its payload. This
can even be done recursively.</para>
<para>In order to embed binary data into the credential data for <option>--set-credential=</option>,
use C-style escaping (i.e. <literal>\n</literal> to embed a newline, or <literal>\x00</literal> to
embed a <constant>NUL</constant> byte). Note that the invoking shell might already apply unescaping
once, hence this might require double escaping!</para>
<para>The
<citerefentry><refentrytitle>systemd-sysusers.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
services read credentials configured this way for the purpose of configuring the container's root
user's password and shell, as well as system locale, keymap and timezone during the first boot
process of the container. This is particularly useful in combination with
<option>--volatile=yes</option> where every single boot appears as first boot, since configuration
applied to <filename>/etc/</filename> is lost on container reboot cycles. See the respective man
pages for details. Example:</para>
<programlisting># systemd-nspawn -i image.raw \
--volatile=yes \
--set-credential=firstboot.locale:de_DE.UTF-8 \
--set-credential=passwd.hashed-password.root:'$y$j9T$yAuRJu1o5HioZAGDYPU5d.$F64ni6J2y2nNQve90M/p0ZP0ECP/qqzipNyaY9fjGpC' \
-b</programlisting>
<para>The above command line will invoke the specified image file <filename>image.raw</filename> in
volatile mode, i.e. with empty <filename>/etc/</filename> and <filename>/var/</filename>. The
container payload will recognize this as a first boot, and will invoke
<filename>systemd-firstboot.service</filename>, which then reads the two passed credentials to
configure the system's initial locale and root password.</para>
<xi:include href="version-info.xml" xpointer="v247"/>
</listitem>
</varlistentry>
</variablelist>
</refsect2><refsect2>
<title>Other</title>