Skip to content


Configuration for Af report for ICA Device Session hop detail resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
is_gateway<Boolean>Read-writeIs this device acting as Gateway..
name<String>Read-writeName of ICA Device.
Minimum length = 1
Maximum length = 128
license<String>Read-writeFeature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum).
Minimum length = 1
Maximum length = 64
device_ip_address<String>Read-writeICA Device IP Address..
Minimum length = 1
Maximum length = 64
id<String>Read-writeId is ICA Device IPAddress.
Minimum length = 1
Maximum length = 64
server_latency<Double>Read-writeica session server latency..
client_latency<Double>Read-writeica session client latency..
version<String>Read-onlyDevice Version.
instance_state<String>Read-onlyState of device, UP only if device accessible.


(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 red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ica_device_session_hop_detail

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ica_device_session_hop_detail":[{