xref: /illumos-gate/usr/src/man/man3sysevent/sysevents.3sysevent (revision a25df66779f8c4c58005d492d3ceac6312116360)
1*a25df667SRobert Mustacchi.\"
2*a25df667SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*a25df667SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*a25df667SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*a25df667SRobert Mustacchi.\" 1.0 of the CDDL.
6*a25df667SRobert Mustacchi.\"
7*a25df667SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*a25df667SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*a25df667SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*a25df667SRobert Mustacchi.\"
11*a25df667SRobert Mustacchi.\"
12*a25df667SRobert Mustacchi.\" Copyright 2019 Joyent, Inc.
13*a25df667SRobert Mustacchi.\"
14*a25df667SRobert Mustacchi.Dd July 15, 2019
15*a25df667SRobert Mustacchi.Dt SYSEVENTS 3SYSEVENT
16*a25df667SRobert Mustacchi.Os
17*a25df667SRobert Mustacchi.Sh NAME
18*a25df667SRobert Mustacchi.Nm sysevents
19*a25df667SRobert Mustacchi.Nd list of system events generated by the platform
20*a25df667SRobert Mustacchi.Sh SYNOPSIS
21*a25df667SRobert Mustacchi.In sys/sysevent/eventdefs.h
22*a25df667SRobert Mustacchi.Sh DESCRIPTION
23*a25df667SRobert MustacchiSystem events are events that are generated by the operating system to
24*a25df667SRobert Mustacchiindicate that something has occurred that may be of interest to user
25*a25df667SRobert Mustacchiland.
26*a25df667SRobert MustacchiThese notifications are asynchronous from the event themselves and
27*a25df667SRobert Mustacchidepending on the event, may be lossy.
28*a25df667SRobert MustacchiThat is, the kernel may opt not to generate an event in the face of
29*a25df667SRobert Mustacchimemory pressure.
30*a25df667SRobert MustacchiCurrently, every generated event should make it to consumers.
31*a25df667SRobert Mustacchi.Pp
32*a25df667SRobert MustacchiEvents are broken into classes such as ZFS, FMA, PCIe, and others.
33*a25df667SRobert MustacchiClasses are further broken down into subclasses.
34*a25df667SRobert MustacchiSpecific events may also have more detailed payload which is available
35*a25df667SRobert Mustacchias name-value pairs.
36*a25df667SRobert MustacchiFor more information on subscribing to events, classes, and payloads,
37*a25df667SRobert Mustacchiplease see
38*a25df667SRobert Mustacchi.Xr sysevent_subscribe_event 3SYSEVENT ,
39*a25df667SRobert Mustacchi.Xr sysevent_get_attr_list 3SYSEVENT ,
40*a25df667SRobert Mustacchiand
41*a25df667SRobert Mustacchi.Xr libnvpair 3LIB .
42*a25df667SRobert Mustacchi.Pp
43*a25df667SRobert MustacchiMost system events are currently logged to the FMA information log which
44*a25df667SRobert Mustacchican be retrieved with the
45*a25df667SRobert Mustacchi.Ar -I
46*a25df667SRobert Mustacchioption to the
47*a25df667SRobert Mustacchi.Xr fmdump 1M
48*a25df667SRobert Mustacchicommand.
49*a25df667SRobert Mustacchi.Sh EVENTS
50*a25df667SRobert MustacchiThis section contains a list of some of the events that are generated by
51*a25df667SRobert Mustacchithe system, but it is not exhaustive.
52*a25df667SRobert MustacchiThe names of events are macros that the system provides.
53*a25df667SRobert MustacchiThe payload member name is generally a macro and its corresponding type
54*a25df667SRobert Mustacchiis provided, along with a brief description.
55*a25df667SRobert MustacchiUnless otherwise noted, it should be assumed that the event and its
56*a25df667SRobert Mustacchipayload is private to the system and may change at any time.
57*a25df667SRobert Mustacchi.Pp
58*a25df667SRobert MustacchiThe following events belong to the class
59*a25df667SRobert Mustacchi.Dv EC_DATALINK :
60*a25df667SRobert Mustacchi.Bl -tag -width Dv
61*a25df667SRobert Mustacchi.It Dv ESC_DATALINK_LINK_STATE
62*a25df667SRobert MustacchiThis event fires any time a data link
63*a25df667SRobert Mustacchi.Pq see Xr dladm 1M
64*a25df667SRobert Mustacchichanges its state.
65*a25df667SRobert MustacchiThis may occur because a physical cable was inserted or removed from a
66*a25df667SRobert Mustacchinetwork adapter or because something has changed on a virtual adapter
67*a25df667SRobert Mustacchisuch as a VNIC.
68*a25df667SRobert MustacchiThe event has the following payload:
69*a25df667SRobert Mustacchi.Bl -tag -width Dv
70*a25df667SRobert Mustacchi.It Dv DATALINK_EV_LINK_NAME - String
71*a25df667SRobert MustacchiIndicates the name of the data link that had the event.
72*a25df667SRobert Mustacchi.It Dv DATALINK_EV_LINK_ID - int32
73*a25df667SRobert MustacchiIndicates the data link's logical ID that is used by the kernel.
74*a25df667SRobert Mustacchi.It Dv DATALINK_EV_ZONE_ID - int32
75*a25df667SRobert MustacchiIndicates the ID of the zone that the data link belongs to.
76*a25df667SRobert Mustacchi.El
77*a25df667SRobert Mustacchi.El
78*a25df667SRobert Mustacchi.Sh INTERFACE STABILITY
79*a25df667SRobert MustacchiWhile the library interface in
80*a25df667SRobert Mustacchi.Xr libsysevent 3SYSEVENT
81*a25df667SRobert Mustacchiis committed, unless otherwise indicated the events, classes, their
82*a25df667SRobert Mustacchipayloads, are private and subject to change at any time.
83*a25df667SRobert Mustacchi.Sh SEE ALSO
84*a25df667SRobert Mustacchi.Xr libnvpair 3LIB ,
85*a25df667SRobert Mustacchi.Xr libsysevent 3LIB ,
86*a25df667SRobert Mustacchi.Xr sysevent_get_attr_list 3SYSEVENT ,
87*a25df667SRobert Mustacchi.Xr sysevent_subscribe_event 3SYSEVENT
88