xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-events.8 (revision 1603881667360c015f6685131f2f25474fa67a72)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23eda14cbcSMatt Macy.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2017 Datto Inc.
25eda14cbcSMatt Macy.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26eda14cbcSMatt Macy.\" Copyright 2017 Nexenta Systems, Inc.
27eda14cbcSMatt Macy.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28eda14cbcSMatt Macy.\"
29*16038816SMartin Matuska.Dd May 27, 2021
30eda14cbcSMatt Macy.Dt ZPOOL-EVENTS 8
31eda14cbcSMatt Macy.Os
32*16038816SMartin Matuska.
33eda14cbcSMatt Macy.Sh NAME
347877fdebSMatt Macy.Nm zpool-events
35*16038816SMartin Matuska.Nd list recent events generated by kernel
36eda14cbcSMatt Macy.Sh SYNOPSIS
377877fdebSMatt Macy.Nm zpool
38eda14cbcSMatt Macy.Cm events
39*16038816SMartin Matuska.Op Fl vHf
40*16038816SMartin Matuska.Op Ar pool
417877fdebSMatt Macy.Nm zpool
42eda14cbcSMatt Macy.Cm events
43*16038816SMartin Matuska.Fl c
44*16038816SMartin Matuska.
45*16038816SMartin Matuska.Sh DESCRIPTION
46*16038816SMartin MatuskaLists all recent events generated by the ZFS kernel modules.
47*16038816SMartin MatuskaThese events are consumed by the
48eda14cbcSMatt Macy.Xr zed 8
49eda14cbcSMatt Macyand used to automate administrative tasks such as replacing a failed device
50*16038816SMartin Matuskawith a hot spare.
51*16038816SMartin MatuskaFor more information about the subclasses and event payloads
52eda14cbcSMatt Macythat can be generated see the
53eda14cbcSMatt Macy.Xr zfs-events 5
54eda14cbcSMatt Macyman page.
55*16038816SMartin Matuska.Pp
56*16038816SMartin Matuska.Bl -tag -compact -width Ds
57eda14cbcSMatt Macy.It Fl c
58eda14cbcSMatt MacyClear all previous events.
59eda14cbcSMatt Macy.It Fl f
60eda14cbcSMatt MacyFollow mode.
61eda14cbcSMatt Macy.It Fl H
62*16038816SMartin MatuskaScripted mode.
63*16038816SMartin MatuskaDo not display headers, and separate fields by a
64eda14cbcSMatt Macysingle tab instead of arbitrary space.
65eda14cbcSMatt Macy.It Fl v
66eda14cbcSMatt MacyPrint the entire payload for each event.
67eda14cbcSMatt Macy.El
68*16038816SMartin Matuska.
69eda14cbcSMatt Macy.Sh SEE ALSO
70eda14cbcSMatt Macy.Xr zfs-events 5 ,
71*16038816SMartin Matuska.Xr zfs-module-parameters 5 ,
72*16038816SMartin Matuska.Xr zed 8 ,
73*16038816SMartin Matuska.Xr zpool-wait 8
74