Download full document:

dos

Statistics for dos.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
dostotconditiontriggered<Double>Read-onlyNumber of times the Citrix ADC triggered the DOS JavaScript due to a condition match.
dosconditiontriggeredrate<Double>Read-onlyRate (/s) counter for dostotconditiontriggered
dostotvalidcookies<Double>Read-onlyNumber of clients from whom the Citrix ADC received a valid DOS cookie.
dosvalidcookiesrate<Double>Read-onlyRate (/s) counter for dostotvalidcookies
dostotdospriorityclients<Double>Read-onlyNumber of valid clients that were given DOS priority.
dosdospriorityclientsrate<Double>Read-onlyRate (/s) counter for dostotdospriorityclients

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 redand placeholder content is marked in <green>.

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/stat/dos

Query-parameters:

args

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

Use this query-parameter to get dos 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "dos": [ {
"dostotvalidcookies":<Double_value>,
"dosvalidcookiesrate":<Double_value>,
"dosdospriorityclientsrate":<Double_value>,
"dosconditiontriggeredrate":<Double_value>,
"dostotconditiontriggered":<Double_value>,
"dostotdospriorityclients":<Double_value>
}]}