policytracing

Last published : Oct 30, 2026
Configuration for 0 resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
filterexpr <String> Read-write Policy tracing filter expression. For example: http.req.url.startswith("/this").
protocoltype <String> Read-write protocol type for which policy records needs to be collected.
Default value: HTTP
Possible values = HTTP, SSL, TCP, SSL_TCP, DNS, DNS_TCP, ANY
capturesslhandshakepolicies <String> Read-write Set it to yes if need to capture the SSL handshake policies.
Default value: NO
Possible values = YES, NO
transactionid <String> Read-write Unique ID to identify the current transaction.
detail <String> Read-write Show detailed information of the captured records.
Default value: all
Possible values = brief, all
nodeid <Integer> Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
packetengineid <Integer> Read-only The packet engine identifier.
clientip <String> Read-only The IP address of client.
destip <String> Read-only The IP address of destination.
srcport <Integer> Read-only Source port of the request.
destport <Integer> Read-only Destination port of the request.
transactiontime <String> Read-only Conveys time at which request processing started.
policytracingmodule <String> Read-only Module or feature for which policy is evaluated.
Possible values = SSL, DNS, DNS64, VPNTraffic, VPNSession, VPNURL, VPNApp, TMTraffic, TMSession, SAMLIdp, Authentication, Authorizaion, CacheRedirection, ContentSwitching, Bot Management, AppFw, ContentInspection, Responder, ContentOptimization, Video Optimization, CACHE, REWRITE, AppQoE, AppFlow, LB, Compression, TunnelTraffic, URLTRANS, CVPNRewrite
url <String> Read-only Request URL.
policynames <String[]> Read-only List of the policy names which are evaluated to true for this transaction.
isresponse <Integer> Read-only True if the current policy is evaluated on the request side.
isundefpolicy <Integer> Read-only True if the current policy is evaluated to undef.
policytracingrecordcount <Integer> Read-only Current record number.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • START
  • STOP
  • CLEAR
  • 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 red and placeholder content is marked in green

start

URL: http:// <netscaler-ip-address> /nitro/v1/config/policytracing? action=start HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"policytracing":{
<b>"filterexpr":<String_value>,
</b>"protocoltype":<String_value>,
"capturesslhandshakepolicies":<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

stop

URL: http:// <netscaler-ip-address> /nitro/v1/config/policytracing? action=stop HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"policytracing":{
}}
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

clear

URL: http:// <netscaler-ip-address> /nitro/v1/config/policytracing? action=clear HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"policytracing":{
}}
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/policytracing Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/policytracing? args=transactionid: <String_value> ,detail: <String_value> ,nodeid: <Integer_value>
Use this query-parameter to get policytracing resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/policytracing? 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/policytracing? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of policytracing resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/policytracing? view=summary
Use this query-parameter to get the summary output of policytracing resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/policytracing? pagesize=#no;pageno=#no
Use this query-parameter to get the policytracing 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 error
Response Header:
Content-Type:application/json
Response Payload:
{ "policytracing": [ {
transactionid:<String_value>,detail:<String_value>,nodeid:<Integer_value>"filterexpr":<String_value>,
"transactionid":<String_value>,
"packetengineid":<Integer_value>,
"clientip":<String_value>,
"destip":<String_value>,
"srcport":<Integer_value>,
"destport":<Integer_value>,
"transactiontime":<String_value>,
"policytracingmodule":<String_value>,
"url":<String_value>,
"policynames":<String[]_value>,
"isresponse":<Integer_value>,
"isundefpolicy":<Integer_value>,
"policytracingrecordcount":<Integer_value>,
"protocoltype":<String_value>,
"capturesslhandshakepolicies":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/policytracing? 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 error
Response Header:
Content-Type:application/json
Response Payload:
{ "policytracing": [ { "__count": "#no"} ] }