Product Documentation

snmp_view

Oct 21, 2015

View Names

Properties

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

SNMP View Subtree

Maximum length = 256

Valid char set = ^[.0-9]+

name
<String>
No

View Name

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

include
<Boolean>
No

View Type

Possible values = [true, false]

Operations

Hinweis

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

ADD

Use this operation to add a SNMP View entry

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"snmp_view":{
"subtree": <string_value>,
"name": <string_value>,
"include": <boolean_value>
}}

Response Headers:

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

Response Payload: JSON

{"snmp_view":{
"subtree": <string_value>,
"name": <string_value>,
"include": <boolean_value>
}}

DELETE

Use this operation to delete a SNMP View entry

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_view/subtree=<STRING>,name=<STRING>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get SNMP View entries

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_view": [{
"subtree": <string_value>,
"name": <string_value>,
"include": <boolean_value>
}, ...]}

GET

Use this operation to get SNMP View entries

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_view/subtree=<STRING>,name=<STRING>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_view":{
"subtree": <string_value>,
"name": <string_value>,
"include": <boolean_value>
}}