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