Skip to content
Was this article helpful?

active_ica_session

Configuration for Af report for ICA Session resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
serverside_packet_retransmits <Double> Read-write Server side packet retransmits..
__count <Double> Read-write count..
state <String> Read-write ICA Session state..
euem <Double> Read-write EUEM..
client_type <String> Read-write Client Type.

Minimum length = 1

Maximum length = 128
device_type <String> Read-write Device Type..
l7_clientside_latency <Double> Read-write L7 clientside latency.
launch_duration <Double> Read-write ica session launch duration..
server_jitter <Double> Read-write ICA User server jitter..
client_jitter <Double> Read-write ICA User client jitter..
id <String> Read-write Id is ICA Session ID.

Minimum length = 1

Maximum length = 64
serverside_0_win <Double> Read-write server side 0 window count..
is_multi_hop <Double> Read-write Is Multi hop..
server_latency <Double> Read-write ica session server latency..
serverside_cb <Double> Read-write serverside cb.
session_type <Double> Read-write Session Type.
session_duration <Double> Read-write session duration..
host_delay <Double> Read-write Server induced delay..
total_bytes <Double> Read-write Total bytes accounted by this URL in sampled timeframe..
ica_rtt <Double> Read-write ICA rtt..
is_active <Double> Read-write Is Active..
pn_agent_version <String> Read-write Name of ICA session pn agent version.

Minimum length = 1

Maximum length = 128
client_latency <Double> Read-write ica session client latency..
client_srtt <Double> Read-write client Smothen RTT..
client_side_ns_delay <Double> Read-write Client to Server Citrix ADC delay..
server_side_ns_delay <Double> Read-write Server to Client Citrix ADC delay..
edt_type <String> Read-write EDT Type..
receiver_version <String> Read-write Name of ICA session receiver version.

Minimum length = 1

Maximum length = 128
application_enumeration_duration <Double> Read-write Time taken for app enumeration to launch..
session_reconnect <Double> Read-write Session reconnect..
serverside_rto <Double> Read-write serverside rto..
vdi_image_name <String> Read-write vdi_image_name.
up_time <Double> Read-write ica session up time..
session_hop_diagram <Boolean> Read-write Session Hop Diagram.
client_tx_bytes <Double> Read-write Client Side Tx bytes..
clientside_packet_retransmits <Double> Read-write Client side packet retransmits..
rpt_sample_time <Double> Read-write Report Sample time..
clientside_0_win <Double> Read-write Client side 0 window count..
client_rx_bytes <Double> Read-write Client Side Rx bytes..
session_setup_time <Double> Read-write ICA Session setup time..
bandwidth <Double> Read-write Avg Bandwidth..
clientside_rto <Double> Read-write clientside rto..
server_srtt <Double> Read-write server Smothen RTT..
client_version <String> Read-write Client Version.

Maximum length = 1024
clientside_cb <Double> Read-write clientside cb.
session_rtt <Double> Read-write ICA Session rtt..
session_end_time <Double> Read-write ICA Session end time..
l7_serverside_latency <Double> 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>,
      "ica_user_name":<String_value>,
      "__count":<Double_value>,
      "hdx_desktop_username":<String_value>,
      "state":<String_value>,
      "euem":<Double_value>,
      "client_type":<String_value>,
      "device_type":<String_value>,
      "l7_clientside_latency":<Double_value>,
      "launch_duration":<Double_value>,
      "server_jitter":<Double_value>,
      "client_jitter":<Double_value>,
      "id":<String_value>,
      "serverside_0_win":<Double_value>,
      "is_multi_hop":<Double_value>,
      "server_latency":<Double_value>,
      "serverside_cb":<Double_value>,
      "session_type":<Double_value>,
      "session_duration":<Double_value>,
      "host_delay":<Double_value>,
      "total_bytes":<Double_value>,
      "ica_rtt":<Double_value>,
      "is_active":<Double_value>,
      "client_ip_address":<String_value>,
      "pn_agent_version":<String_value>,
      "client_latency":<Double_value>,
      "client_srtt":<Double_value>,
      "client_side_ns_delay":<Double_value>,
      "server_side_ns_delay":<Double_value>,
      "edt_type":<String_value>,
      "ica_device_ip_address":<String_value>,
      "receiver_version":<String_value>,
      "application_enumeration_duration":<Double_value>,
      "session_reconnect":<Double_value>,
      "serverside_rto":<Double_value>,
      "vdi_image_name":<String_value>,
      "up_time":<Double_value>,
      "session_hop_diagram":<Boolean_value>,
      "client_tx_bytes":<Double_value>,
      "clientside_packet_retransmits":<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>,
      "client_version":<String_value>,
      "clientside_cb":<Double_value>,
      "session_rtt":<Double_value>,
      "session_end_time":<Double_value>,
      "l7_serverside_latency":<Double_value>}]}
Was this article helpful?