Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

appqoeparameter

August 17, 2023
Contributed by: 
C

Configuration for QOS parameter resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
sessionlife 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 Read-write average number of client connections, that can sit in service waiting queue.
Default value: 1000000
Minimum value = 0
Maximum value = 4294967294
maxaltrespbandwidth Read-write maximum bandwidth which will determine whether to send alternate content response.
Default value: 100
Minimum value = 1
Maximum value = 4294967294
dosattackthresh 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)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/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>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/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
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
appqoeparameter
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.