related_desktop_session
Configuration for Af report for related HDX Desktop Session resource.
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. |
ip_block_name | <String> | Read-write | ip_block_name. |
latitude | <Double> | Read-write | latitude. |
longitude | <Double> | Read-write | longitude. |
region_code | <String> | Read-write | region_code. |
host_delay | <Double> | Read-write | Server induced delay.. |
region | <String> | Read-write | region. |
total_bytes | <Double> | Read-write | Total bytes.. |
client_latency | <Double> | Read-write | client latency.. |
client_side_ns_delay | <Double> | Read-write | Clinet to Server Citrix ADC delay.. |
server_side_ns_delay | <Double> | Read-write | Server to Client Citrix ADC delay.. |
serverside_rto | <Double> | Read-write | serverside rto.. |
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 |
rpt_sample_time | <Double> | Read-write | Report Sample time.. |
clientside_0_win | <Double> | Read-write | Client side 0 window count.. |
bandwidth | <Double> | Read-write | Avg Bandwidth.. |
session_setup_time | <Double> | Read-write | ICA Session setup time.. |
clientside_rto | <Double> | Read-write | clientside rto.. |
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.. |
__count | <Double> | Read-write | count.. |
country_code | <String> | Read-write | country_code. |
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. |
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. |
selected_time_total_byte | <Double> | Read-write | Total bytes accounted by this URL in sampled timeframe.. |
client_srtt | <Double> | Read-write | client Smothen RTT.. |
edt_type | <String> | Read-write | edt_type. |
city | <String> | Read-write | city. |
vdi_image_name | <String> | Read-write | vdi_image_name. |
up_time | <Double> | Read-write | hdx desktop session up time.. |
session_setup_time_local | <Double> | Read-write | ICA Session setup time in local timezone.. |
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 )
- 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/related_desktop_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, "related_desktop_session":[{
"serverside_packet_retransmits":<Double_value>,
"user_type":<String_value>,
"hdx_desktop_username":<String_value>,
"is_msi":<Double_value>,
"ip_block_name":<String_value>,
"latitude":<Double_value>,
"longitude":<Double_value>,
"region_code":<String_value>,
"host_delay":<Double_value>,
"region":<String_value>,
"total_bytes":<Double_value>,
"client_ip_address":<String_value>,
"client_latency":<Double_value>,
"client_side_ns_delay":<Double_value>,
"server_side_ns_delay":<Double_value>,
"serverside_rto":<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>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"bandwidth":<Double_value>,
"session_setup_time":<Double_value>,
"clientside_rto":<Double_value>,
"client_version":<String_value>,
"clientside_cb":<Double_value>,
"session_rtt":<Double_value>,
"__count":<Double_value>,
"country_code":<String_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>,
"acr_count":<Double_value>,
"session_duration":<Double_value>,
"ica_rtt":<Double_value>,
"sr_reconnect_count":<Double_value>,
"selected_time_total_byte":<Double_value>,
"client_srtt":<Double_value>,
"edt_type":<String_value>,
"ica_device_ip_address":<String_value>,
"city":<String_value>,
"vdi_image_name":<String_value>,
"up_time":<Double_value>,
"session_setup_time_local":<Double_value>,
"server_srtt":<Double_value>,
"session_end_time":<Double_value>,
"l7_serverside_latency":<Double_value>}]}
<!--NeedCopy-->