Product Documentation

snmp_manager

Oct 20, 2015

SNMP Manager Configuration

Properties

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

Community

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

snmpmanager
<String>
No

Ip Address of SNMP Manager. (IPv4/IPv6 string).

Bitmask = Required (format IP/bitmask)

Operations

注意

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

ADD

Use this operation to add a SNMP Management Community Entry

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"snmp_manager":{
"community": <string_value>,
"snmpmanager": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"snmp_manager":{
"community": <string_value>,
"snmpmanager": <string_value>
}}

DELETE

Use this operation to delete a SNMP Management Community Entry

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_manager/community=<STRINGX>,snmpmanager=<IPADDRESS>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get SNMP Management Communities

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_manager": [{
"community": <string_value>,
"snmpmanager": <string_value>
}, ...]}

GET

Use this operation to get SNMP Management Communities

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_manager/community=<STRINGX>,snmpmanager=<IPADDRESS>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_manager":{
"community": <string_value>,
"snmpmanager": <string_value>
}}