snmpoption

Last published : Oct 30, 2026
Configuration for SNMP option resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
snmpset <String> Read-write Accept SNMP SET requests sent to the Citrix ADC, and allow SNMP managers to write values to MIB objects that are configured for write access.
Default value: DISABLED
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.
Default value: DISABLED
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.
Default value: DISABLED
Possible values = ENABLED, DISABLED
snmptraplogginglevel <String> Read-write Audit log level of SNMP trap logs. The default value is INFORMATIONAL.
Default value: INFORMATIONAL
Possible values = EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG
severityinfointrap <String> Read-write By default, the severity level info of the trap is not mentioned in the trap message. Enable this option to send severity level of trap as one of the varbind in the trap message.
Default value: DISABLED
Possible values = ENABLED, DISABLED
customtrap <String> Read-write By default, Customtrap will be disabled, set to enabled when using the feature.
Default value: DISABLED
Possible values = ENABLED, DISABLED
_nextgenapiresource <String> Read-only .

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:// <netscaler-ip-address> /nitro/v1/config/snmpoption HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"snmpoption":{
"snmpset":<String_value>,
"snmptraplogging":<String_value>,
"partitionnameintrap":<String_value>,
"snmptraplogginglevel":<String_value>,
"severityinfointrap":<String_value>,
"customtrap":<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/snmpoption? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"snmpoption":{
"snmpset":true,
"snmptraplogging":true,
"partitionnameintrap":true,
"snmptraplogginglevel":true,
"severityinfointrap":true,
"customtrap":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/snmpoption 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:
{ "snmpoption": [ {
"snmpset":<String_value>,
"snmptraplogging":<String_value>,
"partitionnameintrap":<String_value>,
"snmptraplogginglevel":<String_value>,
"severityinfointrap":<String_value>,
"customtrap":<String_value>,
"_nextgenapiresource":<String_value>
}]}