Product Documentation

nsappflowparam

Sep 07, 2016

Configuration for appflowParam resource.

Properties (click to see Operations)

Name Data Type Permissions Description
templaterefresh
<Double>
Read-write
IPFIX template refresh interval (in seconds).
Default value: 600
Minimum value = 60
Maximum value = 3600
udppmtu
<Double>
Read-write
MTU to be used for IPFIX UDP packets.
Default value: 1472
Minimum value = 128
Maximum value = 1472
httpurl
<String>
Read-write
Enable AppFlow HTTP URL logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpcookie
<String>
Read-write
Enable AppFlow HTTP cookie logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpreferer
<String>
Read-write
Enable AppFlow HTTP referer logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpmethod
<String>
Read-write
Enable AppFlow HTTP method logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httphost
<String>
Read-write
Enable AppFlow HTTP host logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpuseragent
<String>
Read-write
Enable AppFlow HTTP user-agent logging.
Default value: DISABLED
Possible values = ENABLED, DISABLED
clienttrafficonly
<String>
Read-write
Control whether AppFlow records should be generated only for client-side traffic.
Default value: NO
Possible values = YES, NO

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>

메모

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

update

URL: http://<netscaler-ip-address>/nitro/v1/config/nsappflowparam

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsappflowparam":{
      "templaterefresh":<Double_value>,
      "udppmtu":<Double_value>,
      "httpurl":<String_value>,
      "httpcookie":<String_value>,
      "httpreferer":<String_value>,
      "httpmethod":<String_value>,
      "httphost":<String_value>,
      "httpuseragent":<String_value>,
      "clienttrafficonly":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/nsappflowparam?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsappflowparam":{
      "templaterefresh":true,
      "udppmtu":true,
      "httpurl":true,
      "httpcookie":true,
      "httpreferer":true,
      "httpmethod":true,
      "httphost":true,
      "httpuseragent":true,
      "clienttrafficonly":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/nsappflowparam

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nsappflowparam": [ {
      "templaterefresh":<Double_value>,
      "udppmtu":<Double_value>,
      "httpurl":<String_value>,
      "httpcookie":<String_value>,
      "httpreferer":<String_value>,
      "httpmethod":<String_value>,
      "httphost":<String_value>,
      "httpuseragent":<String_value>,
      "clienttrafficonly":<String_value>
}]}