Download full document:


Configuration for 0 resource.


(click to see Operations)

NameData TypePermissionsDescription
S<Boolean>Read-writePrint a summary of how many probes were not answered for each hop.
n<Boolean>Read-writePrint hop addresses numerically instead of symbolically and numerically.
r<Boolean>Read-writeBypass normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned.
v<Boolean>Read-writeVerbose output. List received ICMP packets other than TIME_EXCEEDED and UNREACHABLE.
M<Double>Read-writeMinimum TTL value used in outgoing probe packets.
Default value: 1
Minimum value = 1
Maximum value = 255
m<Integer>Read-writeMaximum TTL value used in outgoing probe packets. For Nitro API, default value is taken as 10.
Default value: 64
Minimum value = 1
Maximum value = 255
P<String>Read-writeSend packets of specified IP protocol. The currently supported protocols are UDP and ICMP.
Minimum length = 1
Maximum length = 20
p<Integer>Read-writeBase port number used in probes.
Default value: 33434
Minimum value = 1
Maximum value = 65535
q<Integer>Read-writeNumber of queries per hop. For Nitro API, defalut value is taken as 1.
Default value: 3
Minimum value = 1
Maximum value = 65535
s<String>Read-writeSource IP address to use in the outgoing query packets. If the IP address does not belong to this appliance, an error is returned and nothing is sent.
Minimum length = 1
T<Double>Read-writeTraffic Domain Id.
Minimum value = 1
Maximum value = 4094
t<Integer>Read-writeType-of-service in query packets.
Minimum value = 0
Maximum value = 255
w<Integer>Read-writeTime (in seconds) to wait for a response to a query. For Nitro API, defalut value is set to 3.
Default value: 5
Minimum value = 2
Maximum value = 86399
host<String>Read-writeDestination host IP address or name.
Minimum length = 1
Maximum length = 64
packetlen<Integer>Read-writeLength (in bytes) of the query packets.
Default value: 44
Minimum value = 44
Maximum value = 32768


(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:


    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:



    Note:In such cases, make sure that the request header DOES not include the following:



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




Request Headers:

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

Request Payload:



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 Payload:

{ "traceroute": [ {