snmpuser : SNMP user object.

This object contains information related to SNMPv3 users.

Object Reference

References to snmpuser are object references.

Restrictions

The object does not support the following operations:

• Scheduling
• CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, name.

The following fields are required to create this object:

Field	Notes
authentication_password	See the field description for more information
authentication_protocol
name
privacy_password	See the field description for more information
privacy_protocol

authentication_password

authentication_password

Determines an authentication password for the user. This is a write-only attribute.

Type

String.

Create

Password for Authentication is required when Authentication protocol is set.

Search

The field is not available for search.

Notes

authentication_password is not readable.

authentication_protocol

authentication_protocol

The authentication protocol to be used for this user.

Type

String.

Valid values are:

• MD5
• NONE
• SHA

Create

The field is required on creation.

Search

The field is not available for search.

comment

comment

A descriptive comment for the SNMPv3 User.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The comment is part of the base object.

disable

disable

Determines if SNMPv3 user is disabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

name

name

The name of the user.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

privacy_password

privacy_password

Determines a password for the privacy protocol.

Type

String.

Create

Password for Privacy is required when Privacy protocol is set.

Search

The field is not available for search.

Notes

privacy_password is not readable.

privacy_protocol

privacy_protocol

The privacy protocol to be used for this user.

Type

String.

Valid values are:

• AES
• DES
• NONE

Create

The field is required on creation.

Search

The field is not available for search.

Fields List

Field	Type	Req	R/O	Base	Search
authentication_password	String	Y*	N	N	N/A
authentication_protocol	String	Y	N	N	N/A
comment	String	N	N	Y	: = ~
disable	Bool	N	N	N	N/A
extattrs	Extattr	N	N	N	ext
name	String	Y	N	Y	= ~
privacy_password	String	Y*	N	N	N/A
privacy_protocol	String	Y	N	N	N/A

* Required in some cases, see detailed field description above.