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