models.alert_metadata module

class models.alert_metadata.AlertMetadata(alert_document_list=None, alert_type_bucket=None, alert_type_id=None, category=None, dedup_interval_seconds=None, dedup_until_resolved=None, hide_alert_from_user=None, ignore_duplicate_occurrences=None, primary_key_list=None, property_list=None, send_support_notification=None, snmp_notification=None, syslog_notification=None, version=None)

Bases: object

Implementation of the ‘AlertMetadata’ model.

AlertMetadata specifies metadata for a given alert type. All the alerts of a given alert type share the same metadata.

Attributes:

alert_document_list (list of AlertDocument): Specifies alert

documentation one per each language supported.

alert_type_bucket (AlertTypeBucketEnum): Specifies the Alert type

bucket. Specifies the Alert type bucket. kHardware - Alerts related to hardware on which Cohesity software is running. kSoftware - Alerts which are related to software components. kDataService - Alerts related to data services. kMaintenance - Alerts relates to maintenance activities.

alert_type_id (int): Specifies unique id for the alert type. category (AlertCategoryEnum): Specifies category of the alert type.

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.

dedup_interval_seconds (int): Specifies dedup interval in seconds. If

the same alert is raised multiple times by any client in this duration, only one of them will be reported.

dedup_until_resolved (bool): Specifies if the alerts are to be deduped

until the current one (if any) is resolved.

hide_alert_from_user (bool): Specifies whether to show the alert in

the iris UI and CLI.

ignore_duplicate_occurrences (bool): Specifies whether to ignore

duplicate occurrences completely.

primary_key_list (list of string): Specifies properties that serve as

primary keys.

property_list (list of string): Specifies list of properties that the

client is supposed to provide when alert of this type is raised.

send_support_notification (bool): Specifies whether to send support

notification for the alert.

snmp_notification (bool): Specifies whether an SNMP notification is

sent when an alert is raised.

syslog_notification (bool): Specifies whether an syslog notification

is sent when an alert is raised.

version (int): Specifies version of the metadata.

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.