getnshttpprofileResult Structure Definition

The getnshttpprofileResult structure defines the return type for getnshttpprofile 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.

nshttpprofileList

List of nshttpprofiles


nshttpprofile Structure Definition

The nshttpprofile structure defines the actual return type values for getnshttpprofile API.

Syntax



Members

name

Name of the HTTP profile to be displayed.

dropinvalreqs

Dropping of invalid HTTP requests/responses

markhttp09inval

Invalidating HTTP 0.9 requests

markconnreqinval

Invalidating CONNECT HTTP requests

marktracereqinval

Invalidating TRACE HTTP requests

markrfc7230noncompliantinval

Invalidating RFC7230 Non-Compliant

markhttpheaderextrawserror

Mark Http header with extra white space as invalid

cmponpush

Compression on PUSH packet

conmultiplex

Reuse server connections for requests from more than one client connections.

maxreusepool

Maximum connections in reusepool

websocket

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

refcnt

Number of entities using this profile

dropextracrlf

Drop any extra 'CR' and 'LF' characters present after the header.

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.

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.

adpttimeout

Adapts the configured request timeout based on flow conditions. The timeout is increased or decreased internally and applied on the flow.

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.

dropextradata

Drop any extra data when server sends more data than the specified content-length.

weblog

Disabling weblog option

clientiphdrexpr

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

maxreq

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

persistentetag

Generate the persistent Citrix ADC specific ETag for the HTTP response with ETag header.

http2

Choose whether to enable support for HTTP/2.

http2direct

Choose whether to enable support for Direct HTTP/2.

http2strictcipher

Choose whether to enable strict HTTP/2 cipher selection

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.

altsvc

Choose whether to enable support for Alternative Services.

altsvcvalue

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

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.

http2maxframesize

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

http2maxconcurrentstreams

Maximum number of concurrent streams that is allowed per connection.

http2initialconnwindowsize

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

http2initialwindowsize

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

http2headertablesize

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

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.

http2maxpingframespermin

Maximum number of PING frames allowed in HTTP2 connection per minute

http2maxsettingsframespermin

Maximum number of SETTINGS frames allowed in HTTP2 connection per minute

http2maxresetframespermin

Maximum number of outgoing RST_STREAM frames allowed in HTTP/2 connection per minute

http2maxemptyframespermin

Maximum number of empty frames allowed in HTTP2 connection per minute

http2maxrxresetframespermin

Maximum number of incoming RST_STREAM frames allowed in HTTP/2 connection per minute

grpcholdlimit

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

grpcholdtimeout

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

grpclengthdelimitation

Set to DISABLED for gRPC without a length delimitation.

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.

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.

maxheaderfieldlen

Number of bytes allowed for header field for HTTP header. If number of bytes exceeds beyond configured value, then request will be marked invalid

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.

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.

builtin

Flag to determine if http profile is built-in or not

apdexsvrresptimethreshold

This option sets the satisfactory threshold (T) for server 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 4*T is considered tolerable. Any transaction responding in more than 4*T time is considered frustrating. Citrix ADC maintains stats for such tolerable and frustrating transcations. Server Response time related apdex counters are only updated on backend services or a backend vserver which is not accepting client traffic.

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 4*T is considered tolerable. Any transaction responding in more than 4*T 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.

http3

Choose whether to enable support for HTTP/3.

http3maxheaderfieldsectionsize

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

http3maxheadertablesize

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

http3maxheaderblockedstreams

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

http3webtransport

Choose whether to enable support for WebTransport over HTTP/3.

httppipelinebuffsize

Application pipeline request buffering size, in bytes.

allowonlywordcharactersandhyphen

Allow only word character hyphen [A-Za-z0-9_]

hostheadervalidation

Host header validation

maxduplicateheaderfields

Maximum number of allowed occurrences of header fields that share the same field name. This threshold is enforced only for well-known header field names recognized by NetScaler, and also for custom header field names present in configured expressions. The default value of 0 indicates that there is no threshold.

http3minseverconn

Minimum HTTP/3 server connections in active pool

dropinvalreqswarning

Display warning if Drop invalid reqs is disabled in the profile

passprotocolupgrade

Pass protocol upgrade request to the server.

http2extendedconnect

Choose whether to enable HTTP/2 Extended CONNECT mechanism.

_nextgenapiresource


See Also