Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

snmp

May 23, 2024
Contributed by: 
C

Statistics for snmp.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
snmptotrxpkts Read-only SNMP packets received.
snmprxpktsrate Read-only Rate (/s) counter for snmptotrxpkts
snmptottxpkts Read-only SNMP packets transmitted.
snmptxpktsrate Read-only Rate (/s) counter for snmptottxpkts
snmptotgetreqs Read-only SNMP Get-Request PDUs that have been accepted and processed.
snmpgetreqsrate Read-only Rate (/s) counter for snmptotgetreqs
snmptotgetnextreqs Read-only SNMP Get-Next PDUs that have been accepted and processed.
snmpgetnextreqsrate Read-only Rate (/s) counter for snmptotgetnextreqs
snmptotgetbulkreqs Read-only SNMP Get-Bulk PDUs that have been accepted and processed.
snmpgetbulkreqsrate Read-only Rate (/s) counter for snmptotgetbulkreqs
snmptotresponses Read-only SNMP Get-Response PDUs that have been generated by the Citrix ADC.
snmpresponsesrate Read-only Rate (/s) counter for snmptotresponses
snmptottraps Read-only SNMP Trap PDUs that have been generated by the Citrix ADC.
snmptoterrreqdropped Read-only SNMP requests dropped.
snmptotparseerrs Read-only Number of ASN.1 or BER errors encountered when decoding received SNMP Messages.
snmptotbadversions Read-only Number of SNMP messages received, which were for an unsupported SNMP version.
snmptotbadcommname Read-only SNMP messages received, which used an SNMP community name not known to the Citrix ADC.
snmptotbadcommuse Read-only The total number of SNMP Messages received that represented an SNMP operation which was not allowed by the SNMP community named in the Message.
snmpunsupportedsecuritylevel Read-only SNMP packets that were dropped because they requested a security level that was unknown to the Citrix ADC or otherwise unavailable.
snmpnotintimewindow Read-only SNMP packets that were dropped because they appeared outside of the authoritative SNMP engine’s window.
snmpunknownusername Read-only SNMP packets that were dropped because they referenced a user that was not known to the SNMP engine.
snmpunknownengineids Read-only SNMP packets that were dropped because they referenced an SNMP engine ID that was not known to the Citrix ADC.
snmpwrongdigests Read-only SNMP packets that were dropped because they did not contain the expected digest value.
snmpdecryptionerrors Read-only SNMP packets that were dropped because they could not be decrypted.

Operations

(click to see Properties )

  • 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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/snmp Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/snmp? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

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

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

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: 

{  "snmp": [ {
"snmpdecryptionerrors":<Double_value>,
"snmptotresponses":<Double_value>,
"snmptotbadcommuse":<Double_value>,
"snmptoterrreqdropped":<Double_value>,
"snmpgetnextreqsrate":<Double_value>,
"snmptotbadversions":<Double_value>,
"snmptotrxpkts":<Double_value>,
"snmptxpktsrate":<Double_value>,
"snmpresponsesrate":<Double_value>,
"snmpgetreqsrate":<Double_value>,
"snmptotbadcommname":<Double_value>,
"snmptotgetnextreqs":<Double_value>,
"snmptottxpkts":<Double_value>,
"snmpunknownengineids":<Double_value>,
"snmpwrongdigests":<Double_value>,
"snmpgetbulkreqsrate":<Double_value>,
"snmpnotintimewindow":<Double_value>,
"snmptotgetbulkreqs":<Double_value>,
"snmptotparseerrs":<Double_value>,
"snmpunknownusername":<Double_value>,
"snmpunsupportedsecuritylevel":<Double_value>,
"snmptotgetreqs":<Double_value>,
"snmprxpktsrate":<Double_value>,
"snmptottraps":<Double_value>
}]}

<!--NeedCopy-->
snmp
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.