/system/snmpv3_users/{SNMPv3_User.user_name}

patch

https://switch-ip/rest/v10.16/system/snmpv3_users/{SNMPv3_User.user_name}

Path Params

SNMPv3_User.user_name

string

required

Reference Resource: SNMPv3_User
User name that should contain alphanumeric characters.

Body Params

access_level

string

enum

ro - read-only access for snmpv3 user. rw - read-write access for snmpv3 user.

Allowed:

auth_pass_phrase

string

length between 8 and 193

The key to be used by authentication protocol. This column value can be empty. If not configured, no authentication pass-phrase is associated with the SNMP v3 user.

auth_protocol

string

enum

The authentication protocol to be used for authenticating the user. Users without authentication will be disabled when system snmp_security_level is authPriv or authNoPriv.

Allowed:

priv_pass_phrase

string

length between 8 and 193

The key to be used by privacy protocol. This column value can be empty. If not configured, no privacy pass-phrase is associated with the SNMP v3 user.

priv_protocol

string

enum

The privacy protocol to be used for encrypting the user requests. Users without privacy protocol will be disabled when system snmp_security_level is authPriv

Allowed:

remote_engine_id

string

The SNMPv3 remote engine id in a colon separated hexadecimal notation. Example 80:00:00:09:05:01:04:03:21. This column value can be empty. This column is not in use.

snmp_view

string

Reference Resource: SNMP_View
SNMP view associated with a user. This column value can be empty. If not configured, no SNMP view is associated the user.

snmpv3_contexts

array of strings

length ≤ 33

Reference Resource: SNMPv3_Context
SNMPv3 contexts to be associated with the user, limited to 1 context per VRF.

snmpv3_contexts

user_name

string

required

length between 1 and 32

Reference Resource: SNMPv3_User
User name that should contain alphanumeric characters.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!