| getnstcpprofileResult Structure Definition |
The getnstcpprofileResult structure defines the return type for getnstcpprofile 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. |
nstcpprofileList |
List of nstcpprofiles |
| nstcpprofile Structure Definition |
The nstcpprofile structure defines the actual return type values for getnstcpprofile API. |
Syntax |
Members |
name |
Name of the TCP profile to be displayed. |
ws |
Enable or disable window scaling. |
sack |
Enable or disable Selective ACKnowledgement (SACK). |
wsval |
Factor used to calculate the new window size.
This argument is needed only when window scaling is enabled. |
nagle |
Enable or disable the Nagle algorithm on TCP connections. |
ackonpush |
Send immediate positive acknowledgement (ACK) on receipt of TCP packets with PUSH flag. |
mss |
Maximum Segment Size(MSS) to use for TCP Connection(0 forces use of global setting) |
maxburst |
Maximum number of TCP segments allowed in a burst. |
initialcwnd |
Initial maximum upper limit on the number of TCP packets that can be outstanding on the TCP link to the server. |
delayedack |
Timeout for TCP delayed ACK, in milliseconds. |
oooqsize |
Maximum size of out-of-order packets queue. A value of 0 means no limit. |
maxpktpermss |
Maximum packet per MSS value |
pktperretx |
Maximum limit on the number of packets that should be retransmitted on receiving a partial ACK. |
minrto |
TCP minimum RTO (in millisec) |
slowstartincr |
TCP slowstart increment factor |
buffersize |
TCP Buffer size |
flavor |
TCP algorithm |
refcnt |
Number of entities using this profile |
syncookie |
Enable or disable the SYNCOOKIE mechanism for TCP handshake with clients. Disabling SYNCOOKIE prevents SYN attack protection on the Citrix ADC. |
kaprobeupdatelastactivity |
Update last activity for the connection after receiving keep-alive (KA) probes. |
dynamicreceivebuffering |
Enable or disable dynamic receive buffering. When enabled, allows the receive buffer to be adjusted dynamically based on memory and network conditions.
Note: The buffer size argument must be set for dynamic adjustments to take place. |
ka |
Send periodic TCP keep-alive (KA) probes to check if peer is still up. |
kaconnidletime |
Duration, in seconds, for the connection to be idle, before sending a keep-alive (KA) probe. |
kamaxprobes |
Number of keep-alive (KA) probes to be sent when not acknowledged, before assuming the peer to be down. |
kaprobeinterval |
Time interval, in seconds, before the next keep-alive (KA) probe, if the peer does not respond. |
sendbuffsize |
TCP Send Buffer size |
mptcp |
Enable/Disable Multi-Path TCP |
establishclientconn |
Allocating Client Conn on |
tcpsegoffload |
TCP Segmentation Offload |
rfc5961compliance |
RFC5961 Compliance |
rstwindowattenuate |
RST Window Attenuation |
rstmaxack |
accept RST with max ACK |
timestamp |
TCP Timestamp Option |
spoofsyndrop |
drop invalid SYN packets |
ecn |
Explicit Congestion Notification |
mptcpdropdataonpreestsf |
Enable or disable dropping data on pre established subflow. |
mptcpfastopen |
Enable or disable MPTCP fastopen. |
mptcpsessiontimeout |
MPTCP session timeout. |
dsack |
Enable or disable DSACK. |
ackaggregation |
Enable or disable ACK Aggregation. |
frto |
Enable or disable FRTO (Forward RTO-Recovery). |
maxcwnd |
TCP Maximum Congestion Window. |
fack |
Forward Acknowlegement |
tcpmode |
TCP Optimization mode |
tcpfastopen |
Enable or disable TCP fastopen. |
hystart |
TCP CUBIC Hystart |
dupackthresh |
TCP Dupack Threshold |
burstratecontrol |
TCP Burst Rate Control DISABLED/FIXED/DYNAMIC. FIXED requires a TCP rate to be set. |
tcprate |
TCP connection payload send rate in Kb/s |
rateqmax |
Maximum connection queue size in bytes, when BurstRateControl is used |
drophalfclosedconnontimeout |
Silently drop tcp half closed connections on idle timeout |
dropestconnontimeout |
Silently drop tcp established connections on idle timeout |
applyadaptivetcp |
Use Adaptive TCP optimizations |
builtin |
Flag to determine if tcp profile is built-in or not |
tcpfastopencookiesize |
TCP FastOpen Cookie size. This accepts only even numbers. Odd number is trimmed down to nearest even number. |
taillossprobe |
TCP tail loss probe optimizations |
clientiptcpoption |
Client IP in TCP options |
clientiptcpoptionnumber |
ClientIP TCP Option number |
mpcapablecbit |
Set C bit in MP-CAPABLE Syn-Ack sent by Citrix ADC |
sendclientportintcpoption |
Send Client Port along with Client IP in TCP option |
slowstartthreshold |
Slow Start Threshold Value |
_nextgenapiresource |
See Also |