Download full document:

snmpoption

Configuration for SNMP option resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
snmpset	<String>	Read-write	Accept SNMP SET requests sent to the NetScaler appliance, and allow SNMP managers to write values to MIB objects that are configured for write access.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
snmptraplogging	<String>	Read-write	Log any SNMP trap events (for SNMP alarms in which logging is enabled) even if no trap listeners are configured. With the default setting, SNMP trap events are logged if at least one trap listener is configured on the appliance.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
partitionnameintrap	<String>	Read-write	Send partition name as a varbind in traps. By default the partition names are not sent as a varbind.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED

Operations

(click to see Properties)

UPDATE | UNSET | 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>.

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"snmpoption":{
      "snmpset":<String_value>,
      "snmptraplogging":<String_value>,
      "partitionnameintrap":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"snmpoption":{
      "snmpset":true,
      "snmptraplogging":true,
      "partitionnameintrap":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/snmpoption

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "snmpoption": [ {
      "snmpset":<String_value>,
      "snmptraplogging":<String_value>,
      "partitionnameintrap":<String_value>

}]}