Download full document:

nshttpprofile

Configuration for HTTP profile resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	Read-write	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\\).<br>Minimum length = 1<br>Maximum length = 127
dropinvalreqs	<String>	Read-write	Drop invalid HTTP requests or responses.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
markhttp09inval	<String>	Read-write	Mark HTTP/0.9 requests as invalid.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
markconnreqinval	<String>	Read-write	Mark CONNECT requests as invalid.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
cmponpush	<String>	Read-write	Start data compression on receiving a TCP packet with PUSH flag set.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
conmultiplex	<String>	Read-write	Reuse server connections for requests from more than one client connections.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
maxreusepool	<Double>	Read-write	Maximum limit on the number of connections, from the NetScaler 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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 360000
dropextracrlf	<String>	Read-write	Drop any extra CR and LF characters present after the header.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
incomphdrdelay	<Double>	Read-write	Maximum time to wait, in milliseconds, between incomplete header packets. If the header packets take longer to arrive at NetScaler, the connection is silently dropped.<br>Default value: 7000<br>Minimum value = 1<br>Maximum value = 360000
websocket	<String>	Read-write	HTTP connection to be upgraded to a web socket connection. Once upgraded, NetScaler does not process Layer 7 traffic on this connection.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
rtsptunnel	<String>	Read-write	Allow RTSP tunnel in HTTP. Once application/x-rtsp-tunnelled is seen in Accept or Content-Type header, NetScaler does not process Layer 7 traffic on this connection.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
reqtimeout	<Double>	Read-write	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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 86400
adpttimeout	<String>	Read-write	Adapts the configured request timeout based on flow conditions. The timeout is increased or decreased internally and applied on the flow.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
reqtimeoutaction	<String>	Read-write	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	<String>	Read-write	Drop any extra data when server sends more data than the specified content-length.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
weblog	<String>	Read-write	Enable or disable web logging.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
clientiphdrexpr	<String>	Read-write	Name of the header that contains the real client IP address.
maxreq	<Double>	Read-write	Maximum number of requests allowed on a single connection. Zero implies no limit on the number of requests.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 65534
persistentetag	<String>	Read-write	Generate the persistent NetScaler specific ETag for the HTTP response with ETag header.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
spdy	<String>	Read-write	Enable SPDYv2 or SPDYv3 or both over SSL vserver. SSL will advertise SPDY support either during NPN Handshake or when client will advertises SPDY support during ALPN handshake. Both SPDY versions are enabled when this parameter is set to ENABLED.<br>Default value: DISABLED<br>Possible values = DISABLED, ENABLED, V2, V3
http2	<String>	Read-write	Choose whether to enable support for HTTP/2 (draft-14).<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
reusepooltimeout	<Double>	Read-write	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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 31536000
maxheaderlen	<Double>	Read-write	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.<br>Default value: 24820<br>Minimum value = 2048<br>Maximum value = 61440
minreusepool	<Double>	Read-write	Minimum limit on the number of connections, from the NetScaler 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.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 360000
http2maxheaderlistsize	<Double>	Read-write	Maximum size of header list that the NetScaler is prepared to accept, in bytes. NOTE: The actual plain text header size that the NetScaler accepts is limited by maxHeaderLen. Please change this parameter as well when modifying http2MaxHeaderListSize.<br>Default value: 24576<br>Minimum value = 8192<br>Maximum value = 65535
http2maxframesize	<Double>	Read-write	Maximum size of the frame payload that the NetScaler is willing to receive, in bytes.<br>Default value: 16384<br>Minimum value = 16384<br>Maximum value = 16777215
http2maxconcurrentstreams	<Double>	Read-write	Maximum number of concurrent streams that is allowed per connection.<br>Default value: 100<br>Minimum value = 0<br>Maximum value = 1000
http2initialwindowsize	<Double>	Read-write	Initial window size for stream level flow control, in bytes.<br>Default value: 65535<br>Minimum value = 8192<br>Maximum value = 20971520
http2headertablesize	<Double>	Read-write	Maximum size of the header compression table used to decode header blocks, in bytes.<br>Default value: 4096<br>Minimum value = 0<br>Maximum value = 16384
refcnt	<Double>	Read-only	Number of entities using this profile.
builtin	<String[]>	Read-only	Flag to determine if http profile is built-in or not.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"nshttpprofile":{
      "name":<String_value>,
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "cmponpush":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "dropextracrlf":<String_value>,
      "incomphdrdelay":<Double_value>,
      "websocket":<String_value>,
      "rtsptunnel":<String_value>,
      "reqtimeout":<Double_value>,
      "adpttimeout":<String_value>,
      "reqtimeoutaction":<String_value>,
      "dropextradata":<String_value>,
      "weblog":<String_value>,
      "clientiphdrexpr":<String_value>,
      "maxreq":<Double_value>,
      "persistentetag":<String_value>,
      "spdy":<String_value>,
      "http2":<String_value>,
      "reusepooltimeout":<Double_value>,
      "maxheaderlen":<Double_value>,
      "minreusepool":<Double_value>,
      "http2maxheaderlistsize":<Double_value>,
      "http2maxframesize":<Double_value>,
      "http2maxconcurrentstreams":<Double_value>,
      "http2initialwindowsize":<Double_value>,
      "http2headertablesize":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/nshttpprofile/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/nshttpprofile/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"nshttpprofile":{
      "name":<String_value>,
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "cmponpush":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "dropextracrlf":<String_value>,
      "incomphdrdelay":<Double_value>,
      "websocket":<String_value>,
      "rtsptunnel":<String_value>,
      "reqtimeout":<Double_value>,
      "adpttimeout":<String_value>,
      "reqtimeoutaction":<String_value>,
      "dropextradata":<String_value>,
      "weblog":<String_value>,
      "clientiphdrexpr":<String_value>,
      "maxreq":<Double_value>,
      "persistentetag":<String_value>,
      "spdy":<String_value>,
      "http2":<String_value>,
      "http2maxheaderlistsize":<Double_value>,
      "http2maxframesize":<Double_value>,
      "http2maxconcurrentstreams":<Double_value>,
      "http2initialwindowsize":<Double_value>,
      "http2headertablesize":<Double_value>,
      "reusepooltimeout":<Double_value>,
      "maxheaderlen":<Double_value>,
      "minreusepool":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"nshttpprofile":{
      "name":<String_value>,
      "dropinvalreqs":true,
      "markhttp09inval":true,
      "markconnreqinval":true,
      "cmponpush":true,
      "conmultiplex":true,
      "maxreusepool":true,
      "dropextracrlf":true,
      "incomphdrdelay":true,
      "websocket":true,
      "dropextradata":true,
      "clientiphdrexpr":true,
      "reqtimeout":true,
      "adpttimeout":true,
      "reqtimeoutaction":true,
      "weblog":true,
      "maxreq":true,
      "persistentetag":true,
      "spdy":true,
      "http2":true,
      "http2maxheaderlistsize":true,
      "http2maxframesize":true,
      "http2maxconcurrentstreams":true,
      "http2initialwindowsize":true,
      "http2headertablesize":true,
      "reusepooltimeout":true,
      "maxheaderlen":true,
      "rtsptunnel":true,
      "minreusepool":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/nshttpprofile

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/nshttpprofile?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nshttpprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/nshttpprofile?view=summary

Use this query-parameter to get the summary output of nshttpprofile resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/nshttpprofile?pagesize=#no;pageno=#no

Use this query-parameter to get the nshttpprofile resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/nshttpprofile?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "nshttpprofile": [ {
      "name":<String_value>,
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "cmponpush":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "websocket":<String_value>,
      "refcnt":<Double_value>,
      "dropextracrlf":<String_value>,
      "incomphdrdelay":<Double_value>,
      "reqtimeout":<Double_value>,
      "adpttimeout":<String_value>,
      "reqtimeoutaction":<String_value>,
      "dropextradata":<String_value>,
      "weblog":<String_value>,
      "clientiphdrexpr":<String_value>,
      "maxreq":<Double_value>,
      "persistentetag":<String_value>,
      "spdy":<String_value>,
      "http2":<String_value>,
      "http2maxheaderlistsize":<Double_value>,
      "http2maxframesize":<Double_value>,
      "http2maxconcurrentstreams":<Double_value>,
      "http2initialwindowsize":<Double_value>,
      "http2headertablesize":<Double_value>,
      "reusepooltimeout":<Double_value>,
      "maxheaderlen":<Double_value>,
      "rtsptunnel":<String_value>,
      "minreusepool":<Double_value>,
      "builtin":<String[]_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/nshttpprofile/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "nshttpprofile": [ {
      "name":<String_value>,
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "cmponpush":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "websocket":<String_value>,
      "refcnt":<Double_value>,
      "dropextracrlf":<String_value>,
      "incomphdrdelay":<Double_value>,
      "reqtimeout":<Double_value>,
      "adpttimeout":<String_value>,
      "reqtimeoutaction":<String_value>,
      "dropextradata":<String_value>,
      "weblog":<String_value>,
      "clientiphdrexpr":<String_value>,
      "maxreq":<Double_value>,
      "persistentetag":<String_value>,
      "spdy":<String_value>,
      "http2":<String_value>,
      "http2maxheaderlistsize":<Double_value>,
      "http2maxframesize":<Double_value>,
      "http2maxconcurrentstreams":<Double_value>,
      "http2initialwindowsize":<Double_value>,
      "http2headertablesize":<Double_value>,
      "reusepooltimeout":<Double_value>,
      "maxheaderlen":<Double_value>,
      "rtsptunnel":<String_value>,
      "minreusepool":<Double_value>,
      "builtin":<String[]_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/nshttpprofile?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",nshttpprofile: [ { "__count": "#no"} ] }