Skip to content
Was this article helpful?


Configuration for 0 resource.


(click to see Operations)

NameData TypePermissionsDescription
c<Double>Read-writeNumber of packets to send. The default value is infinite. For Nitro API, defalut value is taken as 5.
Minimum value = 1
Maximum value = 65535
i<Double>Read-writeWaiting time, in seconds. The default value is 1 second.
Minimum value = 0
Maximum value = 65535
I<String>Read-writeNetwork interface on which to ping, if you have multiple interfaces.
Minimum length = 1
Maximum length = 15
n<Boolean>Read-writeNumeric output only. No name resolution.
p<String>Read-writePattern to fill in packets. Can be up to 16 bytes, useful for diagnosing data-dependent problems.
Minimum length = 1
Maximum length = 32
q<Boolean>Read-writeQuiet output. Only the summary is printed. For Nitro API, this flag is set by default.
s<Double>Read-writeData size, in bytes. The default value is 56.
Minimum value = 0
Maximum value = 65507
S<String>Read-writeSource IP address to be used in the outgoing query packets. If the IP addrESS does not belongs 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<Double>Read-writeTime-out, in seconds, before ping exits.
Minimum value = 1
Maximum value = 3600
hostName<String>Read-writeAddress of host to ping.
Minimum length = 1
Maximum length = 256


(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 Citrix ADC 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 Citrix ADC 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Payload:

{ "ping": [ {

Was this article helpful?