Product Documentation

appfw

Sep 08, 2016

Statistics for appfw.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
appfirewalltotallog
<Double>
Read-only
Total number of security check log messages generated by the Application Firewall.
appfirewalllograte
<Double>
Read-only
Rate (/s) counter for appfirewalltotallog
appfirewalltotalviol
<Double>
Read-only
Total number of security check violations seen by the Application Firewall.
appfirewallviolrate
<Double>
Read-only
Rate (/s) counter for appfirewalltotalviol
appfirewallshortavgresptime
<Double>
Read-only
Average backend response time in milliseconds over the last 7 seconds
appfirewalllongavgresptime
<Double>
Read-only
Average backend response time in milliseconds since reboot
appfirewallrequests
<Double>
Read-only
HTTP/HTTPS requests sent to your protected web servers via the Application Firewall.
appfirewallrequestsrate
<Double>
Read-only
Rate (/s) counter for appfirewallrequests
appfirewallreqbytes
<Double>
Read-only
Number of bytes transfered for requests
appfirewallreqbytesrate
<Double>
Read-only
Rate (/s) counter for appfirewallreqbytes
appfirewallresponses
<Double>
Read-only
HTTP/HTTPS responses sent by your protected web servers via the Application Firewall.
appfirewallresponsesrate
<Double>
Read-only
Rate (/s) counter for appfirewallresponses
appfirewallresbytes
<Double>
Read-only
Number of bytes transfered for responses
appfirewallresbytesrate
<Double>
Read-only
Rate (/s) counter for appfirewallresbytes
appfirewallaborts
<Double>
Read-only
Incomplete HTTP/HTTPS requests aborted by the client before the Application Firewall could finish processing them.
appfirewallabortsrate
<Double>
Read-only
Rate (/s) counter for appfirewallaborts
appfirewallredirects
<Double>
Read-only
HTTP/HTTPS requests redirected by the Application Firewall to a different Web page or web server. (HTTP 302)
appfirewallredirectsrate
<Double>
Read-only
Rate (/s) counter for appfirewallredirects
appfirewalltrapsdropped
<Double>
Read-only
AppFirewall SNMP traps dropped due to time limit.
appfirewallviolstarturl
<Double>
Read-only
Number of Start URL security check violations seen by the Application Firewall.
appfirewallviolstarturlrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolstarturl
appfirewallvioldenyurl
<Double>
Read-only
Number of Deny URL security check violations seen by the Application Firewall.
appfirewallvioldenyurlrate
<Double>
Read-only
Rate (/s) counter for appfirewallvioldenyurl
appfirewallviolrefererheader
<Double>
Read-only
Number of Referer Header security check violations seen by the Application Firewall.
appfirewallviolrefererheaderrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolrefererheader
appfirewallviolbufferoverflow
<Double>
Read-only
Number of Buffer Overflow security check violations seen by the Application Firewall.
appfirewallviolbufferoverflowrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolbufferoverflow
appfirewallviolcookie
<Double>
Read-only
Number of Cookie Consistency security check violations seen by the Application Firewall.
appfirewallviolcookierate
<Double>
Read-only
Rate (/s) counter for appfirewallviolcookie
appfirewallviolcsrftag
<Double>
Read-only
Number of Cross Site Request Forgery form tag security check violations seen by the Application Firewall.
appfirewallviolcsrftagrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolcsrftag
appfirewallviolxss
<Double>
Read-only
Number of HTML Cross-Site Scripting security check violations seen by the Application Firewall.
appfirewallviolxssrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxss
appfirewallviolsql
<Double>
Read-only
Number of HTML SQL Injection security check violations seen by the Application Firewall.
appfirewallviolsqlrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolsql
appfirewallviolfieldformat
<Double>
Read-only
Number of Field Format security check violations seen by the Application Firewall.
appfirewallviolfieldformatrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolfieldformat
appfirewallviolfieldconsistency
<Double>
Read-only
Number of Field Consistency security check violations seen by the Application Firewall.
appfirewallviolfieldconsistencyrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolfieldconsistency
appfirewallviolcreditcard
<Double>
Read-only
Number of Credit Card security check violations seen by the Application Firewall.
appfirewallviolcreditcardrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolcreditcard
appfirewallviolsafeobject
<Double>
Read-only
Number of Safe Object security check violations seen by the Application Firewall.
appfirewallviolsafeobjectrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolsafeobject
appfirewallviolsignature
<Double>
Read-only
Number of Signature violations seen by the Application Firewall.
appfirewallviolsignaturerate
<Double>
Read-only
Rate (/s) counter for appfirewallviolsignature
appfirewallviolcontenttype
<Double>
Read-only
Number of Content type security check violations seen by the Application Firewall.
appfirewallviolcontenttyperate
<Double>
Read-only
Rate (/s) counter for appfirewallviolcontenttype
appfirewallviolwellformednessviolations
<Double>
Read-only
Number of XML Format security check violations seen by the Application Firewall.
appfirewallviolwellformednessviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolwellformednessviolations
appfirewallviolxdosviolations
<Double>
Read-only
Number of XML Denial-of-Service security check violations seen by the Application Firewall.
appfirewallviolxdosviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxdosviolations
appfirewallviolmsgvalviolations
<Double>
Read-only
Number of XML Message Validation security check violations seen by the Application Firewall.
appfirewallviolmsgvalviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolmsgvalviolations
appfirewallviolwsiviolations
<Double>
Read-only
Number of Web Services Interoperability (WS-I) security check violations seen by the Application Firewall.
appfirewallviolwsiviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolwsiviolations
appfirewallviolxmlsqlviolations
<Double>
Read-only
Number of XML SQL Injection security check violations seen by the Application Firewall.
appfirewallviolxmlsqlviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxmlsqlviolations
appfirewallviolxmlxssviolations
<Double>
Read-only
Number of XML Cross-Site Scripting (XSS) security check violations seen by the Application Firewall.
appfirewallviolxmlxssviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxmlxssviolations
appfirewallviolxmlattachmentviolations
<Double>
Read-only
Number of XML Attachment security check violations seen by the Application Firewall.
appfirewallviolxmlattachmentviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxmlattachmentviolations
appfirewallviolxmlsoapfaultviolations
<Double>
Read-only
Number of requests returning soap:fault from the backend server
appfirewallviolxmlsoapfaultviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxmlsoapfaultviolations
appfirewallviolxmlgenviolations
<Double>
Read-only
Number of requests returning XML generic error from the backend server
appfirewallviolxmlgenviolationsrate
<Double>
Read-only
Rate (/s) counter for appfirewallviolxmlgenviolations
appfirewalllogstarturl
<Double>
Read-only
Number of Start URL security check log messages generated by the Application Firewall.
appfirewalllogstarturlrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogstarturl
appfirewalllogdenyurl
<Double>
Read-only
Number of Deny URL security check log messages generated by the Application Firewall.
appfirewalllogdenyurlrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogdenyurl
appfirewalllogrefererheader
<Double>
Read-only
Number of Referer Header security check log messages generated by the Application Firewall.
appfirewalllogrefererheaderrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogrefererheader
appfirewalllogbufferoverflow
<Double>
Read-only
Number of Buffer Overflow security check log messages generated by the Application Firewall.
appfirewalllogbufferoverflowrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogbufferoverflow
appfirewalllogcookie
<Double>
Read-only
Number of Cookie Consistency security check log messages generated by the Application Firewall.
appfirewalllogcookierate
<Double>
Read-only
Rate (/s) counter for appfirewalllogcookie
appfirewalllogcsrftag
<Double>
Read-only
Number of Cross Site Request Forgery form tag security check log messages generated by the Application Firewall.
appfirewalllogcsrftagrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogcsrftag
appfirewalllogxss
<Double>
Read-only
Number of HTML Cross-Site Scripting security check log messages generated by the Application Firewall.
appfirewalllogxssrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogxss
appfirewalllogtransformxss
<Double>
Read-only
Number of HTML Cross-Site Scripting security check transform log messages generated by the Application Firewall.
appfirewalllogtransformxssrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogtransformxss
appfirewalllogsql
<Double>
Read-only
Number of HTML SQL Injection security check log messages generated by the Application Firewall.
appfirewalllogsqlrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogsql
appfirewalllogtransformsql
<Double>
Read-only
Number of HTML SQL Injection security check transform log messages generated by the Application Firewall.
appfirewalllogtransformsqlrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogtransformsql
appfirewalllogfieldformat
<Double>
Read-only
Number of Field Format security check log messages generated by the Application Firewall.
appfirewalllogfieldformatrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogfieldformat
appfirewalllogfieldconsistency
<Double>
Read-only
Number of Field Consistency security check log messages generated by the Application Firewall.
appfirewalllogfieldconsistencyrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogfieldconsistency
appfirewalllogcreditcard
<Double>
Read-only
Number of Credit Card security check log messages generated by the Application Firewall.
appfirewalllogcreditcardrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogcreditcard
appfirewalllogsafeobject
<Double>
Read-only
Number of Safe Object security check log messages generated by the Application Firewall.
appfirewalllogsafeobjectrate
<Double>
Read-only
Rate (/s) counter for appfirewalllogsafeobject
appfirewallsignaturelogs
<Double>
Read-only
Number of Signature logs generated by the Application Firewall.
appfirewallsignaturelogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallsignaturelogs
appfirewalllogcontenttype
<Double>
Read-only
Number of content type security check log messages generated by the Application Firewall.
appfirewalllogcontenttyperate
<Double>
Read-only
Rate (/s) counter for appfirewalllogcontenttype
appfirewallwellformednesslogs
<Double>
Read-only
Number of XML Format security check log messages generated by the Application Firewall.
appfirewallwellformednesslogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallwellformednesslogs
appfirewallxdoslogs
<Double>
Read-only
Number of XML Denial-of-Service security check log messages generated by the Application Firewall.
appfirewallxdoslogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxdoslogs
appfirewallmsgvallogs
<Double>
Read-only
Number of XML Message Validation security check log messages generated by the Application Firewall.
appfirewallmsgvallogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallmsgvallogs
appfirewallwsilogs
<Double>
Read-only
Number of Web Services Interoperability (WS-I) security check log messages generated by the Application Firewall.
appfirewallwsilogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallwsilogs
appfirewallxmlsqllogs
<Double>
Read-only
Number of XML SQL Injection security check log messages generated by the Application Firewall.
appfirewallxmlsqllogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxmlsqllogs
appfirewallxmlxsslogs
<Double>
Read-only
Number of XML Cross-Site Scripting (XSS) security check log messages generated by the Application Firewall.
appfirewallxmlxsslogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxmlxsslogs
appfirewallxmlattachmentlogs
<Double>
Read-only
Number of XML Attachment security check log messages generated by the Application Firewall.
appfirewallxmlattachmentlogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxmlattachmentlogs
appfirewallxmlsoapfaultlogs
<Double>
Read-only
Number of requests generating soap:fault log messages
appfirewallxmlsoapfaultlogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxmlsoapfaultlogs
appfirewallxmlgenlogs
<Double>
Read-only
Number of requests generating XML generic error log messages
appfirewallxmlgenlogsrate
<Double>
Read-only
Rate (/s) counter for appfirewallxmlgenlogs
appfirewallret4xx
<Double>
Read-only
Number of requests returning HTTP 4xx from the backend server
appfirewallret4xxrate
<Double>
Read-only
Rate (/s) counter for appfirewallret4xx
appfirewallret5xx
<Double>
Read-only
Number of requests returning HTTP 5xx from the backend server
appfirewallret5xxrate
<Double>
Read-only
Rate (/s) counter for appfirewallret5xx

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/stat/appfw

Query-parameters:

args

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

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

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:

{ "appfw": [ {
      "appfirewallredirectsrate":<Double_value>,
      "appfirewallviolcookierate":<Double_value>,
      "appfirewallsignaturelogs":<Double_value>,
      "appfirewalllogdenyurl":<Double_value>,
      "appfirewalllogsqlrate":<Double_value>,
      "appfirewallviolfieldconsistency":<Double_value>,
      "appfirewallviolbufferoverflowrate":<Double_value>,
      "appfirewalllogtransformsql":<Double_value>,
      "appfirewallviolxssrate":<Double_value>,
      "appfirewalllogtransformsqlrate":<Double_value>,
      "appfirewalltotalviol":<Double_value>,
      "appfirewallwellformednesslogs":<Double_value>,
      "appfirewallviolsafeobjectrate":<Double_value>,
      "appfirewallresponsesrate":<Double_value>,
      "appfirewallviolxmlxssviolations":<Double_value>,
      "appfirewallresponses":<Double_value>,
      "appfirewallviolsignature":<Double_value>,
      "appfirewalllogbufferoverflow":<Double_value>,
      "appfirewallviolxmlgenviolationsrate":<Double_value>,
      "appfirewallviolrate":<Double_value>,
      "appfirewallabortsrate":<Double_value>,
      "appfirewallviolxmlsoapfaultviolationsrate":<Double_value>,
      "appfirewallrequestsrate":<Double_value>,
      "appfirewallwsilogs":<Double_value>,
      "appfirewallredirects":<Double_value>,
      "appfirewallsignaturelogsrate":<Double_value>,
      "appfirewallxdoslogsrate":<Double_value>,
      "appfirewalllogtransformxss":<Double_value>,
      "appfirewallxmlattachmentlogsrate":<Double_value>,
      "appfirewalllogrefererheaderrate":<Double_value>,
      "appfirewalllogcookie":<Double_value>,
      "appfirewallviolcreditcardrate":<Double_value>,
      "appfirewallret5xx":<Double_value>,
      "appfirewallviolmsgvalviolations":<Double_value>,
      "appfirewalllongavgresptime":<Double_value>,
      "appfirewalllogstarturl":<Double_value>,
      "appfirewallviolxmlgenviolations":<Double_value>,
      "appfirewallviolxmlsoapfaultviolations":<Double_value>,
      "appfirewallviolsafeobject":<Double_value>,
      "appfirewalllogxssrate":<Double_value>,
      "appfirewallviolsql":<Double_value>,
      "appfirewallviolxdosviolationsrate":<Double_value>,
      "appfirewalllogcreditcardrate":<Double_value>,
      "appfirewalllogsql":<Double_value>,
      "appfirewalllogdenyurlrate":<Double_value>,
      "appfirewallxmlsoapfaultlogs":<Double_value>,
      "appfirewalllogcontenttyperate":<Double_value>,
      "appfirewallviolxmlattachmentviolationsrate":<Double_value>,
      "appfirewalllogbufferoverflowrate":<Double_value>,
      "appfirewallret5xxrate":<Double_value>,
      "appfirewalltotallog":<Double_value>,
      "appfirewalllogcookierate":<Double_value>,
      "appfirewalllogcsrftag":<Double_value>,
      "appfirewallviolxss":<Double_value>,
      "appfirewallviolwellformednessviolations":<Double_value>,
      "appfirewallreqbytes":<Double_value>,
      "appfirewallxmlattachmentlogs":<Double_value>,
      "appfirewalllogcsrftagrate":<Double_value>,
      "appfirewallviolmsgvalviolationsrate":<Double_value>,
      "appfirewallviolcontenttyperate":<Double_value>,
      "appfirewalllograte":<Double_value>,
      "appfirewallxmlsqllogsrate":<Double_value>,
      "appfirewallxmlgenlogs":<Double_value>,
      "appfirewallreqbytesrate":<Double_value>,
      "appfirewalllogsafeobject":<Double_value>,
      "appfirewallviolcreditcard":<Double_value>,
      "appfirewalllogrefererheader":<Double_value>,
      "appfirewallviolxmlsqlviolationsrate":<Double_value>,
      "appfirewallaborts":<Double_value>,
      "appfirewallviolcsrftagrate":<Double_value>,
      "appfirewalllogstarturlrate":<Double_value>,
      "appfirewallviolcookie":<Double_value>,
      "appfirewallxmlxsslogs":<Double_value>,
      "appfirewallmsgvallogs":<Double_value>,
      "appfirewallviolwsiviolations":<Double_value>,
      "appfirewallviolcsrftag":<Double_value>,
      "appfirewallrequests":<Double_value>,
      "appfirewallresbytes":<Double_value>,
      "appfirewallviolbufferoverflow":<Double_value>,
      "appfirewallviolsignaturerate":<Double_value>,
      "appfirewallviolxmlxssviolationsrate":<Double_value>,
      "appfirewallviolxdosviolations":<Double_value>,
      "appfirewalllogsafeobjectrate":<Double_value>,
      "appfirewallxdoslogs":<Double_value>,
      "appfirewallviolcontenttype":<Double_value>,
      "appfirewallviolfieldconsistencyrate":<Double_value>,
      "appfirewalllogtransformxssrate":<Double_value>,
      "appfirewalllogfieldformatrate":<Double_value>,
      "appfirewallwellformednesslogsrate":<Double_value>,
      "appfirewallviolwsiviolationsrate":<Double_value>,
      "appfirewalllogcreditcard":<Double_value>,
      "appfirewallviolwellformednessviolationsrate":<Double_value>,
      "appfirewallviolfieldformatrate":<Double_value>,
      "appfirewalllogfieldconsistencyrate":<Double_value>,
      "appfirewallvioldenyurl":<Double_value>,
      "appfirewallviolxmlattachmentviolations":<Double_value>,
      "appfirewallviolsqlrate":<Double_value>,
      "appfirewallviolstarturlrate":<Double_value>,
      "appfirewallviolxmlsqlviolations":<Double_value>,
      "appfirewallshortavgresptime":<Double_value>,
      "appfirewallxmlgenlogsrate":<Double_value>,
      "appfirewalllogfieldformat":<Double_value>,
      "appfirewallxmlxsslogsrate":<Double_value>,
      "appfirewallresbytesrate":<Double_value>,
      "appfirewallviolrefererheader":<Double_value>,
      "appfirewallviolrefererheaderrate":<Double_value>,
      "appfirewalllogxss":<Double_value>,
      "appfirewalltrapsdropped":<Double_value>,
      "appfirewallviolstarturl":<Double_value>,
      "appfirewallret4xxrate":<Double_value>,
      "appfirewallxmlsqllogs":<Double_value>,
      "appfirewallwsilogsrate":<Double_value>,
      "appfirewallxmlsoapfaultlogsrate":<Double_value>,
      "appfirewallvioldenyurlrate":<Double_value>,
      "appfirewalllogcontenttype":<Double_value>,
      "appfirewallmsgvallogsrate":<Double_value>,
      "appfirewallret4xx":<Double_value>,
      "appfirewallviolfieldformat":<Double_value>,
      "appfirewalllogfieldconsistency":<Double_value>
}]}