NSX-T Data Center REST API

Update event associated with event-id.

Update event identified by event-id.

Request:

Method:

PUT

URI Path(s):

/api/v1/events/{event-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

MonitoringEvent+

MonitoringEvent (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Detailed description of Event Detailed description of the event.	string	Readonly
description_on_clear	Description of event when cleared Description of Event when an Event instance transitions from True to False.	string	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
entity_resource_type	Resource Type of entity where this event is applicable Resource Type of entity where this event is applicable eg. LogicalSwitch, LogicalPort etc.	string	Readonly
event_false_snmp_oid	OID for SNMP trap sent when Event instance is False 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.	string	Readonly
event_tags	Tags applicable to this event Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.	array of string	Readonly
event_true_snmp_oid	OID for SNMP trap sent when Event instance is True Optional field containing OID for SNMP trap sent when Event instance is True. This value is null if suppress_snmp_trap is True.	string	Readonly
event_type	Name of event type Name of Event, e.g. manager_cpu_usage_high, certificate_expired.	string	Required Readonly
event_type_display_name	Display name of event type Display name of Event type.	string	Required Readonly
feature_display_name	Display name of feature Display name of feature defining this Event.	string	Required Readonly
feature_name	Feature defining this event Feature defining this Event, e.g. manager_health, certificates.	string	Required Readonly
id	Identifier to identify an event_type uniquely Unique identifier in the form of feature_name.event_type.	string	Required Readonly
is_disabled	Indicate if event sampling is disabled Flag to indicate whether sampling for this Event is off or on.	boolean	Default: "False"
is_sensitivity_fixed	Flag to indicate if sensitivity can be configured Indicates if the sensitivity property is configurable via the API.	boolean	Readonly
is_threshold_fixed	Flag to indicate if threshold can be configured Indicates if the threshold property is configurable via the API.	boolean	Readonly
is_threshold_floating_point	Indicates if the threshold for this Event is a floating point value. 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.	boolean	Readonly
kb_article	Link to knowledge base article KB article link that contains more information on this event and recommended actions. Users can refer to the specified link if needed.	string	Readonly
max_threshold	Maximum allowed integer threshold value Maximum allowed threshold value if the threshold is configurable and a maximum value is applicable.	integer	Readonly
max_threshold_floating_point	Maximum allowed floating point threshold value Maximum allowed floating point threshold value if the threshold_floating_point is configurable and a maximum value is applicable.	number	Readonly
min_threshold	Minimum allowed integer point threshold value Minimum allowed threshold value if the threshold is configurable and a minimum value is applicable.	integer	Readonly
min_threshold_floating_point	Minimum allowed floating point threshold value Minimum allowed floating point threshold value if the threshold_floating_point is configurable and a minimum value is applicable.	number	Readonly
node_types	Array identifying the nodes on which this Event 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.	array of MonitoringNodeType	Required Readonly
recommended_action	Recommended action steps Recommended action for the alarm condition.	string	Readonly
resource_type	Must be set to the value MonitoringEvent	string
sensitivity	Percentage of samples to consider 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.	integer	Required Minimum: 0 Maximum: 100
severity	Severity of the Event Severity of the Event.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.	MonitoringSeverity	Required Readonly
summary	Summary description of Event Summary description of the event.	string	Readonly
suppress_alarm	Flag to suppress Alarm generation Flag to suppress Alarm generation. Alarms are not generated for this Event when this is set to True.	boolean	Default: "False"
suppress_snmp_trap	Flag to suppress SNMP trap generation Flag to suppress SNMP trap generation. SNMP traps are not sent for this Event when this is set to True.	boolean	Default: "False"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
threshold	Threshold to determine if a single sample is 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.	integer	Required
threshold_floating_point	Floating point threshold to determine if a single sample is True 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.	number
threshold_unit_type	Identifies the unit type of the threshold value Identifies the unit type of the threshold value.	string	Readonly Enum: DAYS, PERCENT, SECONDS
visibility	Visiblity of alarm 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.	string	Enum: TENANT_NONE, TENANT_READ
visibility_paths	Paths to enable visibility of TENANT_READ alarms 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.	array of string

Example Request:

PUT /api/v1/events/manager_health.manager_cpu_usage_high { "feature_name": "manager_health", "event_type": "manager_cpu_usage_high", "feature_display_name": "Manager Health", "event_type_display_name": "CPU Usage High", "id": "manager_health.manager_cpu_usage_high", "node_types": [ "NSX_MANAGER" ], "description": | "The CPU usage for the manager node identified by <entity-id> appears to be\nrising.", "description_on_clear": | "The CPU usage for the manager node identified by <entity-id> is no longer\nrising.", "recommended_action": | "Use the top command to check which processes have the most CPU usages, and\nthen check \/var\/log\/syslog and these processes' local logs to see if there\nare any outstanding errors to be resolved.", "severity": "WARNING", "event_true_snmp_oid": "1.3.6.1.4.1.6876.120.1.0.1.0.1", "event_false_snmp_oid": "1.3.6.1.4.1.6876.120.1.0.1.0.2", "is_threshold_fixed": false, "is_disabled": false, "threshold": 90, "sensitivity": 90, "suppress_alarm": false, "suppress_snmp_trap": false, "entity_resource_type": "ClusterNodeConfig", }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MonitoringEvent+

MonitoringEvent (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Detailed description of Event Detailed description of the event.	string	Readonly
description_on_clear	Description of event when cleared Description of Event when an Event instance transitions from True to False.	string	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
entity_resource_type	Resource Type of entity where this event is applicable Resource Type of entity where this event is applicable eg. LogicalSwitch, LogicalPort etc.	string	Readonly
event_false_snmp_oid	OID for SNMP trap sent when Event instance is False 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.	string	Readonly
event_tags	Tags applicable to this event Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.	array of string	Readonly
event_true_snmp_oid	OID for SNMP trap sent when Event instance is True Optional field containing OID for SNMP trap sent when Event instance is True. This value is null if suppress_snmp_trap is True.	string	Readonly
event_type	Name of event type Name of Event, e.g. manager_cpu_usage_high, certificate_expired.	string	Required Readonly
event_type_display_name	Display name of event type Display name of Event type.	string	Required Readonly
feature_display_name	Display name of feature Display name of feature defining this Event.	string	Required Readonly
feature_name	Feature defining this event Feature defining this Event, e.g. manager_health, certificates.	string	Required Readonly
id	Identifier to identify an event_type uniquely Unique identifier in the form of feature_name.event_type.	string	Required Readonly
is_disabled	Indicate if event sampling is disabled Flag to indicate whether sampling for this Event is off or on.	boolean	Default: "False"
is_sensitivity_fixed	Flag to indicate if sensitivity can be configured Indicates if the sensitivity property is configurable via the API.	boolean	Readonly
is_threshold_fixed	Flag to indicate if threshold can be configured Indicates if the threshold property is configurable via the API.	boolean	Readonly
is_threshold_floating_point	Indicates if the threshold for this Event is a floating point value. 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.	boolean	Readonly
kb_article	Link to knowledge base article KB article link that contains more information on this event and recommended actions. Users can refer to the specified link if needed.	string	Readonly
max_threshold	Maximum allowed integer threshold value Maximum allowed threshold value if the threshold is configurable and a maximum value is applicable.	integer	Readonly
max_threshold_floating_point	Maximum allowed floating point threshold value Maximum allowed floating point threshold value if the threshold_floating_point is configurable and a maximum value is applicable.	number	Readonly
min_threshold	Minimum allowed integer point threshold value Minimum allowed threshold value if the threshold is configurable and a minimum value is applicable.	integer	Readonly
min_threshold_floating_point	Minimum allowed floating point threshold value Minimum allowed floating point threshold value if the threshold_floating_point is configurable and a minimum value is applicable.	number	Readonly
node_types	Array identifying the nodes on which this Event 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.	array of MonitoringNodeType	Required Readonly
recommended_action	Recommended action steps Recommended action for the alarm condition.	string	Readonly
resource_type	Must be set to the value MonitoringEvent	string
sensitivity	Percentage of samples to consider 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.	integer	Required Minimum: 0 Maximum: 100
severity	Severity of the Event Severity of the Event.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.	MonitoringSeverity	Required Readonly
summary	Summary description of Event Summary description of the event.	string	Readonly
suppress_alarm	Flag to suppress Alarm generation Flag to suppress Alarm generation. Alarms are not generated for this Event when this is set to True.	boolean	Default: "False"
suppress_snmp_trap	Flag to suppress SNMP trap generation Flag to suppress SNMP trap generation. SNMP traps are not sent for this Event when this is set to True.	boolean	Default: "False"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
threshold	Threshold to determine if a single sample is 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.	integer	Required
threshold_floating_point	Floating point threshold to determine if a single sample is True 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.	number
threshold_unit_type	Identifies the unit type of the threshold value Identifies the unit type of the threshold value.	string	Readonly Enum: DAYS, PERCENT, SECONDS
visibility	Visiblity of alarm 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.	string	Enum: TENANT_NONE, TENANT_READ
visibility_paths	Paths to enable visibility of TENANT_READ alarms 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.	array of string

Example Response:

{ "feature_name": "manager_health", "event_type": "manager_cpu_usage_high", "feature_display_name": "Manager Health", "event_type_display_name": "CPU Usage High", "id": "manager_health.manager_cpu_usage_high", "node_types": [ "NSX_MANAGER" ], "description": | "The CPU usage for the manager node identified by <entity-id> appears to be\nrising.", "description_on_clear": | "The CPU usage for the manager node identified by <entity-id> is no longer\nrising.", "recommended_action": | "Use the top command to check which processes have the most CPU usages, and\nthen check \/var\/log\/syslog and these processes' local logs to see if there\nare any outstanding errors to be resolved.", "severity": "WARNING", "event_true_snmp_oid": "1.3.6.1.4.1.6876.120.1.0.1.0.1", "event_false_snmp_oid": "1.3.6.1.4.1.6876.120.1.0.1.0.2", "is_threshold_fixed": false, "is_disabled": false, "threshold": 90, "sensitivity": 90, "suppress_alarm": false, "suppress_snmp_trap": false, "entity_resource_type": "ClusterNodeConfig", }

Required Permissions:

crud

Feature:

system_alarm_definitions

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable