Module netapp_ontap.resources.ems_message
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
Allows access to the EMS event catalog. The catalog contains a list of all events supported by the system and their corresponding descriptions, the reason for an event occurrence, and how to correct issues related to the event.
Example
Querying for the first event that has a message name beginning with 'C'
# API
GET /api/support/ems/messages?fields=name&max_records=1&name=C*
# Response
200 OK
# JSON Body
{
"records": [
{
"name": "CR.Data.File.Inaccessible",
"_links": {
"self": {
"href": "/api/support/ems/messages/CR.Data.File.Inaccessible"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/support/ems/messages?fields=name&max_records=1&name=C*"
},
}
}
Classes
class EmsMessage (*args, **kwargs)
-
Allows interaction with EmsMessage 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 the event catalog definitions.
Related ONTAP commands
event catalog 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 the event catalog definitions.
Related ONTAP commands
event catalog 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 EmsMessageSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the EmsMessage object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var corrective_action
-
Corrective action
var deprecated
-
Is deprecated?
Example: true
var description
-
Description
var links
-
The links field of the ems_message.
var name
-
Name of the event.
Example: callhome.spares.low
var opts
var severity
-
Severity
Valid choices:
- emergency
- alert
- error
- notice
- informational
- debug
var snmp_trap_type
-
SNMP trap type
Valid choices:
- standard
- built_in
- severity_based