Product Documentation

snmpoid

Sep 07, 2016

Configuration for SNMP Object Identifier resource.

Properties (click to see Operations)

Name Data Type Permissions Description
entitytype
<String>
Read-write
The type of entity whose SNMP OIDs you want to displayType of entity whose SNMP OIDs you want the NetScaler appliance to display.
Possible values = VSERVER, SERVICE, SERVICEGROUP
name
<String>
Read-write
Name of the entity whose SNMP OID you want the NetScaler appliance to display.
Minimum length = 1
Snmpoid
<String>
Read-only
The snmp oid.
__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>.

get (all)

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/snmpoid?args=entitytype:<String_value>,name:<String_value>

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

attrs

http://<netscaler-ip-address>/nitro/v1/config/snmpoid?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/snmpoid?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

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

{ "snmpoid": [ {
entitytype:<String_value>,name:<String_value>      "Snmpoid":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/snmpoid?args=entitytype:<String_value>,name:<String_value>&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:

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