Product Documentation

snmp_trap_dest

Oct 21, 2015

Properties

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

Authentication Protocol

Possible values = [SHA1, MD5]

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]+

trapdestip
<String>
No
trapdestport
<Integer>
No

Trap Destination Port

Minimum value = 1

Maximum value = 65535

privacyprotocol
<String>
No

Privacy Protocol

Possible values = [AES, DES]

community
<String>
No

Trap Community

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

privacypassword
<String>
No

Privacy Password

Minimum length = 8

Maximum length = 31

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

trapdestname
<String>
No

Trap Destination Name

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

snmpversion
<String>
No

Snmp Version

Possible values = [v1, v2c, v3]

traptype
<String>
No

Trap Type

Possible values = [trap, inform]

Operations

Hinweis

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

ADD

Use this operation to add a SNMP Trap Destination

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"snmp_trap_dest":{
"authprotocol": <string_value>,
"username": <string_value>,
"authpassword": <string_value>,
"trapdestip": <string_value>,
"trapdestport": <integer_value>,
"privacyprotocol": <string_value>,
"community": <string_value>,
"privacypassword": <string_value>,
"trapdestname": <string_value>,
"snmpversion": <string_value>,
"traptype": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"snmp_trap_dest":{
"authprotocol": <string_value>,
"username": <string_value>,
"authpassword": <string_value>,
"trapdestip": <string_value>,
"trapdestport": <integer_value>,
"privacyprotocol": <string_value>,
"community": <string_value>,
"privacypassword": <string_value>,
"trapdestname": <string_value>,
"snmpversion": <string_value>,
"traptype": <string_value>
}}

DELETE

Use this operation to delete a SNMP Trap Destination

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_trap_dest/<trapdestname>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get SNMP Trap Destinations

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_trap_dest": [{
"authprotocol": <string_value>,
"username": <string_value>,
"authpassword": <string_value>,
"trapdestip": <string_value>,
"trapdestport": <integer_value>,
"privacyprotocol": <string_value>,
"community": <string_value>,
"privacypassword": <string_value>,
"trapdestname": <string_value>,
"snmpversion": <string_value>,
"traptype": <string_value>
}, ...]}

GET

Use this operation to get SNMP Trap Destinations

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/snmp_trap_dest/<trapdestname>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"snmp_trap_dest":{
"authprotocol": <string_value>,
"username": <string_value>,
"authpassword": <string_value>,
"trapdestip": <string_value>,
"trapdestport": <integer_value>,
"privacyprotocol": <string_value>,
"community": <string_value>,
"privacypassword": <string_value>,
"trapdestname": <string_value>,
"snmpversion": <string_value>,
"traptype": <string_value>
}}