Developer Documentation
Citrix ADM NITRO API Reference

inactive_ica_session

June 20, 2023
Contributed by: 
C

Configuration for Af report for ICA Session InActive resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
launch_duration Read-write ica session launch duration..
total_bytes Read-write Total bytes accounted by this URL in sampled timeframe..
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..
application_enumeration_duration Read-write Time taken for app enumeration to launch..
serverside_rto Read-write serverside rto..
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..
__count Read-write count..
state Read-write ICA Session state..
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..
serverside_0_win Read-write server side 0 window count..
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..

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/inactive_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, "inactive_ica_session":[{
"hdx_desktop_username":<String_value>,
"launch_duration":<Double_value>,
"total_bytes":<Double_value>,
"client_ip_address":<String_value>,
"pn_agent_version":<String_value>,
"client_latency":<Double_value>,
"application_enumeration_duration":<Double_value>,
"serverside_rto":<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>,
"ica_user_name":<String_value>,
"__count":<Double_value>,
"state":<String_value>,
"device_type":<String_value>,
"server_jitter":<Double_value>,
"id":<String_value>,
"client_jitter":<Double_value>,
"server_latency":<Double_value>,
"serverside_0_win":<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>}]}

<!--NeedCopy-->
inactive_ica_session
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.