Skip to content

inactive_ica_session

Configuration for Af report for ICA Session InActive resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
__count<Double>Read-writecount..
state<String>Read-writeICA Session state..
device_type<String>Read-writeDevice Type..
launch_duration<Double>Read-writeica session launch duration..
server_jitter<Double>Read-writeICA User server jitter..
client_jitter<Double>Read-writeICA User client jitter..
id<String>Read-writeId is ICA Session ID.
Minimum length = 1
Maximum length = 64
serverside_0_win<Double>Read-writeserver side 0 window count..
server_latency<Double>Read-writeica session server latency..
session_type<Double>Read-writeSession Type.
session_duration<Double>Read-writesession duration..
total_bytes<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
ica_rtt<Double>Read-writeICA rtt..
pn_agent_version<String>Read-writeName of ICA session pn agent version.
Minimum length = 1
Maximum length = 128
client_latency<Double>Read-writeica session client latency..
client_srtt<Double>Read-writeclient Smothen RTT..
receiver_version<String>Read-writeName of ICA session receiver version.
Minimum length = 1
Maximum length = 128
application_enumeration_duration<Double>Read-writeTime taken for app enumeration to launch..
serverside_rto<Double>Read-writeserverside rto..
vdi_image_name<String>Read-writevdi_image_name.
up_time<Double>Read-writeica session up time..
client_tx_bytes<Double>Read-writeClient Side Tx bytes..
rpt_sample_time<Double>Read-writeReport Sample time..
clientside_0_win<Double>Read-writeClient side 0 window count..
client_rx_bytes<Double>Read-writeClient Side Rx bytes..
session_setup_time<Double>Read-writeICA Session setup time..
bandwidth<Double>Read-writeAvg Bandwidth..
clientside_rto<Double>Read-writeclientside rto..
server_srtt<Double>Read-writeserver Smothen RTT..
session_rtt<Double>Read-writeICA Session rtt..
session_end_time<Double>Read-writeICA 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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "inactive_ica_session":[{
"ica_user_name":<String_value>,
"__count":<Double_value>,
"hdx_desktop_username":<String_value>,
"state":<String_value>,
"device_type":<String_value>,
"launch_duration":<Double_value>,
"server_jitter":<Double_value>,
"client_jitter":<Double_value>,
"id":<String_value>,
"serverside_0_win":<Double_value>,
"server_latency":<Double_value>,
"session_type":<Double_value>,
"session_duration":<Double_value>,
"total_bytes":<Double_value>,
"ica_rtt":<Double_value>,
"client_ip_address":<String_value>,
"pn_agent_version":<String_value>,
"client_latency":<Double_value>,
"client_srtt":<Double_value>,
"ica_device_ip_address":<String_value>,
"receiver_version":<String_value>,
"application_enumeration_duration":<Double_value>,
"serverside_rto":<Double_value>,
"vdi_image_name":<String_value>,
"up_time":<Double_value>,
"client_tx_bytes":<Double_value>,
"server_ip_address":<String_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"client_rx_bytes":<Double_value>,
"session_setup_time":<Double_value>,
"bandwidth":<Double_value>,
"clientside_rto":<Double_value>,
"ica_app_name":<String_value>,
"server_srtt":<Double_value>,
"session_rtt":<Double_value>,
"session_end_time":<Double_value>}]}