InlineMonitoringEvent1
{
"description": "string",
"description_on_clear": "string",
"entity_resource_type": "string",
"event_false_snmp_oid": "string",
"event_tags": [
"string"
],
"event_true_snmp_oid": "string",
"event_type": "string",
"event_type_display_name": "string",
"feature_display_name": "string",
"feature_name": "string",
"id": "string",
"is_disabled": false,
"is_sensitivity_fixed": false,
"is_threshold_fixed": false,
"is_threshold_floating_point": false,
"kb_article": "string",
"max_threshold": 0,
"max_threshold_floating_point": "number",
"min_threshold": 0,
"min_threshold_floating_point": "number",
"node_types": [
"string"
],
"recommended_action": "string",
"sensitivity": 0,
"severity": "string",
"summary": "string",
"suppress_alarm": false,
"suppress_snmp_trap": false,
"threshold": 0,
"threshold_floating_point": "number",
"threshold_unit_type": "string",
"visibility": "string",
"visibility_paths": [
"string"
]
}Detailed description of the event.
Description of Event when an Event instance transitions from True to False.
Resource Type of entity where this event is applicable eg. LogicalSwitch, LogicalPort etc.
Optional field containing OID for SNMP trap sent when Event instance is False. This value is null if suppress_snmp_trap or suppress_clear_oid is True.
Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.
Optional field containing OID for SNMP trap sent when Event instance is True. This value is null if suppress_snmp_trap is True.
Name of Event, e.g. manager_cpu_usage_high, certificate_expired.
Display name of Event type.
Display name of feature defining this Event.
Feature defining this Event, e.g. manager_health, certificates.
Unique identifier in the form of feature_name.event_type.
Flag to indicate whether sampling for this Event is off or on.
Indicates if the sensitivity property is configurable via the API.
Indicates if the threshold property is configurable via the API.
Flag to indicate if the threshold for this Event is a floating point number. If this value is true, the threshold_floating_point property is used to indicate the threshold at runtime; otherwise, the threshold property is used.
KB article link that contains more information on this event and recommended actions. Users can refer to the specified link if needed.
Maximum allowed threshold value if the threshold is configurable and a maximum value is applicable.
Maximum allowed floating point threshold value if the threshold_floating_point is configurable and a maximum value is applicable.
Minimum allowed threshold value if the threshold is configurable and a minimum value is applicable.
Minimum allowed floating point threshold value if the threshold_floating_point is configurable and a minimum value is applicable.
Array identifying the nodes on which this Event is applicable. Can be one or more of the following values - nsx_public_cloud_gateway, nsx_edge, nsx_esx, nsx_kvm, nsx_manager.
Recommended action for the alarm condition.
Percentage of samples to consider and used in combination with threshold when determining whether an Event instance status is True or False. Event evaluation uses sampling to determine Event instance status. A higher sensitivity value specifies that more samples are used to ensure accuracy and ignore infrequent or rare spikes in sampled data.
Severity of the Event.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.
Summary description of the event.
Flag to suppress Alarm generation. Alarms are not generated for this Event when this is set to True.
Flag to suppress SNMP trap generation. SNMP traps are not sent for this Event when this is set to True.
Threshold to determine if a single sample is True. For example, if the configured threshold is 95% and the current CPU sample is 99%, then the current sample is considered True. Note, if is_threshold_floating_point is true, the threshold_floating_point property is used to indicate the threshold value.
Floating point threshold to determine if a single sample is True. For example, if the configured threshold is 66.6 percent and the sample value is 68.8 percent, the current sample is considered True. Note, if is_threshold_floating_point is false, the threshold property is used to indicate the threshold value.
Identifies the unit type of the threshold value.
The visibility property enables enterprise_admin and site_reliability_engineer users to specify whether an event’s corresponding alarm is visible to users assigned tenant roles in a multi-tenant deployment. By default, when the visibility property is not set, tenant users only see an alarm if they have access to the alarming entity per RBAC rules. Setting visibility to TENANT_NONE means even if a tenant user has RBAC access to the alarming entity, the user will not see the alarm. Setting visibility to TENANT_READ means if a tenant user does not have access to the alarming entity, the user will still have read only access to the alarm as long as the user has access to one of the paths specified in the visibility_paths property.
The visiblity_paths property must be set if visibility is set to TENANT_READ and must not be set if visibility is set to TENANT_NONE or not set. If a tenant user in a multi-tenant deployment does not have access to the alarming entity, the user will not be able to access the corresponding alarm unless visibility TENANT_READ is set and the user has access to at least one of the paths specified in visibility_paths.