hdx_desktop_session
Configuration for Af report for HDX Desktop Session resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| serverside_packet_retransmits | <Double> | Read-write | Server side packet retransmits.. |
| user_type | <String> | Read-write | User Access Type. Minimum length = 1 Maximum length = 128 |
| is_msi | <Double> | Read-write | If Session is MSI or not. |
| count_usb_rejected | <Double> | Read-write | No. of times USB Rejected. |
| ip_block_name | <String> | Read-write | ip_block_name. |
| launch_duration | <Double> | Read-write | ica session launch duration.. |
| latitude | <Double> | Read-write | latitude. |
| l7_threshold_configure_value | <Double> | Read-write | L7 Threshold value. |
| longitude | <Double> | Read-write | longitude. |
| region_code | <String> | Read-write | region_code. |
| region | <String> | Read-write | region. |
| host_delay | <Double> | Read-write | Server induced delay.. |
| total_bytes | <Double> | Read-write | Total bytes.. |
| 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 | client latency.. |
| client_hostname | <String> | Read-write | city. Maximum length = 255 |
| count_usb_accepted | <Double> | Read-write | No. of times USB Accepted. |
| usb_status | <Double> | Read-write | USB Redirection Status. |
| client_side_ns_delay | <Double> | Read-write | Clinet to Server NS delay.. |
| server_side_ns_delay | <Double> | Read-write | Server to Clinet NS delay.. |
| session_reconnect | <Double> | Read-write | Session reconnect.. |
| application_enumeration_duration | <Double> | Read-write | Time taken for app enumeration to launch.. |
| serverside_rto | <Double> | Read-write | serverside rto.. |
| l7_threshold_max_server_breach | <Double> | Read-write | L7 Threshold MAX Server Breach Value. |
| duration_summary_bandwidth | <Double> | Read-write | Avg Bandwidth for duration summary.. |
| country | <String> | Read-write | country. |
| session_hop_diagram | <Boolean> | Read-write | Session Hop Diagram. |
| clientside_packet_retransmits | <Double> | Read-write | Client side packet retransmits.. |
| server_ip_address | <String> | Read-write | Server IP Address.. Minimum length = 1 Maximum length = 64 |
| count_usb_stopped | <Double> | Read-write | No. of times USB Stopped. |
| rpt_sample_time | <Double> | Read-write | Report Sample time.. |
| clientside_0_win | <Double> | Read-write | Client side 0 window count.. |
| session_setup_time | <Double> | Read-write | ICA Session setup time.. |
| bandwidth | <Double> | Read-write | Avg Bandwidth.. |
| clientside_rto | <Double> | Read-write | clientside rto.. |
| session_rtt | <Double> | Read-write | ICA Session rtt.. |
| clientside_cb | <Double> | Read-write | clientside cb. |
| client_version | <String> | Read-write | Client Version. Maximum length = 1024 |
| __count | <Double> | Read-write | count.. |
| country_code | <String> | Read-write | country_code. |
| l7_threshold_breach_count | <Double> | Read-write | L7 Threshold Breach Count Value. |
| state | <String> | Read-write | Desktop Session state.. |
| client_type | <String> | Read-write | Client Type. Minimum length = 1 Maximum length = 128 |
| euem | <Double> | Read-write | EUEM.. |
| l7_clientside_latency | <Double> | Read-write | L7 clientside latency. |
| device_type | <String> | Read-write | Device Type.. |
| server_jitter | <Double> | Read-write | ICA User server jitter.. |
| id | <String> | Read-write | Id is HDX Desktop user session ID. |
| client_jitter | <Double> | Read-write | ICA User client jitter.. |
| server_latency | <Double> | Read-write | server latency.. |
| is_multi_hop | <Double> | Read-write | Is Multi hop.. |
| serverside_0_win | <Double> | Read-write | server side 0 window count.. |
| serverside_cb | <Double> | Read-write | serverside cb. |
| l7_threshold_max_client_breach | <Double> | Read-write | L7 Threshold MAX Client Breach Value. |
| l7_threshold_avg_client_breach | <Double> | Read-write | L7 Threshold AVG Client Breach Value. |
| acr_count | <Double> | Read-write | Session Reliability ACR count. |
| session_duration | <Double> | Read-write | session duration.. |
| ica_rtt | <Double> | Read-write | ICA rtt.. |
| sr_reconnect_count | <Double> | Read-write | Session Reliability Reconnect count. |
| ha_failover_count | <Double> | Read-write | ha_failover_count. |
| selected_time_total_byte | <Double> | Read-write | Total bytes accounted by this URL in sampled timeframe.. |
| l7_monitoring_supported | <Double> | Read-write | L7 monitoring Supported or not. |
| client_srtt | <Double> | Read-write | client Smothen RTT.. |
| l7_threshold_avg_server_breach | <Double> | Read-write | L7 Threshold AVG Server Breach Value. |
| city | <String> | Read-write | city. |
| receiver_version | <String> | Read-write | Name of ICA session receiver version. Minimum length = 1 Maximum length = 128 |
| vdi_image_name | <String> | Read-write | vdi_image_name. |
| up_time | <Double> | Read-write | ica session up time.. |
| client_tx_bytes | <Double> | Read-write | Client Side Tx bytes.. |
| session_setup_time_local | <Double> | Read-write | ICA Session setup time in local timezone.. |
| client_rx_bytes | <Double> | Read-write | Client Side Rx bytes.. |
| server_srtt | <Double> | Read-write | server Smothen 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)
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/hdx_desktop_session
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "hdx_desktop_session":[{
"serverside_packet_retransmits":<Double_value>,
"user_type":<String_value>,
"is_msi":<Double_value>,
"hdx_desktop_username":<String_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>,
"session_reconnect":<Double_value>,
"application_enumeration_duration":<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>,
"session_rtt":<Double_value>,
"clientside_cb":<Double_value>,
"client_version":<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>,
"serverside_cb":<Double_value>,
"l7_threshold_max_client_breach":<Double_value>,
"l7_threshold_avg_client_breach":<Double_value>,
"acr_count":<Double_value>,
"session_duration":<Double_value>,
"ica_rtt":<Double_value>,
"sr_reconnect_count":<Double_value>,
"ha_failover_count":<Double_value>,
"selected_time_total_byte":<Double_value>,
"l7_monitoring_supported":<Double_value>,
"client_srtt":<Double_value>,
"l7_threshold_avg_server_breach":<Double_value>,
"ica_device_ip_address":<String_value>,
"city":<String_value>,
"receiver_version":<String_value>,
"vdi_image_name":<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>}]}