| getcmpparameterResult Structure Definition |
The getcmpparameterResult structure defines the return type for getcmpparameter API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
cmpparameterList |
List of cmpparameters |
| cmpparameter Structure Definition |
The cmpparameter structure defines the actual return type values for getcmpparameter API. |
Syntax |
Members |
cmplevel |
Specify a compression level. Available settings function as follows:
* Optimal - Corresponds to a gzip GZIP level of 5-7.
* Best speed - Corresponds to a gzip level of 1.
* Best compression - Corresponds to a gzip level of 9. |
quantumsize |
Minimum quantum of data to be filled before compression begins. |
servercmp |
Compression enabled/disabled at back-end server. |
heurexpiry |
Heuristic basefile expiry. NOTE: This attribute is deprecated. Deprecating delta action in cmp policies |
heurexpirythres |
Threshold compression ratio for heuristic basefile expiry, multiplied by 100. For example, to set the threshold ratio to 1.25, specify 125. NOTE: This attribute is deprecated. Deprecating delta action in cmp policies |
heurexpiryhistwt |
For heuristic basefile expiry, weightage to be given to historical delta compression ratio, specified as percentage. For example, to give 25% weightage to historical ratio (and therefore 75% weightage to the ratio for current delta compression transaction), specify 25. NOTE: This attribute is deprecated. Deprecating delta action in cmp policies |
minressize |
Smallest response size, in bytes, to be compressed. |
cmpbypasspct |
Citrix ADC CPU threshold after which compression is not performed. Range: 0 - 100 |
cmponpush |
Citrix ADC does not wait for the quantum to be filled before starting to compress data. Upon receipt of a packet with a PUSH flag, the appliance immediately begins compression of the accumulated packets. |
policytype |
Type of the policy. The only possible value is ADVANCED |
addvaryheader |
Control insertion of the Vary header in HTTP responses compressed by Citrix ADC. Intermediate caches store different versions of the response for different values of the headers present in the Vary response header. |
varyheadervalue |
The value of the HTTP Vary header for compressed responses. If this argument is not specified, a default value of "Accept-Encoding" will be used. |
externalcache |
Enable insertion of Cache-Control: private response directive to indicate response message is intended for a single user and must not be cached by a shared or proxy cache. |
randomgzipfilename |
Control the addition of a random filename of random length in the GZIP header to apply the Heal-the-BREACH mitigation for the BREACH attack. |
randomgzipfilenameminlength |
Minimum length of the random filename to be added in the GZIP header to apply the Heal-the-BREACH mitigation for the BREACH attack. |
randomgzipfilenamemaxlength |
Maximum length of the random filename to be added in the GZIP header to apply the Heal-the-BREACH mitigation for the BREACH attack. |
builtin |
Flag to determine whether compression is default or not |
_nextgenapiresource |
See Also |