Skip to content
Was this article helpful?


Configuration for Af report for related HDX Desktop Session resource.


(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
__count <Double> Read-write count..
country_code <String> Read-write country_code.
is_msi <Double> Read-write If Session is MSI or not.
state <String> Read-write Desktop Session state..
ip_block_name <String> Read-write ip_block_name.
euem <Double> Read-write EUEM..
client_type <String> Read-write Client Type.

Minimum length = 1

Maximum length = 128
device_type <String> Read-write Device Type..
l7_clientside_latency <Double> Read-write L7 clientside latency.
latitude <Double> Read-write latitude.
server_jitter <Double> Read-write ICA User server jitter..
client_jitter <Double> Read-write ICA User client jitter..
id <String> Read-write Id is HDX Desktop user session ID.
serverside_0_win <Double> Read-write server side 0 window count..
is_multi_hop <Double> Read-write Is Multi hop..
server_latency <Double> Read-write server latency..
serverside_cb <Double> Read-write serverside cb.
longitude <Double> Read-write longitude.
acr_count <Double> Read-write Session Reliability ACR count.
region_code <String> Read-write region_code.
region <String> Read-write region.
host_delay <Double> Read-write Server induced delay..
session_duration <Double> Read-write session duration..
total_bytes <Double> Read-write Total bytes..
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_latency <Double> Read-write client latency..
client_srtt <Double> Read-write client Smothen RTT..
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..
edt_type <String> Read-write edt_type.
city <String> Read-write city.
serverside_rto <Double> Read-write serverside rto..
vdi_image_name <String> Read-write vdi_image_name.
duration_summary_bandwidth <Double> Read-write Avg Bandwidth for duration summary..
country <String> Read-write country.
up_time <Double> Read-write hdx desktop session up time..
session_hop_diagram <Boolean> Read-write Session Hop Diagram.
session_setup_time_local <Double> Read-write ICA Session setup time in local timezone..
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..
session_setup_time <Double> Read-write ICA Session setup time..
bandwidth <Double> Read-write Avg Bandwidth..
clientside_rto <Double> Read-write clientside rto..
server_srtt <Double> Read-write server Smothen RTT..
session_rtt <Double> Read-write ICA Session rtt..
session_end_time <Double> Read-write ICA Session end time..
clientside_cb <Double> Read-write clientside cb.
client_version <String> Read-write Client Version.

Maximum length = 1024
l7_serverside_latency <Double> Read-write L7 serverside latency.


(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>


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




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:


Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "related_desktop_session":[{
Was this article helpful?