Skip to content

snmp_user

Description

SNMP Users

Read/write properties

privacypassword<String>

Privacy Password. Minimum length = 8 Maximum length = 31 Valid char set = ^[-_.# =:@0-9a-zA-Z]+

viewname<String>

View. Valid char set = ^[-_.@0-9a-zA-Z]+

privacyprotocol<String>

Privacy Protocol. Possible values = [AES,DES]

authpassword<String>

Authentication Password. Minimum length = 8 Maximum length = 31 Valid char set = ^[-_.# =:@0-9a-zA-Z]+

authprotocol<String>

Authentication Protocol. Possible values = [SHA1,MD5]

username<String>

User Name. Valid char set = ^[-_.@0-9a-zA-Z]+

Read only properties

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

Add

URL: http://<CBIP>/cb/nitro/v1/config/snmp_user

HTTP Method: POST

Request Payload: JSON

{"snmp_user":{
      "privacypassword":<String_value>,
      "viewname":<String_value>,
      "privacyprotocol":<String_value>,
      "authpassword":<String_value>,
      "authprotocol":<String_value>,
      "username":<String_value>}}

Response Payload:JSON

{ "snmp_user":{
      "privacypassword":<String_value>,
      "viewname":<String_value>,
      "privacyprotocol":<String_value>,
      "authpassword":<String_value>,
      "authprotocol":<String_value>,
      "username":<String_value>}}

Delete

URL: http://<CBIP>/cb/nitro/v1/config/snmp_user/<username>

HTTP Method: DELETE

Response Payload: EMPTY

Get(all)

URL: http://<CBIP>/cb/nitro/v1/config/snmp_user

HTTP Method: GET

Response Payload: JSON

{ "snmp_user":[{
      "privacypassword":<String_value>,
      "viewname":<String_value>,
      "privacyprotocol":<String_value>,
      "authpassword":<String_value>,
      "authprotocol":<String_value>,
      "username":<String_value>}, ...]}

Get

URL:http://<CBIP>/cb/nitro/v1/config/snmp_user/<username>

HTTP Method: GET

Response Payload: JSON

json { "snmp_user":{ "privacypassword":<String_value>, "viewname":<String_value>, "privacyprotocol":<String_value>, "authpassword":<String_value>, "authprotocol":<String_value>, "username":<String_value>}}json