Specifies user account information for use with SNMPv3.

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/sys/snmp/users/~resource id
Resource Methods
Resource Natural Key


Name Type Default Value Required Access Description
access string   optional read/write User’s access level (read-only or read-write).
authPassword string   optional read/write Password used to authenticate user. This is clear text and it will not be displayed.
authPasswordEncrypted string   optional read/write Encrypted password used to authenticate user.
authProtocol string   required read/write Protocol used to authenticate user.
description string   optional read/write User defined description.
oidSubset string   optional read/write Limits this user to a portion of the OID tree.
privacyPassword string   optional read/write Specifies the password used to encrypt traffic. This is the clear text and it will not be displayed.
privacyPasswordEncrypted string   optional read/write Specifies the encrypted password used to encrypt traffic.
privacyProtocol string   required read/write Specifies the protocol used to encrypt traffic.
securityLevel string   optional read/write Specifies whether or not traffic is encrypted and whether or not authentication is required.
username string   required read/write The SNMPv3 user name.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.