Skip to content

Latest commit

 

History

History
88 lines (73 loc) · 2.49 KB

reference_element_api_setsnmptrapinfo.adoc

File metadata and controls

88 lines (73 loc) · 2.49 KB
Raw
permalink sidebar keywords summary
api/reference_element_api_setsnmptrapinfo.html
sidebar
snmp,trap,information,info,setting,set,setsnmptrapinfo
You can use the SetSnmpTrapInfo method to enable and disable the generation of cluster SNMP notifications \(traps\) and to specify the set of hosts that receive the notifications. The values you pass with each SetSnmpTrapInfo method call replace all values set in any previous call.

SetSnmpTrapInfo

You can use the SetSnmpTrapInfo method to enable and disable the generation of cluster SNMP notifications (traps) and to specify the set of hosts that receive the notifications. The values you pass with each SetSnmpTrapInfo method call replace all values set in any previous call.

Parameters

This method has the following input parameters:

Name Description Type

trapRecipients

List of hosts that are to receive the traps generated by the storage cluster. At least one object is required if any one of the trap types is enabled. This parameter is required only if any boolean parameters are set to true. (No default value. Not required.)

clusterFaultTrapsEnabled

If set to true, a corresponding cluster fault notification is sent to the configured list of trap recipients when a cluster fault is logged. (Default value: false. Not required.)

boolean

clusterFaultResolvedTrapsEnabled

If set to true, a corresponding cluster fault resolved notification is sent to the configured list of trap recipients when a cluster fault is resolved. (Default value: false. Not required.)

boolean

clusterEventTrapsEnabled

If set to true, a corresponding cluster event notification is sent to the configured list of trap recipients when a cluster event is logged. (Default value: false. Not required.)

boolean

Return values

This method has no return values.

Request example

Requests for this method are similar to the following example:

{
"method":"SetSnmpTrapInfo",
"params":{
    "clusterFaultTrapsEnabled":true,
    "clusterFaultResolvedTrapsEnabled":true,
    "clusterEventTrapsEnabled":true,
    "trapRecipients":[
    {
      "host":"192.30.0.10",
      "port":162,
      "community":"public"
    }
   ]
  },
  "id":1
}

Response example

This method returns a response similar to the following example:

{
    "id" : 1,
    "result" : {}
}

New since version

9.6