Skip to content

related_desktop_session

Configuration for Af report for related HDX Desktop 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
__count<Double>Read-writecount..
country_code<String>Read-writecountry_code.
is_msi<Double>Read-writeIf Session is MSI or not.
state<String>Read-writeDesktop Session state..
ip_block_name<String>Read-writeip_block_name.
euem<Double>Read-writeEUEM..
client_type<String>Read-writeClient Type.
Minimum length = 1
Maximum length = 128
device_type<String>Read-writeDevice Type..
l7_clientside_latency<Double>Read-writeL7 clientside latency.
latitude<Double>Read-writelatitude.
server_jitter<Double>Read-writeICA User server jitter..
client_jitter<Double>Read-writeICA User client jitter..
id<String>Read-writeId is HDX Desktop user session ID.
serverside_0_win<Double>Read-writeserver side 0 window count..
is_multi_hop<Double>Read-writeIs Multi hop..
server_latency<Double>Read-writeserver latency..
serverside_cb<Double>Read-writeserverside cb.
longitude<Double>Read-writelongitude.
acr_count<Double>Read-writeSession Reliability ACR count.
region_code<String>Read-writeregion_code.
region<String>Read-writeregion.
host_delay<Double>Read-writeServer induced delay..
session_duration<Double>Read-writesession duration..
total_bytes<Double>Read-writeTotal bytes..
ica_rtt<Double>Read-writeICA rtt..
sr_reconnect_count<Double>Read-writeSession Reliability Reconnect count.
selected_time_total_byte<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
client_latency<Double>Read-writeclient latency..
client_srtt<Double>Read-writeclient Smothen RTT..
client_side_ns_delay<Double>Read-writeClinet to Server NS delay..
server_side_ns_delay<Double>Read-writeServer to Clinet NS delay..
city<String>Read-writecity.
serverside_rto<Double>Read-writeserverside rto..
vdi_image_name<String>Read-writevdi_image_name.
duration_summary_bandwidth<Double>Read-writeAvg Bandwidth for duration summary..
country<String>Read-writecountry.
up_time<Double>Read-writehdx desktop session up time..
session_hop_diagram<Boolean>Read-writeSession Hop Diagram.
session_setup_time_local<Double>Read-writeICA Session setup time in local timezone..
clientside_packet_retransmits<Double>Read-writeClient side packet retransmits..
server_ip_address<String>Read-writeServer IP Address..
Minimum length = 1
Maximum length = 64
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..
server_srtt<Double>Read-writeserver Smothen RTT..
session_rtt<Double>Read-writeICA Session rtt..
session_end_time<Double>Read-writeICA Session end time..
clientside_cb<Double>Read-writeclientside cb.
client_version<String>Read-writeClient Version.
Maximum length = 1024
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/related_desktop_session

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "related_desktop_session":[{
"serverside_packet_retransmits":<Double_value>,
"user_type":<String_value>,
"__count":<Double_value>,
"country_code":<String_value>,
"is_msi":<Double_value>,
"hdx_desktop_username":<String_value>,
"state":<String_value>,
"ip_block_name":<String_value>,
"euem":<Double_value>,
"client_type":<String_value>,
"device_type":<String_value>,
"l7_clientside_latency":<Double_value>,
"latitude":<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>,
"longitude":<Double_value>,
"acr_count":<Double_value>,
"region_code":<String_value>,
"region":<String_value>,
"host_delay":<Double_value>,
"session_duration":<Double_value>,
"total_bytes":<Double_value>,
"ica_rtt":<Double_value>,
"sr_reconnect_count":<Double_value>,
"client_ip_address":<String_value>,
"selected_time_total_byte":<Double_value>,
"client_latency":<Double_value>,
"client_srtt":<Double_value>,
"client_side_ns_delay":<Double_value>,
"server_side_ns_delay":<Double_value>,
"ica_device_ip_address":<String_value>,
"city":<String_value>,
"serverside_rto":<Double_value>,
"vdi_image_name":<String_value>,
"duration_summary_bandwidth":<Double_value>,
"country":<String_value>,
"up_time":<Double_value>,
"session_hop_diagram":<Boolean_value>,
"session_setup_time_local":<Double_value>,
"clientside_packet_retransmits":<Double_value>,
"server_ip_address":<String_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"session_setup_time":<Double_value>,
"bandwidth":<Double_value>,
"clientside_rto":<Double_value>,
"server_srtt":<Double_value>,
"session_rtt":<Double_value>,
"session_end_time":<Double_value>,
"clientside_cb":<Double_value>,
"client_version":<String_value>,
"l7_serverside_latency":<Double_value>}]}