Module netapp_ontap.resources.alert

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

This API is used to retrieve ONTAP alerts from the cluster.

This API supports GET and PATCH requests. The GET request retrieves ONTAP alerts, while the PATCH request updates the acknowledge and suppress fields.


Examples

Configuring an alerts' acknowledge state

The following example configures the acknowledge and acknowledger state for an alert.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Alert

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Alert(
        resource="sconqa-corduroyl-03",
        name="SwitchCommunityString_Alert",
        monitor="ethernet_switch",
        **{"node.uuid": "a79d919e-885a-11e9-9c44-005056bbbffe"}
    )
    resource.acknowledge = True
    resource.acknowledger = "dummy_user"
    resource.patch()


Retrieving ONTAP alerts from a healthy cluster

The following example retrieves the active ONTAP alerts from the cluster with no outstanding alerts. Note that if the fields=* parameter is not specified, the fields perceived-severity, probable-cause, possible-effect, alerting-resource-name and tags are not returned. Filters can be added on the fields to limit the results.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Alert

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(Alert.get_collection()))

[]

Retrieving ONTAP alerts from a cluster with active alerts

The following example retrieves the active ONTAP alerts from the cluster with outstanding alerts. Note that if the fields=* parameter is not specified, the fields perceived-severity, probable-cause, possible-effect, alerting-resource-name and tags are not returned. Filters can be added on the fields to limit the results.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Alert

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(Alert.get_collection()))

[
    Alert(
        {
            "labels": [
                {"label": "Slot", "value": "0"},
                {"label": "State", "value": "disabled"},
                {"label": "Status", "value": "offline"},
                {"label": "Cable ID", "value": "500a098004b9fb34-500a0980044d167f"},
            ],
            "name": "DisabledInuseSASPort_Alert",
            "acknowledger": "tgf",
            "node": {"uuid": "a79d919e-885a-11e9-9c44-005056bbbffe", "name": "node-05"},
            "cause": {
                "message": "SAS 0b port is disabled. This might occur if the port has been administratively disabled or the attached cable is faulty."
            },
            "possible_effect": {
                "message": "Controller node-05 might lose a path to storage devices connected behind port 0b."
            },
            "suppress": False,
            "corrective_action": {
                "message": "1. Verify that the physical cable connection is secure and operational, and replace the cable, if necessary.\n2. Verify that SAS port 0b is online and enabled.\n3. If the SAS port 0b is connected to disk shelves, verify that IOMs and disks are properly seated."
            },
            "monitor": "node_connect",
            "time": "2019-06-06T11:30:03-04:00",
            "acknowledge": True,
            "tags": ["quality_of_service"],
        }
    ),
    Alert(
        {
            "labels": [
                {"label": "Switch Name", "value": "switch-05"},
                {"label": "Switch Model", "value": "CN1610"},
            ],
            "name": "SwitchCommunityString_Alert",
            "node": {"uuid": "a79d919e-885a-11e9-9c44-005056bbbffe", "name": "node-05"},
            "cause": {
                "message": 'Ethernet switch "switch-05" with IP address "10.235.79.82" is not reachable via SNMP. Incorrect SNMP community string might be configured on the Ethernet switch.'
            },
            "possible_effect": {
                "message": "Ethernet switch communication problems and accessibility issues."
            },
            "suppress": False,
            "corrective_action": {
                "message": 'Check the SNMP community string on the Ethernet switch to verify the expected community string is configured. Use the "system switch ethernet show -snmp-config" command to view the expected community string.'
            },
            "monitor": "ethernet_switch",
            "time": "2019-06-06T11:16:05-04:00",
            "acknowledge": False,
        }
    ),
    Alert(
        {
            "labels": [
                {"label": "Switch Name", "value": "switch-06"},
                {"label": "Switch Model", "value": "CN1610"},
            ],
            "name": "SwitchCommunityString_Alert",
            "node": {"uuid": "a79d919e-885a-11e9-9c44-005056bbbffe", "name": "node-05"},
            "cause": {
                "message": 'Ethernet switch "switch-06" with IP address "10.235.79.83" is not reachable via SNMP. Incorrect SNMP community string might be configured on the Ethernet switch.'
            },
            "possible_effect": {
                "message": "Ethernet switch communication problems and accessibility issues."
            },
            "suppress": False,
            "corrective_action": {
                "message": 'Check the SNMP community string on the Ethernet switch to verify the expected community string is configured. Use the "system switch ethernet show -snmp-config" command to view the expected community string.'
            },
            "monitor": "ethernet_switch",
            "time": "2019-06-06T11:16:05-04:00",
            "acknowledge": False,
        }
    ),
]


Classes

class Alert (*args, **kwargs)

Alert REST API

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 count_collection(*args, connection: HostConnection = None, **kwargs) -> int

Fetch a count of all objects of this type from the host.

This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

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 count 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.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves the active ONTAP alerts from all subsystems in the cluster.

  • system health alert 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, None will be returned. 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 or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]

Retrieves the active ONTAP alerts from all subsystems in the cluster.

  • system health alert show

Learn more


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

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 objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def patch_collection(body: dict, *args, records: Iterable[_ForwardRef('Alert')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates the acknowledge and suppress fields for an alert.

  • system health alert modify

Learn more


Patch all objects in a collection which match the given query.

All records on the host which match the query will be patched with the provided body.

Args

body
A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
*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 patch the collection of bars for a particular foo, the foo.name value should be passed.
records
Can be provided in place of a query. If so, this list of objects will be patched on the host.
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 be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

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

Methods

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

Retrieves information for the alert.

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: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Updates the acknowledge and suppress fields for an alert.

  • system health alert 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 AlertSchema (*, 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 Alert object

Ancestors

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

Class variables

acknowledge: bool GET PATCH

The acknowledge state of the alert.

acknowledger: str GET PATCH

The ID of the acknowledger of the alert.

asup_enable: bool GET PATCH

True indicates that this alert will be included in the next AutoSupport(r) message.

cause: AlertMessage GET POST PATCH

The cause field of the alert.

corrective_action: AlertMessage GET POST PATCH

The corrective_action field of the alert.

labels: List[AlertLabels] GET

Additional Information.

The links field of the alert.

monitor: str GET

The monitor raising the alert.

Valid choices:

  • chassis
  • cluster_switch
  • controller
  • example
  • ethernet_switch
  • node_connect
  • system
  • system_connect
name: str GET

The alert ID which is a short name for an alert condition.

node: Node GET POST PATCH

The node field of the alert.

possible_effect: AlertMessage GET POST PATCH

The possible_effect field of the alert.

suppress: bool GET PATCH

The suppress state of the alert.

suppressor: str GET PATCH

The ID of the suppressor of the alert.

tags: List[str] GET

The tags field of the alert.

time: ImpreciseDateTime GET

The time at which the alert condition was detected.