snmp-server SNMPv3 user

Define a user who can access the SNMP engine.

user Specification

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
Schema user schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/snmp-server/SNMPv3/user/

user Attributes

Create List

POST

/axapi/v3/snmp-server/SNMPv3/user/

user Attributes

Get Object

GET

/axapi/v3/snmp-server/SNMPv3/user/{username}

user Attributes

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

Replace List

PUT

/axapi/v3/snmp-server/SNMPv3/user/

user-list

Delete Object

DELETE

/axapi/v3/snmp-server/SNMPv3/user/{username}

user Attributes

user-list

user-list is JSON List of user Attributes

user-list : [

user Attributes

auth-val

Description: Specifies the encryption method to use for user authentication. For use with v3:auth.

  • md5 : Uses Message Digest Algorithm 5 (MD5) encryption.
  • sha : Uses Security Hash Algorithm (SHA) encryption.

Type: string

Supported Values: md5, sha

encpasswd

Description: Password for message encryption and privacy.

Type: string

Format: password

group

Description: Group to which the SNMP user belongs.

Type: string

passwd

Description: Password for user authentication.

Type: string

Format: password

priv

Description: Specifies the encryption method to use for user privacy.

  • des : Uses Data Encryption Standard (DES) algorithm to apply a 56-bit key to each 64-bit block of data. This is considered strong encryption.
  • aes : Uses Advanced Encryption Standard (AES) algorithm. This uses a fixed block size of 128 bits, and has a key size of 128, 192, or 256 bits. AES encryption supersedes DES encryption.

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: SNMP user name.

Type: string

Format: string-rlx

Required: Yes

uuid

Description: uuid of the object

Type: string

v3

Description: Message encryption or authentication level.

  • auth : Using the authNoPriv security level.
  • noauth : Using the noAuthNoPriv security level. Does not use message authentication or encryption, so you will not configure protocols and keys.

Type: string

Supported Values: auth, noauth