models.alert module

class models.alert.Alert(alert_category=None, alert_code=None, alert_document=None, alert_state=None, alert_type=None, alert_type_bucket=None, cluster_id=None, cluster_name=None, dedup_count=None, dedup_timestamps=None, event_source=None, first_timestamp_usecs=None, id=None, latest_timestamp_usecs=None, property_list=None, resolution_details=None, severity=None, suppression_id=None, tenant_ids=None)

Bases: object

Implementation of the ‘Alert’ model.

Specifies information about an Alert such as the type, id assigned by the Cohesity Cluster, number of duplicates, severity, etc.

Attributes:

alert_category (AlertCategoryEnum): 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.

alert_code (string): Specifies a unique code that categorizes the

Alert, for example: CE00200014, where CE stands for Cohesity Error, the alert state next 3 digits is the id of the Alert Category (e.g. 002 for ‘kNode’) and the last 5 digits is the id of the Alert Type (e.g. 00014 for ‘kNodeHighCpuUsage’).

alert_document (AlertDocument): Specifies documentation about the

Alert such as name, description, cause and how to resolve the Alert.

alert_state (AlertStateEnum): Specifies the current state of the

Alert. kAlertOpen - Alerts that are unresolved. kAlertResolved - Alerts that are already marked as resolved. kAlertSuppressed - Alerts that are suppressed due to snooze settings.

alert_type (int): Specifies a 5 digit unique digital id for the Alert

Type, such as 00014 for ‘kNodeHighCpuUsage’. This id is used in alertCode.

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.

cluster_id (long|int): Specifies id of the cluster where the alert was

raised.

cluster_name (string): Specifies name of the cluster where the alert

was raised.

dedup_count (int): Specifies total count of duplicated Alerts even if

there are more than 25 occurrences.

dedup_timestamps (list of long|int): Specifies Unix epoch Timestamps

(in microseconds) for the last 25 occurrences of duplicated Alerts that are stored with the original/primary Alert. Alerts are grouped into one Alert if the Alerts are the same type, are reporting on the same Object and occur within one hour. ‘dedupCount’ always reports the total count of duplicated Alerts even if there are more than 25 occurrences. For example, if there are 100 occurrences of this Alert, dedupTimestamps stores the timestamps of the last 25 occurrences and dedupCount equals 100.

event_source (string): Specifies source where the event occurred. first_timestamp_usecs (long|int): Specifies Unix epoch Timestamp (in

microseconds) of the first occurrence of the Alert.

id (string): Specifies unique id of this Alert. latest_timestamp_usecs (long|int): Specifies Unix epoch Timestamp (in

microseconds) of the most recent occurrence of the Alert.

property_list (list of AlertProperty): Specifies array of key-value

pairs associated with the Alert. The Cohesity Cluster may autogenerate properties depending on the Alert type. This list includes both autogenerated and specified properties.

resolution_details (AlertResolutionDetails): Specifies information

about the Alert Resolution such as a summary, id assigned by the Cohesity Cluster, user who resolved the Alerts, etc.

severity (SeverityEnum): 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.

suppression_id (long|int): Specifies unique id generated when the

Alert is suppressed by the admin.

tenant_ids (list of string): Specifies the tenants for which this

alert has been raised.

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.