Differential D19996 Diff 56932 sbin/dumpon/dumpon.8

Changeset View

Standalone View

sbin/dumpon/dumpon.8

	Show All 22 Lines
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" From: @(#)swapon.8 8.1 (Berkeley) 6/5/93			.\" From: @(#)swapon.8 8.1 (Berkeley) 6/5/93
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd November 17, 2018			.Dd May 1, 2019
	.Dt DUMPON 8			.Dt DUMPON 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm dumpon			.Nm dumpon
	.Nd "specify a device for crash dumps"			.Nd "specify a device for crash dumps"
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
				.Op Fl i Ar index
				.Op Fl r
	.Op Fl v			.Op Fl v
	.Op Fl k Ar pubkey			.Op Fl k Ar pubkey
	.Op Fl Z			.Op Fl Z
	.Op Fl z			.Op Fl z
	.Ar device			.Ar device
	.Nm			.Nm
				.Op Fl i Ar index
				.Op Fl r
	.Op Fl v			.Op Fl v
	.Op Fl k Ar pubkey			.Op Fl k Ar pubkey
	.Op Fl Z			.Op Fl Z
	.Op Fl z			.Op Fl z
	.Op Fl g Ar gateway			.Op Fl g Ar gateway
	.Fl s Ar server			.Fl s Ar server
	.Fl c Ar client			.Fl c Ar client
	.Ar iface			.Ar iface
	Show All 14 Lines
	in a persistent fashion using the			in a persistent fashion using the
	.Xr rc.conf 5			.Xr rc.conf 5
	variables			variables
	.Va dumpdev			.Va dumpdev
	and			and
	.Va dumpon_flags .			.Va dumpon_flags .
	For more information on this usage, see			For more information on this usage, see
	.Xr rc.conf 5 .			.Xr rc.conf 5 .
				.Pp
				Starting in
				.Fx 13.0 ,
				.Nm
				can configure a series of fallback dump devices.
				For example, an administrator may prefer
				markjUnsubmitted Done Inline Actions .Xr netdump 4 ? markj: .Xr netdump 4 ?
				cemAuthorUnsubmitted Done Inline Actions Thanks, will fix. cem: Thanks, will fix.
				.Xr netdump 4
				by default, but if the
				.Xr netdump 4
				service cannot be reached or some other failure occurs, they might choose a
				local disk dump as a second choice option.
	.Ss General options			.Ss General options
	.Bl -tag -width _k_pubkey			.Bl -tag -width _k_pubkey
				.It Fl i Ar index
				Insert the specified dump configuration into the prioritized fallback dump
				device list at the specified index, starting at zero.
				.Pp
				If
				.Fl i
				is not specified, the configured dump device is appended to the prioritized
				list.
				.It Fl r
				Remove the specified dump device configuration or configurations from the
				fallback dump device list rather than inserting or appending it.
				In contrast,
				.Do
				.Nm
				off
				.Dc
				removes all configured devices.
				Conflicts with
				.Fl i .
	.It Fl k Ar pubkey			.It Fl k Ar pubkey
	Configure encrypted kernel dumps.			Configure encrypted kernel dumps.
	.Pp			.Pp
	A random, one-time symmetric key is automatically generated for bulk kernel			A random, one-time symmetric key is automatically generated for bulk kernel
	dump encryption every time			dump encryption every time
	.Nm			.Nm
	is used.			is used.
	The provided			The provided
	.Ar pubkey			.Ar pubkey
	is used to encrypt a copy of the symmetric key.			is used to encrypt a copy of the symmetric key.
	The encrypted dump contents consist of a standard dump header, the			The encrypted dump contents consist of a standard dump header, the
	pubkey-encrypted symmetric key contents, and the symmetric key encrypted core			pubkey-encrypted symmetric key contents, and the symmetric key encrypted core
	dump contents.			dump contents.
	.Pp			.Pp
	As a result, only someone with the corresponding private key can decrypt the symmetric key.			As a result, only someone with the corresponding private key can decrypt the symmetric key.
	The symmetric key is necessary to decrypt the kernel core.			The symmetric key is necessary to decrypt the kernel core.
	The goal of the mechanism is to provide confidentiality.			The goal of the mechanism is to provide confidentiality.
	.Pp			.Pp
	The			The
	.Va pubkey			.Va pubkey
	file should be a PEM-formatted RSA key of at least 1024 bits.			file should be a PEM-formatted RSA key of at least 1024 bits.
	.It Fl l			.It Fl l
	List the currently configured dump device, or /dev/null if no device is			List the currently configured dump device(s), or /dev/null if no devices are
	configured.			configured.
	.It Fl v			.It Fl v
	Enable verbose mode.			Enable verbose mode.
	.It Fl Z			.It Fl Z
	Enable compression (Zstandard).			Enable compression (Zstandard).
	.It Fl z			.It Fl z
	Enable compression (gzip).			Enable compression (gzip).
	Only one compression method may be enabled at a time, so			Only one compression method may be enabled at a time, so
	▲ Show 20 Lines • Show All 268 Lines • Show Last 20 Lines