Invoke-ADCUpdateNstcpprofile

SYNOPSIS

Update NS configuration Object.

SYNTAX

Invoke-ADCUpdateNstcpprofile [-Name] <String> [[-Ws] <String>] [[-Sack] <String>] [[-Wsval] <Double>]
 [[-Nagle] <String>] [[-Ackonpush] <String>] [[-Mss] <Double>] [[-Maxburst] <Double>] [[-Initialcwnd] <Double>]
 [[-Delayedack] <Double>] [[-Oooqsize] <Double>] [[-Maxpktpermss] <Double>] [[-Pktperretx] <Double>]
 [[-Minrto] <Double>] [[-Slowstartincr] <Double>] [[-Buffersize] <Double>] [[-Syncookie] <String>]
 [[-Kaprobeupdatelastactivity] <String>] [[-Flavor] <String>] [[-Dynamicreceivebuffering] <String>]
 [[-Ka] <String>] [[-Kaconnidletime] <Double>] [[-Kamaxprobes] <Double>] [[-Kaprobeinterval] <Double>]
 [[-Sendbuffsize] <Double>] [[-Mptcp] <String>] [[-Establishclientconn] <String>] [[-Tcpsegoffload] <String>]
 [[-Rstwindowattenuate] <String>] [[-Rstmaxack] <String>] [[-Spoofsyndrop] <String>] [[-Ecn] <String>]
 [[-Mptcpdropdataonpreestsf] <String>] [[-Mptcpfastopen] <String>] [[-Mptcpsessiontimeout] <Double>]
 [[-Timestamp] <String>] [[-Dsack] <String>] [[-Ackaggregation] <String>] [[-Frto] <String>]
 [[-Maxcwnd] <Double>] [[-Fack] <String>] [[-Tcpmode] <String>] [[-Tcpfastopen] <String>] [[-Hystart] <String>]
 [[-Dupackthresh] <Double>] [[-Burstratecontrol] <String>] [[-Tcprate] <Double>] [[-Rateqmax] <Double>]
 [[-Drophalfclosedconnontimeout] <String>] [[-Dropestconnontimeout] <String>] [[-Applyadaptivetcp] <String>]
 [[-Tcpfastopencookiesize] <Double>] [[-Taillossprobe] <String>] [[-Clientiptcpoption] <String>]
 [[-Clientiptcpoptionnumber] <Double>] [[-Mpcapablecbit] <String>] [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for TCP profile resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateNstcpprofile -name <string>

An example how to update nstcpprofile configuration Object(s).

PARAMETERS

-Name

Name for a TCP profile. Must begin with a letter, number, or the underscore \(_\) character. Other characters allowed, after the first character, are the hyphen \(-\), period \(.\), hash \(#\), space \( \), at \(@\), colon \(:\), and equal \(=\) characters. The name of a TCP profile cannot be changed after it is created. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks \(for example, "my tcp profile" or 'my tcp profile'\).

Type: String
Parameter Sets: (All)
Aliases:

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

-Ws

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Sack

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Wsval

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

Type: Double
Parameter Sets: (All)
Aliases:

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

-Nagle

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
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: String
Parameter Sets: (All)
Aliases:

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

-Mss

Maximum number of octets to allow in a TCP data segment.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Maxburst

Maximum number of TCP segments allowed in a burst.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 0
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: Double
Parameter Sets: (All)
Aliases:

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

-Delayedack

Timeout for TCP delayed ACK, in milliseconds.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: 0
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: Double
Parameter Sets: (All)
Aliases:

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

-Maxpktpermss

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: 0
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: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: 0
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: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: 0
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: Double
Parameter Sets: (All)
Aliases:

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

-Buffersize

TCP buffering size, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Syncookie

Enable or disable the SYNCOOKIE mechanism for TCP handshake with clients. Disabling SYNCOOKIE prevents SYN attack protection on the Citrix ADC. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Kaprobeupdatelastactivity

Update last activity for the connection after receiving keep-alive (KA) probes. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Flavor

Set TCP congestion control algorithm. Possible values = Default, Westwood, BIC, CUBIC, Nile

Type: String
Parameter Sets: (All)
Aliases:

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

-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. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Ka

Send periodic TCP keep-alive (KA) probes to check if peer is still up. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Kaconnidletime

Duration, in seconds, for the connection to be idle, before sending a keep-alive (KA) probe.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Kamaxprobes

Number of keep-alive (KA) probes to be sent when not acknowledged, before assuming the peer to be down.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Kaprobeinterval

Time interval, in seconds, before the next keep-alive (KA) probe, if the peer does not respond.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Sendbuffsize

TCP Send Buffer Size.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Mptcp

Enable or disable Multipath TCP. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Establishclientconn

Establishing Client Client connection on First data/ Final-ACK / Automatic. Possible values = AUTOMATIC, CONN_ESTABLISHED, ON_FIRST_DATA

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcpsegoffload

Offload TCP segmentation to the NIC. If set to AUTOMATIC, TCP segmentation will be offloaded to the NIC, if the NIC supports it. Possible values = AUTOMATIC, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Rstwindowattenuate

Enable or disable RST window attenuation to protect against spoofing. When enabled, will reply with corrective ACK when a sequence number is invalid. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Rstmaxack

Enable or disable acceptance of RST that is out of window yet echoes highest ACK sequence number. Useful only in proxy mode. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Spoofsyndrop

Enable or disable drop of invalid SYN packets to protect against spoofing. When disabled, established connections will be reset when a SYN packet is received. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Ecn

Enable or disable TCP Explicit Congestion Notification. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Mptcpdropdataonpreestsf

Enable or disable silently dropping the data on Pre-Established subflow. When enabled, DSS data packets are dropped silently instead of dropping the connection when data is received on pre established subflow. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Mptcpfastopen

Enable or disable Multipath TCP fastopen. When enabled, DSS data packets are accepted before receiving the third ack of SYN handshake. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Mptcpsessiontimeout

MPTCP session timeout in seconds. If this value is not set, idle MPTCP sessions are flushed after vserver's client idle timeout.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Timestamp

Enable or Disable TCP Timestamp option (RFC 1323). Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Dsack

Enable or disable DSACK. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Ackaggregation

Enable or disable ACK Aggregation. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Frto

Enable or disable FRTO (Forward RTO-Recovery). Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Maxcwnd

TCP Maximum Congestion Window.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Fack

Enable or disable FACK (Forward ACK). Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcpmode

TCP Optimization modes TRANSPARENT / ENDPOINT. Possible values = TRANSPARENT, ENDPOINT

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcpfastopen

Enable or disable TCP Fastopen. When enabled, NS can receive or send Data in SYN or SYN-ACK packets. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Hystart

Enable or disable CUBIC Hystart. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Dupackthresh

TCP dupack threshold.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Burstratecontrol

TCP Burst Rate Control DISABLED/FIXED/DYNAMIC. FIXED requires a TCP rate to be set. Possible values = DISABLED, FIXED, DYNAMIC

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcprate

TCP connection payload send rate in Kb/s.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Rateqmax

Maximum connection queue size in bytes, when BurstRateControl is used.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Drophalfclosedconnontimeout

Silently drop tcp half closed connections on idle timeout. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Dropestconnontimeout

Silently drop tcp established connections on idle timeout. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Applyadaptivetcp

Apply Adaptive TCP optimizations. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Tcpfastopencookiesize

TCP FastOpen Cookie size. This accepts only even numbers. Odd number is trimmed down to nearest even number.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 53
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Taillossprobe

TCP tail loss probe optimizations. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Clientiptcpoption

Client IP in TCP options. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Clientiptcpoptionnumber

ClientIP TCP Option number.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 56
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Mpcapablecbit

Set C bit in MP-CAPABLE Syn-Ack sent by Citrix ADC. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created nstcpprofile item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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-ADCUpdateNstcpprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nstcpprofile/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.