SetSnmpInfo

You can use the SetSnmpInfo method to configure SNMP version 2 and version 3 on cluster nodes. The values you set with this interface apply to all nodes in the cluster, and the values that are passed replace all values set in any previous call to SetSnmpInfo.

Parameters

Note: SetSnmpInfo is deprecated for Element versions 6.0 and later. Use the EnableSnmp and SetSnmpACL methods instead.

This method has the following input parameters:

Name Description Type Default value Required
networks List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See the SNMP network object for possible values. This parameter is required for SNMP v2 only. network array None No
enabled If set to true, SNMP is enabled on each node in the cluster. boolean false No
snmpV3Enabled If set to true, SNMP v3 is enabled on each node in the cluster. boolean false No
usmUsers If SNMP v3 is enabled, this value must be passed in place of the networks parameter. This parameter is required for SNMP v3 only. usmUser None No

Return values

This method has no return values.

Request example with SNMP v3 enabled

Requests for this method are similar to the following example:

{
"method":"SetSnmpInfo",
"params":{
    "enabled":true,
    "snmpV3Enabled":true,
    "usmUsers":[
      {
        "name":"user1",
        "access":"rouser",
        "secLevel":"auth",
        "password":"namex1",
        "passphrase":"yourpassphrase"
      }
    ]
  },
 "id":1
}

Request example with SNMP v2 enabled

Requests for this method are similar to the following example:

{
"method":"SetSnmpInfo",
"params":{
    "enabled":true,
    "snmpV3Enabled":false,
    "networks":[
      {
        "community":"public",
        "access":"ro",
        "network":"localhost",
      }
    ]
  },
  "id":1
}

Response example

This method returns a response similar to the following example:

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