Skip to main content
A newer release of this product is available.

Update 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 and enabling or disabling authentication traps.

  • options snmp.enable

  • system snmp authtrap

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

self_link

auth_traps_enabled

boolean

Specifies whether to enable or disable SNMP authentication traps.

enabled

boolean

Specifies whether to enable or disable SNMP.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "auth_traps_enabled": 1,
  "enabled": 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.
Name Type Description

error

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.

enabled

boolean

Specifies whether to enable or disable SNMP.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.