Download full document:

nscqaparam

Configuration for cqaparam resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
harqretxdelay<Double>Read-writeHARQ retransmission delay (in ms).
Default value: 0
Minimum value = 1
Maximum value = 64000
net1label<String>Read-writeName of the network label.
Maximum length = 15
minrttnet1<Double>Read-writeMIN RTT (in ms) for the first network.
Default value: 0
Minimum value = 0
Maximum value = 6400
lr1coeflist<String>Read-writecoefficients values for Label1.
lr1probthresh<Double>Read-writeProbability threshold values for LR model to differentiate between NET1 and reset(NET2 and NET3).
Default value: 0
Minimum value = 0
Maximum value = 1
net1cclscale<String>Read-writeThree congestion level scores limits corresponding to None, Low, Medium.
net1csqscale<String>Read-writeThree signal quality level scores limits corresponding to Excellent, Good, Fair.
net1logcoef<String>Read-writeConnection quality ranking Log coefficients of network 1.
net2label<String>Read-writeName of the network label 2.
Maximum length = 15
minrttnet2<Double>Read-writeMIN RTT (in ms) for the second network.
Default value: 0
Minimum value = 0
Maximum value = 6400
lr2coeflist<String>Read-writecoefficients values for Label 2.
lr2probthresh<Double>Read-writeProbability threshold values for LR model to differentiate between NET2 and NET3.
Default value: 0
Minimum value = 0
Maximum value = 1
net2cclscale<String>Read-writeThree congestion level scores limits corresponding to None, Low, Medium.
net2csqscale<String>Read-writeThree signal quality level scores limits corresponding to Excellent, Good, Fair.
net2logcoef<String>Read-writeConnnection quality ranking Log coefficients of network 2.
net3label<String>Read-writeName of the network label 3.
Maximum length = 15
minrttnet3<Double>Read-writeMIN RTT (in ms) for the third network.
Default value: 0
Minimum value = 0
Maximum value = 6400
net3cclscale<String>Read-writeThree congestion level scores limits corresponding to None, Low, Medium.
net3csqscale<String>Read-writeThree signal quality level scores limits corresponding to Excellent, Good, Fair.
net3logcoef<String>Read-writeConnection quality ranking Log coefficients of network 3.

Operations

(click to see Properties)

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

update

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

HTTP Method:PUT

Request Headers:

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

Request Payload:

{"nscqaparam":{
"harqretxdelay":<Double_value>,
"net1label":<String_value>,
"minrttnet1":<Double_value>,
"lr1coeflist":<String_value>,
"lr1probthresh":<Double_value>,
"net1cclscale":<String_value>,
"net1csqscale":<String_value>,
"net1logcoef":<String_value>,
"net2label":<String_value>,
"minrttnet2":<Double_value>,
"lr2coeflist":<String_value>,
"lr2probthresh":<Double_value>,
"net2cclscale":<String_value>,
"net2csqscale":<String_value>,
"net2logcoef":<String_value>,
"net3label":<String_value>,
"minrttnet3":<Double_value>,
"net3cclscale":<String_value>,
"net3csqscale":<String_value>,
"net3logcoef":<String_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/nscqaparam?action=unset

HTTP Method:POST

Request Headers:

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

Request Payload:

{"nscqaparam":{
"harqretxdelay":true,
"net1label":true,
"minrttnet1":true,
"lr1coeflist":true,
"lr1probthresh":true,
"net1cclscale":true,
"net1csqscale":true,
"net1logcoef":true,
"net2label":true,
"minrttnet2":true,
"net2cclscale":true,
"net2csqscale":true,
"net2logcoef":true,
"net3label":true,
"minrttnet3":true,
"net3cclscale":true,
"net3csqscale":true,
"net3logcoef":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/nscqaparam

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:

{ "nscqaparam": [ {
"harqretxdelay":<Double_value>,
"net1label":<String_value>,
"net2label":<String_value>,
"minrttnet1":<Double_value>,
"lr1coeflist":<String_value>,
"lr1probthresh":<Double_value>,
"net1cclscale":<String_value>,
"net1csqscale":<String_value>,
"net1logcoef":<String_value>,
"minrttnet2":<Double_value>,
"lr2coeflist":<String_value>,
"lr2probthresh":<Double_value>,
"net2cclscale":<String_value>,
"net2csqscale":<String_value>,
"net2logcoef":<String_value>,
"net3label":<String_value>,
"minrttnet3":<Double_value>,
"net3cclscale":<String_value>,
"net3csqscale":<String_value>,
"net3logcoef":<String_value>
}]}