Product Documentation

appqoeparameter

Sep 01, 2016

Configuration for QOS parameter resource.

Properties (click to see Operations)

Name Data Type Permissions Description
sessionlife
<Double>
Read-write
Time, in seconds, between the first time and the next time the AppQoE alternative content window is displayed. The alternative content window is displayed only once during a session for the same browser accessing a configured URL, so this parameter determines the length of a session.
Default value: 300
Minimum value = 1
Maximum value = 4294967294
avgwaitingclient
<Double>
Read-write
average number of client connections, that can sit in service waiting queue.
Default value: 1000000
Minimum value = 0
Maximum value = 4294967294
maxaltrespbandwidth
<Double>
Read-write
maximum bandwidth which will determine whether to send alternate content response.
Default value: 100
Minimum value = 1
Maximum value = 4294967294
dosattackthresh
<Double>
Read-write
average number of client connection that can queue up on vserver level without triggering DoS mitigation module.
Default value: 2000
Minimum value = 0
Maximum value = 4294967294

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>.

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"appqoeparameter":{
      "sessionlife":<Double_value>,
      "avgwaitingclient":<Double_value>,
      "maxaltrespbandwidth":<Double_value>,
      "dosattackthresh":<Double_value>
}}

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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/appqoeparameter?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"appqoeparameter":{
      "sessionlife":true,
      "avgwaitingclient":true,
      "maxaltrespbandwidth":true,
      "dosattackthresh":true
}}

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

get (all)

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

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:

{ "appqoeparameter": [ {
      "sessionlife":<Double_value>,
      "avgwaitingclient":<Double_value>,
      "maxaltrespbandwidth":<Double_value>,
      "dosattackthresh":<Double_value>
}]}