ADC NITRO APIs

nstrace

May 23, 2024

Contributed by:

Configuration for nstrace operations resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
nf		Read-write	Number of files to be generated in cycle. Default value: 24 Minimum value = 1 Maximum value = 100
time		Read-write	Time per file (sec). Default value: 3600 Minimum value = 1
size		Read-write	Size of the captured data. Set 0 for full packet trace. Default value: 164 Minimum value = 0 Maximum value = 1514
mode	<String[]>	Read-write	Capturing mode for trace. Mode can be any of the following values or combination of these values RX Received packets before NIC pipelining (Filter does not work when RX capturing mode is ON) NEW_RX Received packets after NIC pipelining TX Transmitted packets TXB Packets buffered for transmission IPV6 Translated IPv6 packets C2C Capture C2C message NS_FR_TX TX/TXB packets are not captured in flow receiver. MPTCP MPTCP master flow HTTP_QUIC HTTP-over-QUIC stream data and stream events Default mode: NEW_RX TXB . Default value: DEFAULT_MODE Possible values = TX, TXB, RX, IPV6, NEW_RX, C2C, NS_FR_TX, APPFW, MPTCP, PolicyBased, HTTP_QUIC
pernic		Read-write	Use separate trace files for each interface. Works only with cap format. Default value: DISABLED Possible values = ENABLED, DISABLED
filename		Read-write	Name of the trace file.
fileid		Read-write	ID for the trace file name for uniqueness. Should be used only with -name option.
filter		Read-write	Filter expression for nstrace. Maximum length of filter is 255 and it can be of following format [ ] = \( ;; \\| \\|\\| ) = CONNECTION...() = SRCIP = \[ EQ \\| NE ] = A valid IPv4 address. example = CONNECTION.SRCIP.EQ(127.0.0.1) = DSTIP = \[ EQ \\| NE ] = A valid IPv4 address. example = CONNECTION.DSTIP.EQ(127.0.0.1) = IP = \[ EQ \\| NE ] = A valid IPv4 address. example = CONNECTION.IP.EQ(127.0.0.1) = SRCIPv6 = \[ EQ \\| NE ] = A valid IPv6 address. example = CONNECTION.SRCIPv6.EQ(2001:db8:0:0:1::1) = DSTIPv6 = \[ EQ \\| NE ] = A valid IPv6 address. example = CONNECTION.DSTIPv6.EQ(2001:db8:0:0:1::1) = IPv6 = \[ EQ \\| NE ] = A valid IPv6 address. example = CONNECTION.IPv6.EQ(2001:db8:0:0:1::1) = SRCPORT = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid port number. example = CONNECTION.SRCPORT.EQ(80) = DSTPORT = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid port number. example = CONNECTION.DSTPORT.EQ(80) = PORT = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid port number. example = CONNECTION.PORT.EQ(80) = VLANID = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid VLAN ID. example = CONNECTION.VLANID.EQ(0) = CONNID = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid PCB dev number. example = CONNECTION.CONNID.EQ(0) = PPEID = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid core ID. example = CONNECTION.PPEID.EQ(0) = SVCNAME = \[ EQ \\| NE \\| CONTAINS \\| STARTSWITH \\| ENDSWITH ] = A valid text string. example = CONNECTION.SVCNAME.EQ("name") = LB_VSERVER.NAME = \[ EQ \\| NE \\| CONTAINS \\| STARTSWITH \\| ENDSWITH ] = LB vserver name. example = CONNECTION.LB_VSERVER.NAME.EQ("name") = CS_VSERVER.NAME = \[ EQ \\| NE \\| CONTAINS \\| STARTSWITH \\| ENDSWITH ] = CS vserver name. example = CONNECTION.CS_VSERVER.NAME.EQ("name") = INTF = \[ EQ \\| NE ] = A valid interface id in the form of x/y. example = CONNECTION.INTF.EQ("x/y") = SERVICE_TYPE = \[ EQ \\| NE ] = \( SVC\_HTTP \\| FTP \\| TCP \\| UDP \\| SSL SSL\_BRIDGE \\| SSL\_TCP \\| NNTP \\| RPCSVR \\| RPCSVRS RPCCLNT \\| SVC\_DNS \\| ADNS \\| SNMP \\| RTSP \\| DHCPRA \\| ANY MONITOR \\| MONITOR\_UDP \\| MONITOR\_PING \\| SIP\_UDP SVC\_MYSQL \\| SVC\_MSSQL \\| FIX \\| SSL\_FIX \\| PKTSTEER SVC\_AAA \\| SERVICE\_UNKNOWN ) example = CONNECTION.SERVICE_TYPE.EQ(ANY) = TRAFFIC_DOMAIN_ID = \[ EQ \\| NE \\| GT \\| GE \\| LT \\| LE \\| BETWEEN ] = A valid traffic domain ID. example = CONNECTION.TRAFFIC_DOMAIN_ID.EQ(0) eg: start nstrace -filter \"CONNECTION.SRCIP.EQ\(127.0.0.1) \\|\\| \(CONNECTION.SVCNAME.NE\(\"s1\") ;; CONNECTION.SRCPORT.EQ\(80))\" The filter expression should be given in double quotes. common use cases Trace capturing full sized traffic from/to ip 10.102.44.111, excluding loopback traffic start nstrace -size 0 -filter "CONNECTION.IP.NE(127.0.0.1) ;; CONNECTION.IP.EQ(10.102.44.111)" Trace capturing all traffic to (terminating at) port 80 or 443 start nstrace -size 0 -filter \"CONNECTION.DSTPORT.EQ\(443) \\|\\| CONNECTION.DSTPORT.EQ\(80)\" Trace capturing all backend traffic specific to service service1 along with corresponding client side traffic start nstrace -size 0 -filter "CONNECTION.SVCNAME.EQ("service1")" -link ENABLED Trace capturing all traffic through Citrix ADC interface 1/1 start nstrace -filter "CONNECTION.INTF.EQ("1/1")" Trace capturing all traffic specific through vlan 2 start nstrace -filter "CONNECTION.VLANID.EQ(2)" Trace capturing all frontend (client side) traffic specific to lb vserver vserver1 along with corresponding server side traffic start nstrace -size 0 -filter "CONNECTION.LB_VSERVER.NAME.EQ("vserver1")" -link ENABLED .
link		Read-write	Includes filtered connection’s peer traffic. Default value: DISABLED Possible values = ENABLED, DISABLED
nodes	<Double[]>	Read-write	Nodes on which tracing is started. Minimum value = 0 Maximum value = 32
filesize		Read-write	File size, in MB, treshold for rollover. If free disk space is less than 2GB at the time of rollover, trace will stop . Default value: 1024 Minimum value = 0 Maximum value = 10240
traceformat		Read-write	Format in which trace will be generated . Default value: 0 Possible values = NSCAP, PCAP
merge		Read-write	Specify how traces across PE’s are merged . Default value: 0 Possible values = ONSTOP, ONTHEFLY, NOMERGE
doruntimecleanup		Read-write	Enable or disable runtime temp file cleanup. Default value: ENABLED Possible values = ENABLED, DISABLED
tracebuffers		Read-write	Number of 16KB trace buffers. Default value: 5000 Minimum value = 1000
skiprpc		Read-write	skip RPC packets. Default value: DISABLED Possible values = ENABLED, DISABLED
skiplocalssh		Read-write	skip local SSH packets. Default value: DISABLED Possible values = ENABLED, DISABLED
capsslkeys		Read-write	Capture SSL Master keys. Master keys will not be captured on FIPS machine. Warning: The captured keys can be used to decrypt information that may be confidential. The captured key files have to be stored in a secure environment. Default value: DISABLED Possible values = ENABLED, DISABLED
capdroppkt		Read-write	Captures Dropped Packets if set to ENABLED. Default value: DISABLED Possible values = ENABLED, DISABLED
inmemorytrace		Read-write	Logs packets in appliance’s memory and dumps the trace file on stopping the nstrace operation. Default value: DISABLED Possible values = ENABLED, DISABLED
nodeid		Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
state		Read-only	Current running state of trace. Default value: 0 Possible values = RUNNING, STOPPED
scope		Read-only	Scope of started trace, local or cluster level. Default value: 0 Possible values = CLUSTER, LOCAL
tracelocation		Read-only	Directory where current trace files are saved.

Operations

(click to see Properties )

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstrace Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nstrace? args=nodeid: <Double_value>

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

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:

{ "nstrace": [ {
nodeid:<Double_value>"state":<String_value>,
"scope":<String_value>,
"tracelocation":<String_value>,
"nf":<Double_value>,
"time":<Double_value>,
"size":<Double_value>,
"mode":<String[]_value>,
"traceformat":<String_value>,
"pernic":<String_value>,
"filename":<String_value>,
"fileid":<String_value>,
"filter":<String_value>,
"link":<String_value>,
"nodes":<Double[]_value>,
"merge":<String_value>,
"doruntimecleanup":<String_value>,
"tracebuffers":<Double_value>,
"skiprpc":<String_value>,
"skiplocalssh":<String_value>,
"capsslkeys":<String_value>,
"capdroppkt":<String_value>,
"inmemorytrace":<String_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

nstrace

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

nstrace

Properties

Operations

get (all)

In this article