Download full document:

ica_user_session_hop_detail

Configuration for Af report for ICA User Session Hop resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
client_srtt<Double>Read-writeclient Smothen RTT..
__count<Double>Read-writecount..
country_code<String>Read-writecountry_code.
client_side_ns_delay<Double>Read-writeClinet to Server NS delay..
state<String>Read-writeICA Session state..
client_type<String>Read-writeClient Type.
Minimum length = 1
Maximum length = 128
city<String>Read-writecity.
l7_clientside_latency<Double>Read-writeL7 clientside latency.
launch_duration<Double>Read-writeica session launch duration..
id<String>Read-writeId is ICA Session ID.
Minimum length = 1
Maximum length = 64
client_jitter<Double>Read-writeICA User client jitter..
country<String>Read-writecountry.
region_code<String>Read-writeregion_code.
clientside_packet_retransmits<Double>Read-writeClient side packet retransmits..
region<String>Read-writeregion.
rpt_sample_time<Double>Read-writeReport Sample time..
clientside_0_win<Double>Read-writeClient side 0 window count..
session_setup_time<Double>Read-writeICA Session setup time..
clientside_rto<Double>Read-writeclientside rto..
clientside_cb<Double>Read-writeclientside cb.
client_version<String>Read-writeClient Version.
Maximum length = 1024
session_end_time<Double>Read-writeICA Session end time..
session_rtt<Double>Read-writeICA Session rtt..
client_latency<Double>Read-writeica session client latency..

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: https://<MGMT-IP>/nitro/v1/config/ica_user_session_hop_detail

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ica_user_session_hop_detail":[{
"client_srtt":<Double_value>,
"ica_user_name":<String_value>,
"__count":<Double_value>,
"country_code":<String_value>,
"client_side_ns_delay":<Double_value>,
"state":<String_value>,
"client_type":<String_value>,
"city":<String_value>,
"l7_clientside_latency":<Double_value>,
"launch_duration":<Double_value>,
"id":<String_value>,
"client_jitter":<Double_value>,
"country":<String_value>,
"region_code":<String_value>,
"clientside_packet_retransmits":<Double_value>,
"region":<String_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"session_setup_time":<Double_value>,
"clientside_rto":<Double_value>,
"client_ip_address":<String_value>,
"clientside_cb":<Double_value>,
"client_version":<String_value>,
"session_end_time":<Double_value>,
"session_rtt":<Double_value>,
"client_latency":<Double_value>}]}