Product Documentation

snmp_user

Oct 21, 2015

SNMP Users

Properties

Name Data Type Read-Only? Description
authprotocol
<String>
No

Authentication Protocol

Possible values = [SHA1, MD5]

viewname
<String>
No

View

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

username
<String>
No

User Name

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

authpassword
<String>
No

Authentication Password

Minimum length = 8

Maximum length = 31

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

privacyprotocol
<String>
No

Privacy Protocol

Possible values = [AES, DES]

privacypassword
<String>
No

Privacy Password

Minimum length = 8

Maximum length = 31

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

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

ADD

Use this operation to add a SNMP user entry

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_user

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.snmp_user+json

Request Payload: JSON

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

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.snmp_user+json

Response Payload: JSON

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

DELETE

Use this operation to delete a SNMP user entry

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_user/<username>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get SNMP user entries

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_user

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.snmp_user_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.snmp_user_list+json

Response Payload: JSON

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

GET

Use this operation to get SNMP user entries

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_user/<username>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.snmp_user+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.snmp_user+json

Response Payload: JSON

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