ica_user_session_hop_detail

June 20, 2023

Contributed by:

Configuration for Af report for ICA User Session Hop resource.

Properties

(click to see Operations )

Name	Permissions	Description
launch_duration	Read-write	ica session launch duration..
region_code	Read-write	region_code.
region	Read-write	region.
client_latency	Read-write	ica session client latency..
client_side_ns_delay	Read-write	Client to Server Citrix ADC delay..
country	Read-write	country.
clientside_packet_retransmits	Read-write	Client side packet retransmits..
rpt_sample_time	Read-write	Report Sample time..
clientside_0_win	Read-write	Client side 0 window count..
session_setup_time	Read-write	ICA Session setup time..
clientside_rto	Read-write	clientside rto..
session_rtt	Read-write	ICA Session rtt..
client_version	Read-write	Client Version. Maximum length = 1024
clientside_cb	Read-write	clientside cb.
__count	Read-write	count..
country_code	Read-write	country_code.
state	Read-write	ICA Session state..
client_type	Read-write	Client Type. Minimum length = 1 Maximum length = 128
l7_clientside_latency	Read-write	L7 clientside latency.
client_jitter	Read-write	ICA User client jitter..
id	Read-write	Id is ICA Session ID. Minimum length = 1 Maximum length = 64
client_srtt	Read-write	client Smothen RTT..
edt_type	Read-write	edt_type.
city	Read-write	city.
session_end_time	Read-write	ICA Session end time..

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ica_user_session_hop_detail Query-parameters:

HTTPS Method: GET

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ica_user_session_hop_detail

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ica_user_session_hop_detail

Properties

Operations

get (all)

In this article