Skip to main content

Update the cluster-wide SNMP configuration

Contributors
PDFs

PATCH /support/snmp

Introduced In: 9.7

Updates the cluster wide SNMP configuration, such as:

  • enabling or disabling SNMP

  • enabling or disabling SNMP traps

  • enabling or disabling authentication traps

  • setting the contact and location information for the SNMP server

  • triggering an SNMP test trap

  • options snmp.enable

  • system snmp authtrap

  • system snmp init

Learn more

Request Body

Name Type Description

_links

self_link

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 request 
{
  "_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
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1179738

Cluster identification not available for modification since a cluster has not been created.

1179739

Cluster identification modification is not available in maintenance mode or other boot modes.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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
Name Type Description

self

href

snmp

Cluster-wide SNMP configuration.

Name Type Description

_links

self_link

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.

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.