Module netapp_ontap.resources.ems_config

Copyright © 2022 NetApp Inc. All rights reserved.

Overview

The Event Management System (EMS) collects and processes events, and sends notification of the events through various reporting mechanisms. The following endpoints defined under '/support/ems', allow you to query a list of observed events, and configure which events you handle and how you are notified: - /support/ems - /support/ems/events - /support/ems/messages - /support/ems/filters - /support/ems/filters/{name}/rules - /support/ems/filters/{name}/rules/{index} - /support/ems/destinations - /support/ems/destinations/{name}

Examples

Configuring an email destination

The following example configures EMS to send a support email when a WAFL event is observed with an error severity.

Configure the system-wide email parameters

from netapp_ontap import HostConnection
from netapp_ontap.resources import EmsConfig

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = EmsConfig()
    resource.mail_from = "administrator@mycompany.com"
    resource.mail_server = "smtp@mycompany.com"
    resource.patch()

Configuring a filter with an enclosed rule

from netapp_ontap import HostConnection
from netapp_ontap.resources import EmsFilter

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = EmsFilter()
    resource.name = "critical-wafl"
    resource.rules = [
        {
            "index": 1,
            "type": "include",
            "message_criteria": {
                "name_pattern": "wafl.*",
                "severities": "emergency,error,alert",
            },
        }
    ]
    resource.post(hydrate=True)
    print(resource)

Setting up an email destination

from netapp_ontap import HostConnection
from netapp_ontap.resources import EmsDestination

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = EmsDestination()
    resource.name = "Technician_Email"
    resource.type = "email"
    resource.destination = "technician@mycompany.com"
    resource.filters = [{"name": "critical-wafl"}]
    resource.post(hydrate=True)
    print(resource)

Classes

class EmsConfig (*args, **kwargs)

Allows interaction with EmsConfig 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

Methods

def get(self, **kwargs) -> NetAppResponse

Retrieves the EMS configuration.

  • event config show

Learn more


Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Updates the EMS configuration.

  • event config modify

Learn more


Send the difference in the object's state to the host as a modification request.

Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

Args

hydrate
If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

class EmsConfigSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)

The fields of the EmsConfig object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables

The links field of the ems_config.

mail_from GET PATCH

Mail from

Example: administrator@mycompany.com

mail_server GET PATCH

Mail server (SMTP)

Example: mail@mycompany.com

proxy_password PATCH

Password for HTTP/HTTPS proxy

Example: password

proxy_url GET PATCH

HTTP/HTTPS proxy URL

Example: https://proxyserver.mycompany.com

proxy_user GET PATCH

User name for HTTP/HTTPS proxy

Example: proxy_user

pubsub_enabled GET PATCH

Is Publish/Subscribe Messaging Enabled?

Example: true