Perform an event management action
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /private/manage/event-remediations/{id}
Introduced In: 9.8
Perform an event management action.
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
id |
integer |
path |
True |
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.
|
Request Body
Name | Type | Description |
---|---|---|
cluster |
||
completion_time |
string |
Completion time of the event |
description |
string |
Description for the event |
event_remediation_action |
string |
Event remediation action |
event_remediation_action_type |
string |
Type of remediation action |
event_remediation_state |
string |
State of the event remediation |
event_type_name |
string |
Type of the event |
id |
integer |
Event Identifier |
solution |
string |
Corrective action for the event |
source |
||
source_full_name |
string |
Source of the event |
source_resource_type |
string |
Type of source of the event |
start_time |
string |
Start time of the event |
Example request
{
"cluster": {
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"completion_time": "string",
"description": "Disable Telnet",
"event_remediation_action": "string",
"event_remediation_action_type": "string",
"event_remediation_state": "string",
"event_type_name": "cluster_telnet_enabled",
"id": "198",
"solution": "Continue to disable telnet on the selected cluster using the 'security protocol modify -application telnet -enabled false’ ontap cli command.",
"source": {
"object_id": "5666",
"object_type": "inventory.ontap.fas.Cluster"
},
"source_full_name": "shrey-vsim1",
"source_resource_type": "cluster",
"start_time": "string"
}
Response
Status: 202, Accepted
Name | Type | Description |
---|---|---|
job |
Example response
{
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
}
}
Error
Status: Default, Ontap error response codes
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
cluster
Name | Type | Description |
---|---|---|
name |
string |
|
uuid |
string |
source
Name | Type | Description |
---|---|---|
object_id |
integer |
|
object_type |
string |
event_remediations
Name | Type | Description |
---|---|---|
cluster |
||
completion_time |
string |
Completion time of the event |
description |
string |
Description for the event |
event_remediation_action |
string |
Event remediation action |
event_remediation_action_type |
string |
Type of remediation action |
event_remediation_state |
string |
State of the event remediation |
event_type_name |
string |
Type of the event |
id |
integer |
Event Identifier |
solution |
string |
Corrective action for the event |
source |
||
source_full_name |
string |
Source of the event |
source_resource_type |
string |
Type of source of the event |
start_time |
string |
Start time of the event |
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
job_link
Name | Type | Description |
---|---|---|
_links |
||
uuid |
string |
The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |