GetSnmpInfo
Suggest changes
PDFs
You can use the GetSnmpInfo method to get the current simple network management protocol (SNMP) configuration information.
Parameters
|
GetSnmpInfo is deprecated for versions later than Element version 8.0. The GetSnmpState and SetSnmpACL methods replace the GetSnmpInfo method. |
This method has no input parameters.
Return values
This method has the following return values:
| Name | Description | Type |
|---|---|---|
networks |
List of networks and access types enabled for SNMP. Note: networks is only displayed if SNMP v3 is disabled. |
|
enabled |
Indicates if the nodes in the cluster are configured for SNMP. Possible values:
|
boolean |
snmpV3Enabled |
If the node in the cluster is configured for SNMP v3. Possible values:
|
boolean |
usmUsers |
If SNMP v3 is enabled, a list of user access parameters for SNMP is returned from the cluster. This is returned instead of the networks parameter. |
Request example
Requests for this method are similar to the following example:
{
"method": "GetSnmpInfo",
"params": {},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"id" : 1,
"result" : {
"enabled" : true,
"networks" : [
{
"access" : "rosys",
"cidr" : 0,
"community" : "public",
"network" : "localhost"
}
]
}
}
New since version
9.6