Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

quicprofile

August 17, 2023
Contributed by: 
C

Configuration for QUIC profile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the QUIC profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@),equals sign (=), and hyphen (-) characters. Cannot be changed after the profile is created.

Minimum length = 1

Maximum length = 256
ackdelayexponent <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, indicating an exponent that the remote QUIC endpoint should use, to decode the ACK Delay field in QUIC ACK frames sent by the Citrix ADC.

Default value: 3

Minimum value = 0

Maximum value = 20
activeconnectionidlimit <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the maximum number of QUIC connection IDs from the remote QUIC endpoint, that the Citrix ADC is willing to store.

Default value: 3

Minimum value = 2

Maximum value = 8
activeconnectionmigration <String> Read-write Specify whether the Citrix ADC should allow the remote QUIC endpoint to perform active QUIC connection migration.

Default value: ENABLED

Possible values = ENABLED, DISABLED
congestionctrlalgorithm <String> Read-write Specify the congestion control algorithm to be used for QUIC connections. The default congestion control algorithm is CUBIC.

Default value: Default

Possible values = Default, NewReno, CUBIC, BBR
initialmaxdata <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial value, in bytes, for the maximum amount of data that can be sent on a QUIC connection.

Default value: 1048576

Minimum value = 8192

Maximum value = 67108864
initialmaxstreamdatabidilocal <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial flow control limit, in bytes, for bidirectional QUIC streams initiated by the Citrix ADC.

Default value: 262144

Minimum value = 8192

Maximum value = 8388608
initialmaxstreamdatabidiremote <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial flow control limit, in bytes, for bidirectional QUIC streams initiated by the remote QUIC endpoint.

Default value: 262144

Minimum value = 8192

Maximum value = 8388608
initialmaxstreamdatauni <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial flow control limit, in bytes, for unidirectional streams initiated by the remote QUIC endpoint.

Default value: 262144

Minimum value = 8192

Maximum value = 8388608
initialmaxstreamsbidi <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial maximum number of bidirectional streams the remote QUIC endpoint may initiate.

Default value: 100

Minimum value = 1

Maximum value = 500
initialmaxstreamsuni <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the initial maximum number of unidirectional streams the remote QUIC endpoint may initiate.

Default value: 10

Minimum value = 1

Maximum value = 500
maxackdelay <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the maximum amount of time, in milliseconds, by which the Citrix ADC will delay sending acknowledgments.

Default value: 20

Minimum value = 10

Maximum value = 2000
maxidletimeout <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the maximum idle timeout, in seconds, for a QUIC connection. A QUIC connection will be silently discarded by the Citrix ADC if it remains idle for longer than the minimum of the idle timeout values advertised by the Citrix ADC and the remote QUIC endpoint, and three times the current Probe Timeout (PTO).

Default value: 180

Minimum value = 1

Maximum value = 3600
maxudpdatagramsperburst <Double> Read-write An integer value, specifying the maximum number of UDP datagrams that can be transmitted by the Citrix ADC in a single transmission burst on a QUIC connection.

Default value: 8

Minimum value = 1

Maximum value = 256
maxudppayloadsize <Double> Read-write An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying the size of the largest UDP datagram payload, in bytes, that the Citrix ADC is willing to receive on a QUIC connection.

Default value: 1472

Minimum value = 1252

Maximum value = 9188
newtokenvalidityperiod <Double> Read-write An integer value, specifying the validity period, in seconds, of address validation tokens issued through QUIC NEW_TOKEN frames sent by the Citrix ADC.

Default value: 300

Minimum value = 1

Maximum value = 3600
retrytokenvalidityperiod <Double> Read-write An integer value, specifying the validity period, in seconds, of address validation tokens issued through QUIC Retry packets sent by the Citrix ADC.

Default value: 10

Minimum value = 1

Maximum value = 120
statelessaddressvalidation <String> Read-write Specify whether the Citrix ADC should perform stateless address validation for QUIC clients, by sending tokens in QUIC Retry packets during QUIC connection establishment, and by sending tokens in QUIC NEW_TOKEN frames after QUIC connection establishment.

Default value: ENABLED

Possible values = ENABLED, DISABLED
refcnt <Double> Read-only Number of entities using this profile.
builtin <String[]> Read-only Flag to determine if the QUIC profile is built-in or not.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT

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 red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"quicprofile":{
<b>"name":<String_value>,
</b>"ackdelayexponent":<Double_value>,
"activeconnectionidlimit":<Double_value>,
"activeconnectionmigration":<String_value>,
"congestionctrlalgorithm":<String_value>,
"initialmaxdata":<Double_value>,
"initialmaxstreamdatabidilocal":<Double_value>,
"initialmaxstreamdatabidiremote":<Double_value>,
"initialmaxstreamdatauni":<Double_value>,
"initialmaxstreamsbidi":<Double_value>,
"initialmaxstreamsuni":<Double_value>,
"maxackdelay":<Double_value>,
"maxidletimeout":<Double_value>,
"maxudpdatagramsperburst":<Double_value>,
"maxudppayloadsize":<Double_value>,
"newtokenvalidityperiod":<Double_value>,
"retrytokenvalidityperiod":<Double_value>,
"statelessaddressvalidation":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile/ name_value<String> HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"quicprofile":{
<b>"name":<String_value>,
</b>"ackdelayexponent":<Double_value>,
"activeconnectionidlimit":<Double_value>,
"activeconnectionmigration":<String_value>,
"congestionctrlalgorithm":<String_value>,
"initialmaxdata":<Double_value>,
"initialmaxstreamdatabidilocal":<Double_value>,
"initialmaxstreamdatabidiremote":<Double_value>,
"initialmaxstreamdatauni":<Double_value>,
"initialmaxstreamsbidi":<Double_value>,
"initialmaxstreamsuni":<Double_value>,
"maxackdelay":<Double_value>,
"maxidletimeout":<Double_value>,
"maxudpdatagramsperburst":<Double_value>,
"maxudppayloadsize":<Double_value>,
"newtokenvalidityperiod":<Double_value>,
"retrytokenvalidityperiod":<Double_value>,
"statelessaddressvalidation":<String_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 NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"quicprofile":{
<b>"name":<String_value>,
</b>"ackdelayexponent":true,
"activeconnectionidlimit":true,
"activeconnectionmigration":true,
"congestionctrlalgorithm":true,
"initialmaxdata":true,
"initialmaxstreamdatabidilocal":true,
"initialmaxstreamdatabidiremote":true,
"initialmaxstreamdatauni":true,
"initialmaxstreamsbidi":true,
"initialmaxstreamsuni":true,
"maxackdelay":true,
"maxidletimeout":true,
"maxudpdatagramsperburst":true,
"maxudppayloadsize":true,
"newtokenvalidityperiod":true,
"retrytokenvalidityperiod":true,
"statelessaddressvalidation":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 NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of quicprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? view=summary

Use this query-parameter to get the summary output of quicprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the quicprofile resources in chunks.

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 Header:

Content-Type:application/json

Response Payload: 

{ "quicprofile": [ {
"name":<String_value>,
"ackdelayexponent":<Double_value>,
"activeconnectionidlimit":<Double_value>,
"activeconnectionmigration":<String_value>,
"congestionctrlalgorithm":<String_value>,
"initialmaxdata":<Double_value>,
"initialmaxstreamdatabidilocal":<Double_value>,
"initialmaxstreamdatabidiremote":<Double_value>,
"initialmaxstreamdatauni":<Double_value>,
"initialmaxstreamsbidi":<Double_value>,
"initialmaxstreamsuni":<Double_value>,
"maxackdelay":<Double_value>,
"maxidletimeout":<Double_value>,
"maxudpdatagramsperburst":<Double_value>,
"maxudppayloadsize":<Double_value>,
"newtokenvalidityperiod":<Double_value>,
"retrytokenvalidityperiod":<Double_value>,
"statelessaddressvalidation":<String_value>,
"refcnt":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/quicprofile/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/quicprofile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of quicprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 Header:

Content-Type:application/json

Response Payload: 

{  "quicprofile": [ {
"name":<String_value>,
"ackdelayexponent":<Double_value>,
"activeconnectionidlimit":<Double_value>,
"activeconnectionmigration":<String_value>,
"congestionctrlalgorithm":<String_value>,
"initialmaxdata":<Double_value>,
"initialmaxstreamdatabidilocal":<Double_value>,
"initialmaxstreamdatabidiremote":<Double_value>,
"initialmaxstreamdatauni":<Double_value>,
"initialmaxstreamsbidi":<Double_value>,
"initialmaxstreamsuni":<Double_value>,
"maxackdelay":<Double_value>,
"maxidletimeout":<Double_value>,
"maxudpdatagramsperburst":<Double_value>,
"maxudppayloadsize":<Double_value>,
"newtokenvalidityperiod":<Double_value>,
"retrytokenvalidityperiod":<Double_value>,
"statelessaddressvalidation":<String_value>,
"refcnt":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/quicprofile? count=yes 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 Header:

Content-Type:application/json

Response Payload: 

{ "quicprofile": [ { "__count": "#no"} ] }

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

In this article

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