Retrieve the cluster-wide SNMP configuration
Retrieves the cluster-wide SNMP configuration to review or manage the SNMP settings across the entire cluster. This is useful for ensuring that the SNMP settings align with your network monitoring and management requirements.
HTTP method and endpoint
GET /support/snmp
Introduced in
ONTAP 9.7
Usage notes
Retrieves the cluster wide SNMP configuration.
Related ONTAP commands
-
options snmp.enable -
system snmp show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
auth_traps_enabled |
boolean |
Specifies whether to enable or disable SNMP authentication traps. |
contact |
string |
Specifies the contact person for the SNMP server |
enabled |
boolean |
Specifies whether to enable or disable SNMP. |
location |
string |
Specifies the location of the SNMP server |
traps_enabled |
boolean |
Specifies whether to enable or disable SNMP traps. |
trigger_test_trap |
boolean |
Trigger a test SNMP trap. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"auth_traps_enabled": 1,
"contact": "support@company.com",
"enabled": 1,
"location": "Building 1",
"traps_enabled": 1,
"trigger_test_trap": 1
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
self_link
| Name | Type | Description |
|---|---|---|
self |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |