Download full document:

appfwtransactionrecords

Configuration for Application firewall transaction record resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
nodeid<Double>Read-writeUnique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
httptransactionid<Double>Read-onlyThe http transaction identifier.
packetengineid<Integer>Read-onlyThe packet engine identifier.
appfwsessionid<String>Read-onlyThe session identifier set by the Application Firewall to track the user session.
profilename<String>Read-onlyApplication Firewall profile name.
url<String>Read-onlyRequest URL.
clientip<String>Read-onlyThe IP address of client.
destip<String>Read-onlyThe IP address of destination.
starttime<String>Read-onlyConveys time at which request processing started.
endtime<String>Read-onlyConveys time at which request processing end.
requestcontentlength<Integer>Read-onlyThe content length of request.
requestyields<Double>Read-onlyThe number of times yielded during request processing to send heart beat packets.
requestmaxprocessingtime<Double>Read-onlyThe maximum processing time across yields during request processing.
responsecontentlength<Integer>Read-onlyThe content length of response.
responseyields<Double>Read-onlyThe number of times yielded during response processing to send heart beat packets.
responsemaxprocessingtime<Double>Read-onlyThe maximum processing time across yields during response processing.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

GET (ALL)| COUNT

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 redand placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?args=nodeid:<Double_value>

Use this query-parameter to get appfwtransactionrecords resources based on additional properties.

attrs

http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?pagesize=#no;pageno=#no

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

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "appfwtransactionrecords": [ {
nodeid:<Double_value>"httptransactionid":<Double_value>,
"packetengineid":<Integer_value>,
"appfwsessionid":<String_value>,
"profilename":<String_value>,
"url":<String_value>,
"clientip":<String_value>,
"destip":<String_value>,
"starttime":<String_value>,
"endtime":<String_value>,
"requestcontentlength":<Integer_value>,
"requestyields":<Double_value>,
"requestmaxprocessingtime":<Double_value>,
"responsecontentlength":<Integer_value>,
"responseyields":<Double_value>,
"responsemaxprocessingtime":<Double_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/appfwtransactionrecords?count=yes

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "appfwtransactionrecords": [ { "__count": "#no"} ] }