Name

systemd.swap — systemd swap configuration files

Synopsis

systemd.swap

Options

Swap files must include a [Swap] section, which carries information about the swap device it supervises. A number of options that may be used in this section are shared with other unit types. These options are documented in systemd.exec(5). The options specific to the [Swap] section of swap units are the following:

What=

Takes an absolute path of a device node or file to use for paging. See swapon(8) for details. If this refers to a device node, a dependency on the respective device unit is automatically created. (See systemd.device(5) for more information.) If this refers to a file, a dependency on the respective mount unit is automatically created. (See systemd.mount(5) for more information.) This option is mandatory.

Priority=

Swap priority to use when activating the swap device or file. This takes an integer. This setting is optional.

TimeoutSec=

Configures the time to wait for the swapon command to finish. If a command does not exit within the configured time the swap will be considered failed and be shut down again. All commands still running will be terminated forcibly via SIGTERM, and after another delay of this time with SIGKILL. (See KillMode= below.) Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass 0 to disable the timeout logic. Defaults to 90s.

KillMode=

Specifies how processes of this swap shall be killed. One of control-group, process, none.

This option is mostly equivalent to the KillMode= option of service files. See systemd.service(5) for details.

KillSignal=

Specifies which signal to use when killing a process of this swap. Defaults to SIGTERM.

SendSIGKILL=

Specifies whether to send SIGKILL to remaining processes after a timeout, if the normal shutdown procedure left processes of the swap around. Takes a boolean value. Defaults to "yes".