Product Documentation

snmptrap

Sep 07, 2016

Configuration for snmp trap resource.

Properties (click to see Operations)

Name Data Type Permissions Description
trapclass
<String>
Read-write
Type of trap messages that the NetScaler appliance sends to the trap listener: Generic or the enterprise-specific messages defined in the MIB file.
Possible values = generic, specific
trapdestination
<String>
Read-write
IPv4 or the IPv6 address of the trap listener to which the NetScaler appliance is to send SNMP trap messages.
Minimum length = 1
version
<String>
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: V2
Possible values = V1, V2, V3
td
<Double>
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
destport
<Integer>
Read-write
UDP port at which the trap listener listens for trap messages. This setting must match the setting on the trap listener. Otherwise, the listener drops the trap messages.
Default value: 162
Minimum value = 1
Maximum value = 65534
communityname
<String>
Read-write
Password (string) sent with the trap messages, so that the trap listener can authenticate them. Can include 1 to 31 uppercase or lowercase letters, numbers, and hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore (_) characters.
You must specify the same community string on the trap listener device. Otherwise, the trap listener drops the trap messages.

The following requirement applies only to the NetScaler CLI:
If the string includes one or more spaces, enclose the name in double or single quotation marks (for example, "my string" or 'my string').
srcip
<String>
Read-write
IPv4 or IPv6 address that the NetScaler appliance inserts as the source IP address in all SNMP trap messages that it sends to this trap listener. By default this is the appliance's NSIP or NSIP6 address, but you can specify an IPv4 MIP or SNIP address or a SNIP6 address.
Minimum length = 1
severity
<String>
Read-write
Severity level at or above which the NetScaler appliance sends trap messages to this trap listener. The severity levels, in increasing order of severity, are Informational, Warning, Minor, Major, Critical. This parameter can be set for trap listeners of type SPECIFIC only. The default is to send all levels of trap messages.
Important: Trap messages are not assigned severity levels unless you specify severity levels when configuring SNMP alarms.
Default value: Unknown
Possible values = Critical, Major, Minor, Warning, Informational
allpartitions
<String>
Read-write
Send traps of all partitions to this destination.
Default value: DISABLED
Possible values = ENABLED, DISABLED
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"snmptrap":{
      "trapclass":<String_value>,
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "destport":<Integer_value>,
      "communityname":<String_value>,
      "srcip":<String_value>,
      "severity":<String_value>,
      "allpartitions":<String_value>
}}

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/trapclass_value<String>

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"snmptrap":{
      "trapclass":<String_value>,
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "destport":<Integer_value>,
      "communityname":<String_value>,
      "srcip":<String_value>,
      "severity":<String_value>,
      "allpartitions":<String_value>
}}

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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/snmptrap?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"snmptrap":{
      "trapclass":<String_value>,
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "destport":true,
      "communityname":true,
      "srcip":true,
      "severity":true,
      "allpartitions":true
}}

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 (all)

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/snmptrap?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/snmptrap?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<netscaler-ip-address>/nitro/v1/config/snmptrap?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

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

Use this query-parameter to get the snmptrap 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 Headers:

Content-Type:application/json

Response Payload:

{ "snmptrap": [ {
      "trapclass":<String_value>,
      "trapdestination":<String_value>,
      "version":<String_value>,
      "td":<Double_value>,
      "destport":<Integer_value>,
      "communityname":<String_value>,
      "srcip":<String_value>,
      "severity":<String_value>,
      "allpartitions":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/snmptrap?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 Headers:

Content-Type:application/json

Response Payload:

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