Skip to content

ica_session

Configuration for Af report for ICA Session resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
serverside_packet_retransmits<Double>Read-writeServer side packet retransmits..
user_type<String>Read-writeUser Access Type.
Minimum length = 1
Maximum length = 128
is_msi<Double>Read-writeIf Session is MSI or not.
count_usb_rejected<Double>Read-writeNo. of times USB Rejected.
ip_block_name<String>Read-writeip_block_name.
launch_duration<Double>Read-writeica session launch duration..
latitude<Double>Read-writelatitude.
l7_threshold_configure_value<Double>Read-writeL7 Threshold value.
longitude<Double>Read-writelongitude.
region_code<String>Read-writeregion_code.
region<String>Read-writeregion.
host_delay<Double>Read-writeServer induced delay..
total_bytes<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
is_active<Double>Read-writeIs Active..
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_hostname<String>Read-writecity.
Maximum length = 255
count_usb_accepted<Double>Read-writeNo. of times USB Accepted.
usb_status<Double>Read-writeUSB Redirection Status.
client_side_ns_delay<Double>Read-writeClinet to Server NS delay..
server_side_ns_delay<Double>Read-writeServer to Clinet NS delay..
application_enumeration_duration<Double>Read-writeTime taken for app enumeration to launch..
session_reconnect<Double>Read-writeSession reconnect..
serverside_rto<Double>Read-writeserverside rto..
l7_threshold_max_server_breach<Double>Read-writeL7 Threshold MAX Server Breach Value.
duration_summary_bandwidth<Double>Read-writeAvg Bandwidth for duration summary..
country<String>Read-writecountry.
session_hop_diagram<Boolean>Read-writeSession Hop Diagram.
clientside_packet_retransmits<Double>Read-writeClient side packet retransmits..
count_usb_stopped<Double>Read-writeNo. of times USB Stopped.
rpt_sample_time<Double>Read-writeReport Sample time..
clientside_0_win<Double>Read-writeClient side 0 window count..
session_setup_time<Double>Read-writeICA Session setup time..
bandwidth<Double>Read-writeAvg Bandwidth..
clientside_rto<Double>Read-writeclientside rto..
client_version<String>Read-writeClient Version.
Maximum length = 1024
clientside_cb<Double>Read-writeclientside cb.
session_rtt<Double>Read-writeICA Session rtt..
__count<Double>Read-writecount..
country_code<String>Read-writecountry_code.
l7_threshold_breach_count<Double>Read-writeL7 Threshold Breach Count Value.
state<String>Read-writeICA Session state..
client_type<String>Read-writeClient Type.
Minimum length = 1
Maximum length = 128
euem<Double>Read-writeEUEM..
l7_clientside_latency<Double>Read-writeL7 clientside latency.
device_type<String>Read-writeDevice Type..
server_jitter<Double>Read-writeICA User server jitter..
id<String>Read-writeId is ICA Session ID.
Minimum length = 1
Maximum length = 64
client_jitter<Double>Read-writeICA User client jitter..
server_latency<Double>Read-writeica session server latency..
is_multi_hop<Double>Read-writeIs Multi hop..
serverside_0_win<Double>Read-writeserver side 0 window count..
l7_threshold_max_client_breach<Double>Read-writeL7 Threshold MAX Client Breach Value.
serverside_cb<Double>Read-writeserverside cb.
l7_threshold_avg_client_breach<Double>Read-writeL7 Threshold AVG Client Breach Value.
session_type<Double>Read-writeSession Type.
acr_count<Double>Read-writeSession Reliability ACR Reconnect count.
sr_reconnect_count<Double>Read-writeSession Reliability Reconnect count.
ha_failover_count<Double>Read-writeha_failover_count.
selected_time_total_byte<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
l7_monitoring_supported<Double>Read-writeL7 monitoring Supported or not.
l7_threshold_avg_server_breach<Double>Read-writeL7 Threshold AVG Server Breach Value.
client_srtt<Double>Read-writeclient Smothen RTT..
city<String>Read-writecity.
receiver_version<String>Read-writeName of ICA session receiver version.
Minimum length = 1
Maximum length = 128
up_time<Double>Read-writeica session up time..
client_tx_bytes<Double>Read-writeClient Side Tx bytes..
session_setup_time_local<Double>Read-writeICA Session setup time in local timezone..
client_rx_bytes<Double>Read-writeClient Side Rx bytes..
server_srtt<Double>Read-writeserver Smothen RTT..
session_end_time<Double>Read-writeICA Session end time..
l7_serverside_latency<Double>Read-writeL7 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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ica_session":[{
"serverside_packet_retransmits":<Double_value>,
"user_type":<String_value>,
"is_msi":<Double_value>,
"count_usb_rejected":<Double_value>,
"ip_block_name":<String_value>,
"launch_duration":<Double_value>,
"latitude":<Double_value>,
"l7_threshold_configure_value":<Double_value>,
"longitude":<Double_value>,
"region_code":<String_value>,
"region":<String_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_hostname":<String_value>,
"count_usb_accepted":<Double_value>,
"usb_status":<Double_value>,
"client_side_ns_delay":<Double_value>,
"server_side_ns_delay":<Double_value>,
"application_enumeration_duration":<Double_value>,
"session_reconnect":<Double_value>,
"serverside_rto":<Double_value>,
"l7_threshold_max_server_breach":<Double_value>,
"duration_summary_bandwidth":<Double_value>,
"country":<String_value>,
"session_hop_diagram":<Boolean_value>,
"clientside_packet_retransmits":<Double_value>,
"server_ip_address":<String_value>,
"count_usb_stopped":<Double_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"session_setup_time":<Double_value>,
"bandwidth":<Double_value>,
"clientside_rto":<Double_value>,
"ica_app_name":<String_value>,
"client_version":<String_value>,
"clientside_cb":<Double_value>,
"session_rtt":<Double_value>,
"ica_user_name":<String_value>,
"__count":<Double_value>,
"country_code":<String_value>,
"l7_threshold_breach_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>,
"l7_threshold_max_client_breach":<Double_value>,
"serverside_cb":<Double_value>,
"l7_threshold_avg_client_breach":<Double_value>,
"session_type":<Double_value>,
"acr_count":<Double_value>,
"sr_reconnect_count":<Double_value>,
"ha_failover_count":<Double_value>,
"selected_time_total_byte":<Double_value>,
"l7_monitoring_supported":<Double_value>,
"l7_threshold_avg_server_breach":<Double_value>,
"client_srtt":<Double_value>,
"ica_device_ip_address":<String_value>,
"city":<String_value>,
"receiver_version":<String_value>,
"up_time":<Double_value>,
"client_tx_bytes":<Double_value>,
"session_setup_time_local":<Double_value>,
"client_rx_bytes":<Double_value>,
"server_srtt":<Double_value>,
"session_end_time":<Double_value>,
"l7_serverside_latency":<Double_value>}]}