|
APIs in Category: ems |
API version 1.5 |
ems-autosupport-log |
The Event Management System (EMS) is a mechanism in the Data ONTAP kernel that supports creation, forwarding, and consumption of event indications. Ems events are generated by ONTAP when errors occur or to log status. These event indications are logged to /etc/log/ems and, depending on the event and its severity, to the syslog/console. If an event has a SNMP definition, SNMP traps will also be generated by the event indication. |
| ems-autosupport-log | [top] |
This API is used by SnapDrive to log SnapDrive specific events occurring on a host system to the the appliance and optionally use the appliance to generate an autosupport message. This event information will be encapsulated in an app.log.x EMS event based on error level. If auto-support is true, an autosupport message will be sent from the filer.
Input Name Range Type Description app-version string
Version of application invoking the API. auto-support boolean
validate
If 'true', an AutoSupport message will be generated. category string
Application defined category of the event. computer-name string
Host name invoking the API. event-description string
Description of event to log. An application defined message to log. event-id integer
validate
ID of event. A user defined event-id, range [0..2^32-2]. event-source string
Name of the application invoking the API. log-level integer
validate
Log level. Accepted values are 0 for 'emergency', 1 for 'alert', 2 for 'critical', 3 for 'error', 4 for 'warning', 5 for 'notice', 6 for 'info', and 7 for 'debug'.
Errno Description ENOENT
| ems-invoke | [top] |
Invoke an ems event. This functionality is intended for use in testing syslog parsers or upper level SNMP management software. The event will be forwarded to the ems log at /etc/log/ems and optionally to the syslog or SNMP trap generator. Invoked events in /etc/log/ems will have the attribute 'inv' set to "1". This is to allow auto-support to differentiate between real and invoked events. Syslog entries resulting from invoked events will contain the text "invoked event:" so that they aren't confused with real events. Invoked events by default are only logged to the /etc/log/ems log. To have an event go to the syslog or generate an snmp trap, the 'syslog' and/or 'snmp' flags need to be set.
Input Name Range Type Description event-id string
Name of the event to invoke. Each ems event has a unique identifier (event-id) that can be used by this api to 'fake' an event. Example event-id's: kern.syslog.msg kern.uptime.filer raid.cksum.replay.nvram raid.cksum.replay.summary raid.fsm.commitStateTransit event-version integer
optional
If set, specifies the version of the event to invoke. By default, the latest version is used. Accepted values are [1..n]. Event-version is only used when multiple versions of an event exist simultaneously within a given build of ONTAP. Most events have an event-version of 1. params param[]
optional
severity string
optional
For events with variable severity, specfies the severity to invoke the event at. Shouldn't be set for events that don't have variable severity. Possible Values: debug info notice warning svc_error node_error svc_fault node_fault snmp boolean
optional
If set, and event has an SNMP definition, generate SNMP trap for event. Invoked messages by default do not generate SNMP traps. syslog boolean
optional
If set, and the event has a syslog format definition, forward invoked message to syslog. Invoked messages are by default not forwarded to syslog
Errno Description EEMS_INVOKE_FAILED EEMS_INVOKE_BAD_PARAM EEMS_INVOKE_ID_BAD EEMS_INVOKE_SEVERITY_REQUIRED EEMS_INVOKE_SEVERITY_INVALID EEMS_INVOKE_SEVERITY_NOT_VARIABLE EEMS_INVOKE_PARAMS_INSUFFICIENT EEMS_INVOKE_VERSION_INVALID EEMS_INVOKE_SUPRESS_DUP EEMS_INVOKE_SUPRESS_TIMER EEMS_INVOKE_NVRAM_TOO_BIG EEMS_INVOKE_QUEUE_FULL
| Element definition: param | [top] |
one parameter required by the event.
[none]