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