Download full document:

dospolicy

Statistics for DoS policy resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeThe name of the DoS protection policy whose statistics must be displayed. If a name is not provided, statistics of all the DoS protection policies are displayed.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
doscurrentcltdetectrate<Double>Read-onlyCurrent ratio of JavaScript send rate to the server response rate (Client detect rate)
dosphysicalserviceip<String>Read-onlyIP address of the service to which this policy is bound.
dosphysicalserviceport<Integer>Read-onlyPort address of the service to which this policy is bound.
doscurrentqueuesize<Double>Read-onlyCurrent queue size of the server to which this policy is bound.
doscurrentqueuesizerate<Double>Read-onlyRate (/s) counter for doscurrentqueuesize
dostotjssent<Double>Read-onlyTotal number of DoS JavaScript transactions performed for this policy.
dosjssentrate<Double>Read-onlyRate (/s) counter for dostotjssent
dostotjsrefused<Double>Read-onlyNumber of times the DoS JavaScript was not sent because the set JavaScript rate was not met for this policy.
dosjsrefusedrate<Double>Read-onlyRate (/s) counter for dostotjsrefused
dostotvalidclients<Double>Read-onlyTotal number of valid DoS cookies received for this policy.
dosvalidclientsrate<Double>Read-onlyRate (/s) counter for dostotvalidclients
dostotjsbytessent<Double>Read-onlyTotal number of DoS JavaScript bytes sent for this policy.
dosjsbytessentrate<Double>Read-onlyRate (/s) counter for dostotjsbytessent
dostotnongetpostrequests<Double>Read-onlyNumber of non-GET and non-POST requests for which DOS JavaScript was sent.
dosnongetpostrequestsrate<Double>Read-onlyRate (/s) counter for dostotnongetpostrequests

Operations

(click to see Properties)

GET (ALL)| GET

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/dospolicy

Query-parameters:

args

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

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

{ "dospolicy": [ {
"name":<String_value>,
"dosjsrefusedrate":<Double_value>,
"dosphysicalserviceip":<String_value>,
"dosnongetpostrequestsrate":<Double_value>,
"dosjssentrate":<Double_value>,
"dosphysicalserviceport":<Integer_value>,
"dosjsbytessentrate":<Double_value>,
"doscurrentcltdetectrate":<Double_value>,
"dostotnongetpostrequests":<Double_value>,
"dostotvalidclients":<Double_value>,
"dosvalidclientsrate":<Double_value>,
"doscurrentqueuesizerate":<Double_value>,
"dostotjsbytessent":<Double_value>,
"dostotjssent":<Double_value>,
"dostotjsrefused":<Double_value>,
"doscurrentqueuesize":<Double_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/dospolicy/name_value><String>

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:

{ "dospolicy": [ {
"name":<String_value>,
"dosjsrefusedrate":<Double_value>,
"dosphysicalserviceip":<String_value>,
"dosnongetpostrequestsrate":<Double_value>,
"dosjssentrate":<Double_value>,
"dosphysicalserviceport":<Integer_value>,
"dosjsbytessentrate":<Double_value>,
"doscurrentcltdetectrate":<Double_value>,
"dostotnongetpostrequests":<Double_value>,
"dostotvalidclients":<Double_value>,
"dosvalidclientsrate":<Double_value>,
"doscurrentqueuesizerate":<Double_value>,
"dostotjsbytessent":<Double_value>,
"dostotjssent":<Double_value>,
"dostotjsrefused":<Double_value>,
"doscurrentqueuesize":<Double_value>
}]}