-
-
-
-
-
-
-
nstrace
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
nstrace
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 [ |
|
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>
}]}
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.