Module netapp_ontap.resources.ems_event
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
Queries a live collection of observed events on the system.
Example
Querying for the latest event received by EMS
# API
GET /api/support/ems/events?fields=message.name&max_records=1
# Response
200 OK
# JSON Body
{
"records": [
{
"node": {
"name": "node1",
"uuid": "f087b8e3-99ac-11e8-b5a5-005056bb4ec7",
"_links": {
"self": {
"href": "/api/cluster/nodes/f087b8e3-99ac-11e8-b5a5-005056bb4ec7"
}
}
},
"index": 661,
"message": {
"name": "raid.aggr.log.CP.count"
},
"_links": {
"self": {
"href": "/api/support/ems/events/node1/661"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/support/ems/events?fields=message.name&max_records=1"
},
}
}
Classes
class EmsEvent (*args, **kwargs)
-
Allows interaction with EmsEvent objects on the host
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves a collection of observed events.
Related ONTAP commands
event log show
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves a collection of observed events.
Related ONTAP commands
event log show
Learn more
Fetch a list of all objects of this type from the host.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library.
Inherited members
class EmsEventSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the EmsEvent object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var index
-
Index of the event. Returned by default.
Example: 1
var links
-
The links field of the ems_event.
var log_message
-
A formatted text string populated with parameter details. Returned by default.
var message
-
The message field of the ems_event.
var node
-
The node field of the ems_event.
var opts
var parameters
-
A list of parameters provided with the EMS event.
var source
-
Source
var time
-
Timestamp of the event. Returned by default.