Download full document:

snmpmanager

Configuration for manager resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
ipaddress	<String>	Read-write	IP address of the SNMP manager. Can be an IPv4 or IPv6 address. You can instead specify an IPv4 network address or IPv6 network prefix if you want the NetScaler appliance to respond to SNMP queries from any device on the specified network. Alternatively, instead of an IPv4 address, you can specify a host name that has been assigned to an SNMP manager. If you do so, you must add a DNS name server that resolves the host name of the SNMP manager to its IP address. Note: The NetScaler appliance does not support host names for SNMP managers that have IPv6 addresses.<br>Minimum length = 1<br>Maximum length = 255
netmask	<String>	Read-write	Subnet mask associated with an IPv4 network address. If the IP address specifies the address or host name of a specific host, accept the default value of 255.255.255.255.
domainresolveretry	<Integer>	Read-write	Amount of time, in seconds, for which the NetScaler appliance waits before sending another DNS query to resolve the host name of the SNMP manager if the last query failed. This parameter is valid for host-name based SNMP managers only. After a query succeeds, the TTL determines the wait time.<br>Minimum value = 5<br>Maximum value = 20939
ip	<String>	Read-only	The resolved IP address of the hostname manager.
domain	<String>	Read-only	IP address of manager. It will be zero for hostname manager.
__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>

Note:

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

add

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

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"snmpmanager":{
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "domainresolveretry":<Integer_value>,
}}

Response Payload:

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

delete

URL: http://<NSIP>/nitro/v1/config/snmpmanager/ipaddress_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/snmpmanager/ipaddress_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

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

update

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

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"snmpmanager":{
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "domainresolveretry":<Integer_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",
"snmpmanager":{
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "domainresolveretry":true,
}}

Response Payload:

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

get (all)

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

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/snmpmanager?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<NS_IP>/nitro/v1/config/snmpmanager?view=summary

Use this query-parameter to get the summary output of snmpmanager resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/snmpmanager?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/snmpmanager?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "snmpmanager": [ {
      "ipaddress":<String_value>,
                  "netmask":<String_value>,
      "ip":<String_value>,
      "domain":<String_value>,
      "domainresolveretry":<Integer_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/snmpmanager?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",snmpmanager: [ { "__count": "#no"} ] }