Invoke ADCUpdateNshttpprofile - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateNshttpprofile

SYNOPSIS

Update NS configuration Object.

SYNTAX

Invoke-ADCUpdateNshttpprofile [-Name] <String> [[-Dropinvalreqs] <String>] [[-Markhttp09inval] <String>]
 [[-Markconnreqinval] <String>] [[-Marktracereqinval] <String>] [[-Markrfc7230noncompliantinval] <String>]
 [[-Markhttpheaderextrawserror] <String>] [[-Cmponpush] <String>] [[-Conmultiplex] <String>]
 [[-Maxreusepool] <Double>] [[-Dropextracrlf] <String>] [[-Incomphdrdelay] <Double>] [[-Websocket] <String>]
 [[-Rtsptunnel] <String>] [[-Reqtimeout] <Double>] [[-Adpttimeout] <String>] [[-Reqtimeoutaction] <String>]
 [[-Dropextradata] <String>] [[-Weblog] <String>] [[-Clientiphdrexpr] <String>] [[-Maxreq] <Double>]
 [[-Persistentetag] <String>] [[-Http2] <String>] [[-Http2direct] <String>] [[-Http2strictcipher] <String>]
 [[-Http2altsvcframe] <String>] [[-Altsvc] <String>] [[-Altsvcvalue] <String>]
 [[-Http2maxheaderlistsize] <Double>] [[-Http2maxframesize] <Double>] [[-Http2maxconcurrentstreams] <Double>]
 [[-Http2initialconnwindowsize] <Double>] [[-Http2initialwindowsize] <Double>]
 [[-Http2headertablesize] <Double>] [[-Http2minseverconn] <Double>] [[-Http2maxpingframespermin] <Double>]
 [[-Http2maxsettingsframespermin] <Double>] [[-Http2maxresetframespermin] <Double>]
 [[-Http2maxemptyframespermin] <Double>] [[-Grpcholdlimit] <Double>] [[-Grpcholdtimeout] <Double>]
 [[-Grpclengthdelimitation] <String>] [[-Reusepooltimeout] <Double>] [[-Maxheaderlen] <Double>]
 [[-Minreusepool] <Double>] [[-Apdexcltresptimethreshold] <Double>] [[-Http3] <String>]
 [[-Http3maxheaderfieldsectionsize] <Double>] [[-Http3maxheadertablesize] <Double>]
 [[-Http3maxheaderblockedstreams] <Double>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for HTTP profile resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateNshttpprofile -name <string>

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

PARAMETERS

-Name

Name for an HTTP 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 HTTP 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 http profile" or 'my http profile'\).

Type: String
Parameter Sets: (All)
Aliases:

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

-Dropinvalreqs

Drop invalid HTTP requests or responses. 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

-Markhttp09inval

Mark HTTP/0.9 requests as invalid. 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

-Markconnreqinval

Mark CONNECT requests as invalid. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Marktracereqinval

Mark TRACE requests as invalid. 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

-Markrfc7230noncompliantinval

Mark RFC7230 non-compliant transaction as invalid. 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

-Markhttpheaderextrawserror

Mark Http header with extra white space as invalid. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Cmponpush

Start data compression on receiving a TCP packet with PUSH flag set. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Conmultiplex

Reuse server connections for requests from more than one client connections. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Maxreusepool

Maximum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time. Zero implies no limit on reuse pool size. If non-zero value is given, it has to be greater than or equal to the number of running Packet Engines.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Dropextracrlf

Drop any extra 'CR' and 'LF' characters present after the header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Incomphdrdelay

Maximum time to wait, in milliseconds, between incomplete header packets. If the header packets take longer to arrive at Citrix ADC, the connection is silently dropped.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Websocket

HTTP connection to be upgraded to a web socket connection. Once upgraded, Citrix ADC does not process Layer 7 traffic on this connection. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Rtsptunnel

Allow RTSP tunnel in HTTP. Once application/x-rtsp-tunnelled is seen in Accept or Content-Type header, Citrix ADC does not process Layer 7 traffic on this connection. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Reqtimeout

Time, in seconds, within which the HTTP request must complete. If the request does not complete within this time, the specified request timeout action is executed. Zero disables the timeout.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Adpttimeout

Adapts the configured request timeout based on flow conditions. The timeout is increased or decreased internally and applied on the flow. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Reqtimeoutaction

Action to take when the HTTP request does not complete within the specified request timeout duration. You can configure the following actions:

  • RESET - Send RST (reset) to client when timeout occurs.
  • DROP - Drop silently when timeout occurs.
  • Custom responder action - Name of the responder action to trigger when timeout occurs, used to send custom message.
Type: String
Parameter Sets: (All)
Aliases:

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

-Dropextradata

Drop any extra data when server sends more data than the specified content-length. 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

-Weblog

Enable or disable web logging. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Clientiphdrexpr

Name of the header that contains the real client IP address.

Type: String
Parameter Sets: (All)
Aliases:

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

-Maxreq

Maximum number of requests allowed on a single connection. Zero implies no limit on the number of requests.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Persistentetag

Generate the persistent Citrix ADC specific ETag for the HTTP response with ETag header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Http2

Choose whether to enable support for HTTP/2. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Http2direct

Choose whether to enable support for Direct HTTP/2. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Http2strictcipher

Choose whether to enable strict HTTP/2 cipher selection. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Http2altsvcframe

Choose whether to enable support for sending HTTP/2 ALTSVC frames. When enabled, the ADC sends HTTP/2 ALTSVC frames to HTTP/2 clients, instead of the Alt-Svc response header field. Not applicable to servers. 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

-Altsvc

Choose whether to enable support for Alternative Services. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Altsvcvalue

Configure a custom Alternative Services header value that should be inserted in the response to advertise a HTTP/SSL/HTTP_QUIC vserver.

Type: String
Parameter Sets: (All)
Aliases:

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

-Http2maxheaderlistsize

Maximum size of header list that the Citrix ADC is prepared to accept, in bytes. NOTE: The actual plain text header size that the Citrix ADC accepts is limited by maxHeaderLen. Please change maxHeaderLen parameter as well when modifying http2MaxHeaderListSize.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxframesize

Maximum size of the frame payload that the Citrix ADC is willing to receive, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxconcurrentstreams

Maximum number of concurrent streams that is allowed per connection.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2initialconnwindowsize

Initial window size for connection level flow control, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2initialwindowsize

Initial window size for stream level flow control, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2headertablesize

Maximum size of the header compression table used to decode header blocks, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2minseverconn

Minimum number of HTTP2 connections established to backend server, on receiving HTTP requests from client before multiplexing the streams into the available HTTP/2 connections.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxpingframespermin

Maximum number of ping frames allowed in HTTP2 connection per minute.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxsettingsframespermin

Maximum number of settings frames allowed in HTTP2 connection per minute.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxresetframespermin

Maximum number of reset frames allowed in HTTP/2 connection per minute.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http2maxemptyframespermin

Maximum number of empty frames allowed in HTTP2 connection per minute.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Grpcholdlimit

Maximum size in bytes allowed to buffer gRPC packets till trailer is received.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Grpcholdtimeout

Maximum time in milliseconds allowed to buffer gRPC packets till trailer is received. The value should be in multiples of 100.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Grpclengthdelimitation

Set to DISABLED for gRPC without a length delimitation. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Reusepooltimeout

Idle timeout (in seconds) for server connections in re-use pool. Connections in the re-use pool are flushed, if they remain idle for the configured timeout.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Maxheaderlen

Number of bytes to be queued to look for complete header before returning error. If complete header is not obtained after queuing these many bytes, request will be marked as invalid and no L7 processing will be done for that TCP connection.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Minreusepool

Minimum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time. Zero implies no limit on reuse pool size.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Apdexcltresptimethreshold

This option sets the satisfactory threshold (T) for client response time in milliseconds to be used for APDEX calculations. This means a transaction responding in less than this threshold is considered satisfactory. Transaction responding between T and 4T is considered tolerable. Any transaction responding in more than 4T time is considered frustrating. Citrix ADC maintains stats for such tolerable and frustrating transcations. And client response time related apdex counters are only updated on a vserver which receives clients traffic.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http3

Choose whether to enable support for HTTP/3. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Http3maxheaderfieldsectionsize

Maximum size of the HTTP/3 header field section, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http3maxheadertablesize

Maximum size of the HTTP/3 QPACK dynamic header table, in bytes.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Http3maxheaderblockedstreams

Maximum number of HTTP/3 streams that can be blocked while HTTP/3 headers are being decoded.

Type: Double
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created nshttpprofile 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-ADCUpdateNshttpprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nshttpprofile/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️