Module netapp_ontap.resources.ems_config
Copyright © 2024 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Overview
This endpoint is used to configure general parameters of the Event Management System (EMS).
Examples
Configuring 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 = "mycompany.com"
resource.mail_server_user = "smtp"
resource.patch()
Retrieving the EMS configuration
The following example retrieves EMS configuration for the cluster.
from netapp_ontap import HostConnection
from netapp_ontap.resources import EmsConfig
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = EmsConfig()
resource.get()
print(resource)
EmsConfig(
{
"mail_server": "localhost",
"pubsub_enabled": True,
"mail_from": "admin@localhost",
"_links": {"self": {"href": "/api/support/ems"}},
}
)
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.
Related ONTAP commands
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 or if not all of the keys required are present and config.STRICT_GET has been set to True. def patch (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse
-
Updates the EMS configuration.
Related ONTAP commands
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.
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 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
-
links: SelfLink GET
-
The links field of the ems_config.
-
mail_from: str GET PATCH
-
Mail from
Example: administrator@mycompany.com
-
mail_server: str GET PATCH
-
Mail server (SMTP)
Example: mail.mycompany.com
-
mail_server_password: str PATCH
-
Password for Mail server (SMTP)
Example: password
-
mail_server_user: str GET PATCH
-
Username for Mail server (SMTP)
Example: user
-
proxy_password: str PATCH
-
Password for HTTP/HTTPS proxy
Example: password
-
proxy_url: str GET PATCH
-
HTTP/HTTPS proxy URL
Example: https://proxyserver.mycompany.com
-
proxy_user: str GET PATCH
-
User name for HTTP/HTTPS proxy
Example: proxy_user
-
pubsub_enabled: bool GET PATCH
-
Is Publish/Subscribe Messaging Enabled?
Example: true