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

Delete an SNMP user

Contributors
PDFs

DELETE /support/snmp/users/{engine_id}/{name}

Introduced In: 9.7

Deletes an SNMP user. The engine ID can be the engine ID of the administrative SVM or a data SVM. It can also be the SNMPv3 engine ID of a remote switch.

  • security login delete

  • system snmp community delete

Learn more

Parameters

Name Type In Required Description

engine_id

string

path

True

Engine ID of owning SVM or remote switch.

name

string

path

True

SNMP user name.

fields

array[string]

query

False

Specify the fields to return.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621475

This operation is not allowed on a node SVM.

2621699

This operation is not allowed on a system SVM.

5636123

Cannot create an SNMP user with a role other than readonly, none, or admin.

5636124

Cannot create an SNMP user with a role other than vsadmin-readonly, none, or vsadmin.

5832712

Cannot modify attributes for user "diag."

7077906

Cannot use given role with this SVM because a role with that name has not been defined for the SVM.

9043999

ONTAP failed to create an SNMPv3 user because SNMPv3 is disabled in the cluster.

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

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.