Alert#

class Alert(is_acknowledged=False, acknowledged_by_username=None, acknowledged_time=None, is_auto_resolved=False, is_resolved=False, resolved_by_username=None, resolved_time=None, source_entity=None, affected_entities=None, severity_trails=None, metric_details=None, title=None, alert_type=None, classifications=None, cluster_uuid=None, creation_time=None, impact_types=None, last_updated_time=None, message=None, originating_cluster_uuid=None, severity=None, is_user_defined=False, parameters=None, service_name=None, root_cause_analysis=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)[source]#

Bases: ExternalizableAbstractModel

Parameters:

  • is_acknowledged – (is_acknowledged) Field specifies if the alert is acknowledged or not. (Default False)

  • acknowledged_by_username – (acknowledged_by_username) Name of the user who acknowledged this alert.

  • acknowledged_time – (acknowledged_time) The time in ISO 8601 format when the alert was acknowledged.

  • is_auto_resolved – (is_auto_resolved) Field specifies if the alert is auto resolved or not. (Default False)

  • is_resolved – (is_resolved) Field specifies if the alert is resolved or not. (Default False)

  • resolved_by_username – (resolved_by_username) Name of the user who resolved this alert.

  • resolved_time – (resolved_time) The time in ISO 8601 format when the alert was resolved.

  • source_entity – (source_entity)

  • affected_entities – (affected_entities) List of all entities that are affected by the alert.

  • severity_trails – (severity_trails) Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.

  • metric_details – (metric_details) Details of the metric for a metric-based event.

  • title – (title) Title of the alert.

  • alert_type – (alert_type) A preconfigured or dynamically generated unique value for each alert type. For example, A1128 for storage pool space exceeded alerts.

  • classifications – (classifications) Various categories into which this alert type can be classified into. For example, Hardware, Storage, License and so on.

  • cluster_uuid – (cluster_uuid) Cluster UUID associated with the source entity of the alert.

  • creation_time – (creation_time) Time in ISO 8601 format when the alert was created.

  • impact_types – (impact_types) The impact this alert/event will have on the system. For example, availability, performance, capacity and so on.

  • last_updated_time – (last_updated_time) Time in ISO 8601 format when the alert was last updated.

  • message – (message) Additional message associated with the alert.

  • originating_cluster_uuid – (originating_cluster_uuid) Cluster UUID associated with the cluster where the alert was first raised.

  • severity – (severity)

  • is_user_defined – (is_user_defined) Flag to indicate if the alert was generated from a user defined alert policy. (Default False)

  • parameters – (parameters) Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, Service down in Prism Central alert can have the service name as a parameter.

  • service_name – (service_name) The service that raised the alert. For internal Nutanix services, this value is set to “Nutanix”.

  • root_cause_analysis – (root_cause_analysis) Possible causes, resolutions and additional details to troubleshoot this alert.

property acknowledged_by_username#

Name of the user who acknowledged this alert.

Type:

str

property acknowledged_time#

The time in ISO 8601 format when the alert was acknowledged.

Type:

datetime

property affected_entities#

List of all entities that are affected by the alert.

Type:

list[ EntityReference ]

property alert_type#

A preconfigured or dynamically generated unique value for each alert type. For example, A1128 for storage pool space exceeded alerts.

Type:

str

property classifications#

Various categories into which this alert type can be classified into. For example, Hardware, Storage, License and so on.

Type:

list[ str ]

property cluster_uuid#

Cluster UUID associated with the source entity of the alert.

Type:

str

property creation_time#

Time in ISO 8601 format when the alert was created.

Type:

datetime

property impact_types#

The impact this alert/event will have on the system. For example, availability, performance, capacity and so on.

Type:

list[ ImpactType ]

property is_acknowledged#

Field specifies if the alert is acknowledged or not.

Type:

bool

property is_auto_resolved#

Field specifies if the alert is auto resolved or not.

Type:

bool

property is_resolved#

Field specifies if the alert is resolved or not.

Type:

bool

property is_user_defined#

Flag to indicate if the alert was generated from a user defined alert policy.

Type:

bool

property last_updated_time#

Time in ISO 8601 format when the alert was last updated.

Type:

datetime

property message#

Additional message associated with the alert.

Type:

str

property metric_details#

Details of the metric for a metric-based event.

Type:

list[ MetricDetail ]

property originating_cluster_uuid#

Cluster UUID associated with the cluster where the alert was first raised.

Type:

str

property parameters#

Additional parameters associated with the alert. These parameters can be used to indicate custom key-value pairs for a given alert instance. For example, Service down in Prism Central alert can have the service name as a parameter.

Type:

list[ Parameter ]

property resolved_by_username#

Name of the user who resolved this alert.

Type:

str

property resolved_time#

The time in ISO 8601 format when the alert was resolved.

Type:

datetime

property root_cause_analysis#

Possible causes, resolutions and additional details to troubleshoot this alert.

Type:

list[ RootCauseAnalysis ]

property service_name#

The service that raised the alert. For internal Nutanix services, this value is set to “Nutanix”.

Type:

str

property severity#
Type:

Severity

property severity_trails#

Contains information on the severity change history for alerts. If an alert was de-duplicated without change in severity, then no trail will be present.

Type:

list[ SeverityTrail ]

property source_entity#
Type:

AlertEntityReference

property title#

Title of the alert.

Type:

str

to_dict()[source]#

Returns the model properties as a dictionary

to_str()[source]#

Returns the string representation of the model