Invoke-ADCUnsetNstcpparam

SYNOPSIS

Unset NS configuration Object.

SYNTAX

Invoke-ADCUnsetNstcpparam [[-ws] <Boolean>] [[-wsval] <Boolean>] [[-sack] <Boolean>]
 [[-learnvsvrmss] <Boolean>] [[-maxburst] <Boolean>] [[-initialcwnd] <Boolean>] [[-recvbuffsize] <Boolean>]
 [[-delayedack] <Boolean>] [[-downstaterst] <Boolean>] [[-nagle] <Boolean>] [[-limitedpersist] <Boolean>]
 [[-oooqsize] <Boolean>] [[-ackonpush] <Boolean>] [[-maxpktpermss] <Boolean>] [[-pktperretx] <Boolean>]
 [[-minrto] <Boolean>] [[-slowstartincr] <Boolean>] [[-maxdynserverprobes] <Boolean>]
 [[-synholdfastgiveup] <Boolean>] [[-maxsynholdperprobe] <Boolean>] [[-maxsynhold] <Boolean>]
 [[-msslearninterval] <Boolean>] [[-msslearndelay] <Boolean>] [[-maxtimewaitconn] <Boolean>]
 [[-kaprobeupdatelastactivity] <Boolean>] [[-maxsynackretx] <Boolean>] [[-synattackdetection] <Boolean>]
 [[-connflushifnomem] <Boolean>] [[-connflushthres] <Boolean>] [[-mptcpconcloseonpassivesf] <Boolean>]
 [[-mptcpchecksum] <Boolean>] [[-mptcpsftimeout] <Boolean>] [[-mptcpsfreplacetimeout] <Boolean>]
 [[-mptcpmaxsf] <Boolean>] [[-mptcpmaxpendingsf] <Boolean>] [[-mptcppendingjointhreshold] <Boolean>]
 [[-mptcprtostoswitchsf] <Boolean>] [[-mptcpusebackupondss] <Boolean>] [[-tcpmaxretries] <Boolean>]
 [[-mptcpimmediatesfcloseonfin] <Boolean>] [[-mptcpclosemptcpsessiononlastsfclose] <Boolean>]
 [[-mptcpsendsfresetoption] <Boolean>] [[-mptcpfastcloseoption] <Boolean>]
 [[-tcpfastopencookietimeout] <Boolean>] [[-autosyncookietimeout] <Boolean>] [[-tcpfintimeout] <Boolean>]
 [[-compacttcpoptionnoop] <Boolean>] [[-delinkclientserveronrst] <Boolean>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for tcp parameters resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetNstcpparam

An example how to unset nstcpparam configuration Object(s).

PARAMETERS

-ws

Enable or disable window scaling. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-wsval

Factor used to calculate the new window size. This argument is needed only when the window scaling is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-sack

Enable or disable Selective ACKnowledgement (SACK). Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-learnvsvrmss

Enable or disable maximum segment size (MSS) learning for virtual servers. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxburst

Maximum number of TCP segments allowed in a burst.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-initialcwnd

Initial maximum upper limit on the number of TCP packets that can be outstanding on the TCP link to the server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-recvbuffsize

TCP Receive buffer size.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-delayedack

Timeout for TCP delayed ACK, in milliseconds.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-downstaterst

Flag to switch on RST on down services. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-nagle

Enable or disable the Nagle algorithm on TCP connections. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-limitedpersist

Limit the number of persist (zero window) probes. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-oooqsize

Maximum size of out-of-order packets queue. A value of 0 means no limit.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ackonpush

Send immediate positive acknowledgement (ACK) on receipt of TCP packets with PUSH flag. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxpktpermss

Maximum number of TCP packets allowed per maximum segment size (MSS).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-pktperretx

Maximum limit on the number of packets that should be retransmitted on receiving a partial ACK.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-minrto

Minimum retransmission timeout, in milliseconds, specified in 10-millisecond increments (value must yield a whole number if divided by 10).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-slowstartincr

Multiplier that determines the rate at which slow start increases the size of the TCP transmission window after each acknowledgement of successful transmission.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxdynserverprobes

Maximum number of probes that Citrix ADC can send out in 10 milliseconds, to dynamically learn a service. Citrix ADC probes for the existence of the origin in case of wildcard virtual server or services.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-synholdfastgiveup

Maximum threshold. After crossing this threshold number of outstanding probes for origin, the Citrix ADC reduces the number of connection retries for probe connections.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxsynholdperprobe

Limit the number of client connections (SYN) waiting for status of single probe. Any new SYN packets will be dropped.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxsynhold

Limit the number of client connections (SYN) waiting for status of probe system wide. Any new SYN packets will be dropped.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-msslearninterval

Duration, in seconds, to sample the Maximum Segment Size (MSS) of the services. The Citrix ADC determines the best MSS to set for the virtual server based on this sampling. The argument to enable maximum segment size (MSS) for virtual servers must be enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-msslearndelay

Frequency, in seconds, at which the virtual servers learn the Maximum segment size (MSS) from the services. The argument to enable maximum segment size (MSS) for virtual servers must be enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxtimewaitconn

Maximum number of connections to hold in the TCP TIME_WAIT state on a packet engine. New connections entering TIME_WAIT state are proactively cleaned up.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-kaprobeupdatelastactivity

Update last activity for KA probes. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-maxsynackretx

When 'syncookie' is disabled in the TCP profile that is bound to the virtual server or service, and the number of TCP SYN+ACK retransmission by Citrix ADC for that virtual server or service crosses this threshold, the Citrix ADC responds by using the TCP SYN-Cookie mechanism.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-synattackdetection

Detect TCP SYN packet flood and send an SNMP trap. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-connflushifnomem

Flush an existing connection if no memory can be obtained for new connection. HALF_CLOSED_AND_IDLE: Flush a connection that is closed by us but not by peer, or failing that, a connection that is past configured idle time. New connection fails if no such connection can be found. FIFO: If no half-closed or idle connection can be found, flush the oldest non-management connection, even if it is active. New connection fails if the oldest few connections are management connections. Note: If you enable this setting, you should also consider lowering the zombie timeout and half-close timeout, while setting the Citrix ADC timeout. See Also: connFlushThres argument below. Possible values = NONE, HALFCLOSED_AND_IDLE, FIFO

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-connflushthres

Flush an existing connection (as configured through -connFlushIfNoMem FIFO) if the system has more than specified number of connections, and a new connection is to be established. Note: This value may be rounded down to be a whole multiple of the number of packet engines running.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpconcloseonpassivesf

Accept DATA_FIN/FAST_CLOSE on passive subflow. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpchecksum

Use MPTCP DSS checksum. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpsftimeout

The timeout value in seconds for idle mptcp subflows. If this timeout is not set, idle subflows are cleared after cltTimeout of vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpsfreplacetimeout

The minimum idle time value in seconds for idle mptcp subflows after which the sublow is replaced by new incoming subflow if maximum subflow limit is reached. The priority for replacement is given to those subflow without any transaction.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpmaxsf

Maximum number of subflow connections supported in established state per mptcp connection.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpmaxpendingsf

Maximum number of subflow connections supported in pending join state per mptcp connection.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcppendingjointhreshold

Maximum system level pending join connections allowed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcprtostoswitchsf

Number of RTO's at subflow level, after which MPCTP should start using other subflow.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 38
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpusebackupondss

When enabled, if NS receives a DSS on a backup subflow, NS will start using that subflow to send data. And if disabled, NS will continue to transmit on current chosen subflow. In case there is some error on a subflow (like RTO's/RST etc.) then NS can choose a backup subflow irrespective of this tunable. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 39
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-tcpmaxretries

Number of RTO's after which a connection should be freed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 40
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpimmediatesfcloseonfin

Allow subflows to close immediately on FIN before the DATA_FIN exchange is completed at mptcp level. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 41
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpclosemptcpsessiononlastsfclose

Allow to send DATA FIN or FAST CLOSE on mptcp connection while sending FIN or RST on the last subflow. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 42
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpsendsfresetoption

Allow MPTCP subflows to send TCP RST Reason (MP_TCPRST) Option while sending TCP RST. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 43
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mptcpfastcloseoption

Allow to select option ACK or RESET to force the closure of an MPTCP connection abruptly. Possible values = ACK, RESET

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 44
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-tcpfastopencookietimeout

Timeout in seconds after which a new TFO Key is computed for generating TFO Cookie. If zero, the same key is used always. If timeout is less than 120seconds, NS defaults to 120seconds timeout.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 45
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-autosyncookietimeout

Timeout for the server to function in syncookie mode after the synattack. This is valid if TCP syncookie is disabled on the profile and server acts in non syncookie mode by default.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 46
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-tcpfintimeout

The amount of time in seconds, after which a TCP connnection in the TCP TIME-WAIT state is flushed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 47
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-compacttcpoptionnoop

If enabled, non-negotiated TCP options are removed from the received packet while proxying it. By default, non-negotiated TCP options would be replaced by NOPs in the proxied packets. This option is not applicable for Citrix ADC generated packets. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 48
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-delinkclientserveronrst

If enabled, Delink client and server connection, when there is outstanding data to be sent to the other side. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 49
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUnsetNstcpparam Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nstcpparam Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.