ADC NITRO APIs

snmptrap_snmpuser_binding

August 17, 2023

Contributed by:

Binding object showing the snmpuser that can be bound to snmptrap.

Properties

(click to see Operations )

Name	Permissions	Description
trapclass	Read-write	Type of trap messages that the Citrix ADC sends to the trap listener: Generic or the enterprise-specific messages defined in the MIB file. Possible values = generic, specific
securitylevel	Read-write	Security level of the SNMPv3 trap. Default value: authNoPriv, Possible values = noAuthNoPriv, authNoPriv, authPriv
username	Read-write	Name of the SNMP user that will send the SNMPv3 traps.
td	Read-write	Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value = 0 Maximum value = 4094
trapdestination	Read-write	IPv4 or the IPv6 address of the trap listener to which the Citrix ADC is to send SNMP trap messages. Minimum length = 1
version	Read-write	SNMP version, which determines the format of trap messages sent to the trap listener. This setting must match the setting on the trap listener. Otherwise, the listener drops the trap messages. Default value: V3 Possible values = V1, V2, V3
__count	Read-write	count parameter

Operations

(click to see Properties )

GET
GET (ALL)
COUNT
ADD
DELETE

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:*

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address /nitro/v1/config/snmptrap_snmpuser_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"snmptrap_snmpuser_binding":{
<b>      "trapclass":<String_value>,
</b><b>      "trapdestination":<String_value>,
</b>      "td":<Double_value>,
      "version":<String_value>,
<b>      "username":<String_value>,
</b>      "securitylevel":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding/ trapclass_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding/ trapclass_value<String> ? args= trapdestination:<String_value>, td: <Double_value> ,version: <String_value> , username:<String_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding? args=trapdestination:<String_value>,version:<String_value>,td:<Double_value>,trapclass:<String_value>

Use this query-parameter to get snmptrap_snmpuser_binding resources based on additional properties.

filter

http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding? filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of snmptrap_snmpuser_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagination

http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding? pagesize=#no;pageno=#no

Use this query-parameter to get the snmptrap_snmpuser_binding resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "snmptrap_snmpuser_binding": [ {
      "trapclass":<String_value>,
      "securitylevel":<String_value>,
      "username":<String_value>,
      "td":<Double_value>,
      "trapdestination":<String_value>,
      "version":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "snmptrap_snmpuser_binding": [ {
      "trapclass":<String_value>,
      "securitylevel":<String_value>,
      "username":<String_value>,
      "td":<Double_value>,
      "trapdestination":<String_value>,
      "version":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_snmpuser_binding? args=trapdestination:<String_value>,version:<String_value>,td:<Double_value>,trapclass:<String_value>;count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "snmptrap_snmpuser_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

snmptrap_snmpuser_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

snmptrap_snmpuser_binding

Properties

Operations

add

delete

get

get (all)

count

In this article