active_ica_session

June 20, 2023

Contributed by:

Configuration for Af report for ICA Session resource.

Properties

(click to see Operations )

Name	Permissions	Description
serverside_packet_retransmits	Read-write	Server side packet retransmits..
launch_duration	Read-write	ica session launch duration..
host_delay	Read-write	Server induced delay..
total_bytes	Read-write	Total bytes accounted by this URL in sampled timeframe..
is_active	Read-write	Is Active..
pn_agent_version	Read-write	Name of ICA session pn agent version. Minimum length = 1 Maximum length = 128
client_latency	Read-write	ica session client latency..
client_side_ns_delay	Read-write	Client to Server Citrix ADC delay..
server_side_ns_delay	Read-write	Server to Client Citrix ADC delay..
session_reconnect	Read-write	Session reconnect..
application_enumeration_duration	Read-write	Time taken for app enumeration to launch..
serverside_rto	Read-write	serverside rto..
session_hop_diagram	Read-write	Session Hop Diagram.
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..
bandwidth	Read-write	Avg Bandwidth..
session_setup_time	Read-write	ICA Session setup time..
clientside_rto	Read-write	clientside rto..
session_rtt	Read-write	ICA Session rtt..
clientside_cb	Read-write	clientside cb.
client_version	Read-write	Client Version. Maximum length = 1024
__count	Read-write	count..
state	Read-write	ICA Session state..
client_type	Read-write	Client Type. Minimum length = 1 Maximum length = 128
euem	Read-write	EUEM..
l7_clientside_latency	Read-write	L7 clientside latency.
device_type	Read-write	Device Type..
server_jitter	Read-write	ICA User server jitter..
id	Read-write	Id is ICA Session ID. Minimum length = 1 Maximum length = 64
client_jitter	Read-write	ICA User client jitter..
server_latency	Read-write	ica session server latency..
is_multi_hop	Read-write	Is Multi hop..
serverside_0_win	Read-write	server side 0 window count..
serverside_cb	Read-write	serverside cb.
session_type	Read-write	Session Type.
session_duration	Read-write	session duration..
ica_rtt	Read-write	ICA rtt..
client_srtt	Read-write	client Smothen RTT..
edt_type	Read-write	EDT Type..
receiver_version	Read-write	Name of ICA session receiver version. Minimum length = 1 Maximum length = 128
vdi_image_name	Read-write	vdi_image_name.
up_time	Read-write	ica session up time..
client_tx_bytes	Read-write	Client Side Tx bytes..
client_rx_bytes	Read-write	Client Side Rx bytes..
server_srtt	Read-write	server Smothen RTT..
session_end_time	Read-write	ICA Session end time..
l7_serverside_latency	Read-write	L7 serverside 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

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/active_ica_session 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, "active_ica_session":[{
"serverside_packet_retransmits":<Double_value>,
"hdx_desktop_username":<String_value>,
"launch_duration":<Double_value>,
"host_delay":<Double_value>,
"total_bytes":<Double_value>,
"is_active":<Double_value>,
"client_ip_address":<String_value>,
"pn_agent_version":<String_value>,
"client_latency":<Double_value>,
"client_side_ns_delay":<Double_value>,
"server_side_ns_delay":<Double_value>,
"session_reconnect":<Double_value>,
"application_enumeration_duration":<Double_value>,
"serverside_rto":<Double_value>,
"session_hop_diagram":<Boolean_value>,
"clientside_packet_retransmits":<Double_value>,
"server_ip_address":<String_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"bandwidth":<Double_value>,
"session_setup_time":<Double_value>,
"clientside_rto":<Double_value>,
"ica_app_name":<String_value>,
"session_rtt":<Double_value>,
"clientside_cb":<Double_value>,
"client_version":<String_value>,
"ica_user_name":<String_value>,
"__count":<Double_value>,
"state":<String_value>,
"client_type":<String_value>,
"euem":<Double_value>,
"l7_clientside_latency":<Double_value>,
"device_type":<String_value>,
"server_jitter":<Double_value>,
"id":<String_value>,
"client_jitter":<Double_value>,
"server_latency":<Double_value>,
"is_multi_hop":<Double_value>,
"serverside_0_win":<Double_value>,
"serverside_cb":<Double_value>,
"session_type":<Double_value>,
"session_duration":<Double_value>,
"ica_rtt":<Double_value>,
"client_srtt":<Double_value>,
"edt_type":<String_value>,
"ica_device_ip_address":<String_value>,
"receiver_version":<String_value>,
"vdi_image_name":<String_value>,
"up_time":<Double_value>,
"client_tx_bytes":<Double_value>,
"client_rx_bytes":<Double_value>,
"server_srtt":<Double_value>,
"session_end_time":<Double_value>,
"l7_serverside_latency":<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

active_ica_session

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

active_ica_session

Properties

Operations

get (all)

In this article