hdx_desktop¶
Configuration for Af report for HDX Desktop resource.
(click to see Operations)
Properties¶
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ica_user_name | <String> | Read-write | ica_user_name. |
| client_srtt | <Double> | Read-write | client Smothen RTT.. |
| __count | <Double> | Read-write | count.. |
| active_session_count | <Double> | Read-write | active_session_count.. |
| hdx_desktop_username | <String> | Read-write | hdx_dektop_username. |
| desktop_count | <Double> | Read-write | desktop_count.. |
| ica_device_ip_address | <String> | Read-write | Ica device IP Address.. Minimum length = 1 Maximum length = 64 |
| active_desktop_count | <Double> | Read-write | ica active_desktop_count.. |
| id | <String> | Read-write | Id is HDX Desktop username. |
| ip_address | <String> | Read-write | IP Address.. Minimum length = 1 Maximum length = 64 |
| duration_summary_bandwidth | <Double> | Read-write | Avg Bandwidth for duration summary.. |
| active_session_duration | <Double> | Read-write | active session duration.. |
| server_latency | <Double> | Read-write | server latency.. |
| session_duration | <Double> | Read-write | session duration.. |
| name | <String> | Read-write | HDX Desktop Name. |
| total_bytes | <Double> | Read-write | Total bytes.. |
| rpt_sample_time | <Double> | Read-write | Report Sample time.. |
| client_subnet | <String> | Read-write | Client Subnet.. Maximum length = 64 |
| username | <String> | Read-write | username. |
| ica_rtt | <Double> | Read-write | ICA rtt.. |
| bandwidth | <Double> | Read-write | Avg Bandwidth.. |
| server_srtt | <Double> | Read-write | server Smothen RTT.. |
| selected_time_total_byte | <Double> | Read-write | Total bytes accounted by this URL in sampled timeframe.. |
| client_latency | <Double> | Read-write | client 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
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "hdx_desktop":[{ "ica_user_name":<String_value>, "client_srtt":<Double_value>, "__count":<Double_value>, "active_session_count":<Double_value>, "hdx_desktop_username":<String_value>, "desktop_count":<Double_value>, "ica_device_ip_address":<String_value>, "active_desktop_count":<Double_value>, "id":<String_value>, "ip_address":<String_value>, "duration_summary_bandwidth":<Double_value>, "active_session_duration":<Double_value>, "server_latency":<Double_value>, "session_duration":<Double_value>, "name":<String_value>, "total_bytes":<Double_value>, "rpt_sample_time":<Double_value>, "client_subnet":<String_value>, "username":<String_value>, "ica_rtt":<Double_value>, "bandwidth":<Double_value>, "server_srtt":<Double_value>, "selected_time_total_byte":<Double_value>, "client_latency":<Double_value>}]}