models.notification_rule module

class models.notification_rule.NotificationRule(alert_type_list=None, categories=None, email_delivery_targets=None, rule_id=None, rule_name=None, severities=None, snmp_enabled=None, syslog_enabled=None, tenant_id=None, web_hook_delivery_targets=None)

Bases: object

Implementation of the ‘NotificationRule’ model.

Specifies a rule to notify delivery targets such as sending emails, invoking an external api etc based on the alert type, category and severity of the generated alert.

Attributes:

alert_type_list (list of int): Specifies alert types this rule is

applicable to.

categories (list of CategoryNotificationRuleEnum): Specifies alert

categories this rule is applicable to. Specifies the category of an Alert. kDisk - Alert associated with the disk. kNode - Alert associated with general hardware on a specific node. kCluster - Alert associated with general hardware in cluster level. kChassis - Alert associated with the Chassis. kPowerSupply - Alert associated with the power supply. kCPU - Alert associated with the CPU usage. kMemory - Alert associated with the RAM/Memory. kTemperature - Alert associated with the temperature. kFan - Alert associated with the fan. kNIC - Alert associated with network chips and interfaces. kFirmware - Alert associated with the firmware. kNodeHealth - Alert associated with node health status. kOperatingSystem - Alert associated with operating systems. kDataPath - Alert associated with data management in the cluster. kMetadata - Alert associated with metadata management. kIndexing - Alert associated with indexing services. kHelios - Alert associated with Helios. kAppMarketPlace - Alert associated with App MarketPlace. kLicense - Alert associated with licensing. kSecurity - Alert associated with security. kUpgrade - Alert associated with upgrade activities. kClusterManagement - Alert associated with cluster management activities. kAuditLog - Alert associated with audit log events. kNetworking - Alert associated with networking issue. kConfiguration - Alert associated with cluster or system configurations. kStorageUsage - Alert associated with the disk/domain/cluster storage usage. kFaultTolerance - Alert associated with the fault tolerance in different levels. kBackupRestore - Alert associated with Backup-Restore job. kArchivalRestore - Alert associated with Archival-Restore job. kRemoteReplication - Alert associated with Replication job. kQuota - Alert associated with Quotas.

email_delivery_targets (list of EmailDeliveryTarget): Specifies email

addresses to be notified when an alert matching this rule is generated.

rule_id (long|int): Specifies id of the alert delivery rule. rule_name (string): Specifies name of the alert delivery rule. severities (list of SeverityNotificationRuleEnum): Specifies alert

severity types this rule is applicable to. Specifies the severity level of an Alert. kCritical - Alerts whose severity type is Critical. kWarning - Alerts whose severity type is Warning. kInfo - Alerts whose severity type is Info.

snmp_enabled (bool): Specifies whether SNMP notification to be invoked

when an alert matching this rule is generated.

syslog_enabled (bool): Specifies whether syslog notification to be

invoked when an alert matching this rule is generated.

tenant_id (string): Specifies tenant id this rule is applicable to. web_hook_delivery_targets (list of WebHookDeliveryTarget): Specifies

external api urls to be invoked when an alert matching this rule is generated.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.