Download full document:

appflowparam

Configuration for AppFlow parameter resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
templaterefresh	<Double>	Read-write	Refresh interval, in seconds, at which to export the template data. Because data transmission is in UDP, the templates must be resent at regular intervals.<br>Default value: 600<br>Minimum value = 60<br>Maximum value = 3600
appnamerefresh	<Double>	Read-write	Interval, in seconds, at which to send Appnames to the configured collectors. Appname refers to the name of an entity (virtual server, service, or service group) in the NetScaler appliance.<br>Default value: 600<br>Minimum value = 60<br>Maximum value = 3600
flowrecordinterval	<Double>	Read-write	Interval, in seconds, at which to send flow records to the configured collectors.<br>Default value: 60<br>Minimum value = 60<br>Maximum value = 3600
udppmtu	<Double>	Read-write	MTU, in bytes, for IPFIX UDP packets.<br>Default value: 1472<br>Minimum value = 128<br>Maximum value = 1472
httpurl	<String>	Read-write	Include the http URL that the NetScaler appliance received from the client.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
aaausername	<String>	Read-write	Enable AppFlow AAA Username logging.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpcookie	<String>	Read-write	Include the cookie that was in the HTTP request the appliance received from the client.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpreferer	<String>	Read-write	Include the web page that was last visited by the client.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpmethod	<String>	Read-write	Include the method that was specified in the HTTP request that the appliance received from the client.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httphost	<String>	Read-write	Include the host identified in the HTTP request that the appliance received from the client.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpuseragent	<String>	Read-write	Include the client application through which the HTTP request was received by the NetScaler appliance.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
clienttrafficonly	<String>	Read-write	Generate AppFlow records for only the traffic from the client.<br>Default value: NO<br>Possible values = YES, NO
httpcontenttype	<String>	Read-write	Include the HTTP Content-Type header sent from the server to the client to determine the type of the content sent.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpauthorization	<String>	Read-write	Include the HTTP Authorization header information.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpvia	<String>	Read-write	Include the httpVia header which contains the IP address of proxy server through which the client accessed the server.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpxforwardedfor	<String>	Read-write	Include the httpXForwardedFor header, which contains the original IP Address of the client using a proxy server to access the server.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httplocation	<String>	Read-write	Include the HTTP location headers returned from the HTTP responses.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpsetcookie	<String>	Read-write	Include the Set-cookie header sent from the server to the client in response to a HTTP request.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpsetcookie2	<String>	Read-write	Include the Set-cookie header sent from the server to the client in response to a HTTP request.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
connectionchaining	<String>	Read-write	Enable connection chaining so that the client server flows of a connection are linked. Also the connection chain ID is propagated across NetScalers, so that in a multi-hop environment the flows belonging to the same logical connection are linked. This id is also logged as part of appflow record.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
httpdomain	<String>	Read-write	Include the http domain request to be exported.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
skipcacheredirectionhttptransaction	<String>	Read-write	Skip Cache http transaction. This HTTP transaction is specific to Cache Redirection module. In Case of Cache Miss there will be another HTTP transaction initiated by the cache server.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
builtin	<String[]>	Read-only	Flag to determine if the appflow param is built-in or not.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE

Operations

(click to see Properties)

UPDATE | UNSET | GET (ALL)

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>.

update

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

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"appflowparam":{
      "templaterefresh":<Double_value>,
      "appnamerefresh":<Double_value>,
      "flowrecordinterval":<Double_value>,
      "udppmtu":<Double_value>,
      "httpurl":<String_value>,
      "aaausername":<String_value>,
      "httpcookie":<String_value>,
      "httpreferer":<String_value>,
      "httpmethod":<String_value>,
      "httphost":<String_value>,
      "httpuseragent":<String_value>,
      "clienttrafficonly":<String_value>,
      "httpcontenttype":<String_value>,
      "httpauthorization":<String_value>,
      "httpvia":<String_value>,
      "httpxforwardedfor":<String_value>,
      "httplocation":<String_value>,
      "httpsetcookie":<String_value>,
      "httpsetcookie2":<String_value>,
      "connectionchaining":<String_value>,
      "httpdomain":<String_value>,
      "skipcacheredirectionhttptransaction":<String_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",
"appflowparam":{
      "templaterefresh":true,
      "appnamerefresh":true,
      "flowrecordinterval":true,
      "udppmtu":true,
      "httpurl":true,
      "aaausername":true,
      "httpcookie":true,
      "httpreferer":true,
      "httpmethod":true,
      "httphost":true,
      "httpuseragent":true,
      "clienttrafficonly":true,
      "httpcontenttype":true,
      "httpauthorization":true,
      "httpvia":true,
      "httpxforwardedfor":true,
      "httplocation":true,
      "httpsetcookie":true,
      "httpsetcookie2":true,
      "connectionchaining":true,
      "httpdomain":true,
      "skipcacheredirectionhttptransaction":true,
}}

Response Payload:

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

get (all)

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

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "appflowparam": [ {
      "templaterefresh":<Double_value>,
      "appnamerefresh":<Double_value>,
      "flowrecordinterval":<Double_value>,
      "udppmtu":<Double_value>,
      "httpurl":<String_value>,
      "aaausername":<String_value>,
      "httpcookie":<String_value>,
      "httpreferer":<String_value>,
      "httpmethod":<String_value>,
      "httphost":<String_value>,
      "httpuseragent":<String_value>,
      "clienttrafficonly":<String_value>,
      "httpcontenttype":<String_value>,
      "httpauthorization":<String_value>,
      "httpvia":<String_value>,
      "httpxforwardedfor":<String_value>,
      "httplocation":<String_value>,
      "httpsetcookie":<String_value>,
      "httpsetcookie2":<String_value>,
      "connectionchaining":<String_value>,
      "httpdomain":<String_value>,
      "skipcacheredirectionhttptransaction":<String_value>,
      "builtin":<String[]_value>

}]}