snmp-server SNMPv3 user

Define a user who can access the SNMP engine

user Specification

Parameter	Value
Type	Collection
Object Key(s)	username
Collection Name	user-list
Collection URI	/axapi/v3/snmp-server/SNMPv3/user
Element Name	user
Element URI	/axapi/v3/snmp-server/SNMPv3/user/{username}
Element Attributes	user_attributes
Partition Visibility	shared
Schema	user schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/snmp-server/SNMPv3/user	user attributes	example close
POST /axapi/v3/snmp-server/SNMPv3/user/ Payload: { "user": { "username": "a", "auth-val": "md5", "v3": "auth", "group": "a", "passwd": "abcdefgh", "priv": "des", "encpasswd": "abcdefgh" } }
Create List	POST	/axapi/v3/snmp-server/SNMPv3/user	user attributes
Get Object	GET	/axapi/v3/snmp-server/SNMPv3/user/{username}	user attributes	example close
GET /axapi/v3/snmp-server/SNMPv3/user/a Reponse: { "user": { "username": "a", "group": "a", "v3": "auth", "auth-val": "md5", "pw-encrypted": "sNydJS31jb+HCf9d5I0bBYcDnIzKSYXAn6gmMbB+7HmaqfQDAUEhIlEZqC/skw30", "priv": "des", "priv-pw-encrypted": "sNydJS31jb+HCf9d5I0bBYcDnIzKSYXAn6gmMbB+7HmaqfQDAUEhIlEZqC/skw30", "uuid": "1a8f14ac-5f06-11d9-a8af-5789df998b41", "a10-url": "/axapi/v3/snmp-server/SNMPv3/user/a" } }
Get List	GET	/axapi/v3/snmp-server/SNMPv3/user	user-list
Modify Object	POST	/axapi/v3/snmp-server/SNMPv3/user/{username}	user attributes
Replace Object	PUT	/axapi/v3/snmp-server/SNMPv3/user/{username}	user attributes	example close
PUT /axapi/v3/snmp-server/SNMPv3/user/a Payload: { "user": { "username": "a", "v3": "noauth", "group": "abcd" } }
Replace List	PUT	/axapi/v3/snmp-server/SNMPv3/user	user-list
Delete Object	DELETE	/axapi/v3/snmp-server/SNMPv3/user/{username}	user attributes	example close
DELETE /axapi/v3/snmp-server/SNMPv3/user/a Reponse: { "response": { "status": "OK" } }

user-list

user-list is JSON List of user attributes

user-list : [

{ user attributes },

{ user attributes },

…

]

user attributes

auth-val

Description ‘md5’: Use HMAC MD5 algorithm for authentication; ‘sha’: Use HMAC SHA algorithm for authentication;

Type: string

Supported Values: md5, sha

encpasswd

Description Passphrase for encryption

Type: string

Format: password

Maximum Length: 31 characters

Maximum Length: 8 characters

group

Description Group to which the user belongs

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

passwd

Description Password of this user

Type: string

Format: password

Maximum Length: 31 characters

Maximum Length: 8 characters

priv

Description ‘des’: DES encryption alogrithm; ‘aes’: AES encryption alogrithm; (Encryption type)

Type: string

Supported Values: des, aes

priv-pw-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string)

pw-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED passphrase string)

username

Description Name of the user

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

v3

Description ‘auth’: Using the authNoPriv Security Level; ‘noauth’: Using the noAuthNoPriv Security Level;

Type: string

Supported Values: auth, noauth