Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

snmptrap_binding

August 17, 2023
Contributed by: 
C

Binding object which returns the resources bound to snmptrap.

Properties

(click to see Operations )

Name Data Type Permissions Description
trapclass Read-write Trap type specified in the trap listener entry.

Possible values = generic, specific
trapdestination Read-write IP address specified in the trap listener entry.

Minimum length = 1
version Read-write The SNMP version of the trap specified in the trap listener entry.

Possible values = V1, V2, V3
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
snmptrap_snmpuser_binding <snmptrap_snmpuser_binding[]> Read-only snmpuser that can be bound to snmptrap.

Operations

(click to see Properties )

  • GET (BY ARGS)
  • GET (ALL)

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

get

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

args

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

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

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_binding": [ {
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "trapclass":<String_value>,
      "snmptrap_snmpuser_binding":<snmptrap_snmpuser_binding[]_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmptrap_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_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_binding": [ {
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "trapclass":<String_value>,
      "snmptrap_snmpuser_binding":<snmptrap_snmpuser_binding[]_value>
}]}

<!--NeedCopy-->
snmptrap_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.