Developer Documentation
Citrix ADM NITRO API Reference

hdx_desktop

June 20, 2023
Contributed by: 
C

Configuration for Af report for HDX Desktop resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ica_user_name Read-write ica_user_name.
client_srtt Read-write client Smothen RTT..
__count Read-write count..
active_session_count Read-write active_session_count..
hdx_desktop_username Read-write hdx_dektop_username.
edt_type Read-write edt_type.
desktop_count Read-write desktop_count..
ica_device_ip_address Read-write Ica device IP Address..

Minimum length = 1

Maximum length = 64
active_desktop_count Read-write ica active_desktop_count..
id Read-write Id is HDX Desktop username.
ip_address Read-write ADC IP Address..

Minimum length = 1

Maximum length = 64
duration_summary_bandwidth Read-write Avg Bandwidth for duration summary..
active_session_duration Read-write active session duration in seconds..
server_latency Read-write server latency..
session_duration Read-write session duration..
name Read-write HDX Desktop Name.
total_bytes Read-write Total bytes..
rpt_sample_time Read-write Report Sample time (epoch time)..
client_subnet Read-write Client Subnet..

Maximum length = 64
username Read-write username.
ica_rtt Read-write ICA rtt..
bandwidth Read-write Avg Bandwidth..
server_srtt Read-write server Smothen RTT..
selected_time_total_byte Read-write Total bytes accounted by this URL in sampled timeframe..
client_latency Read-write client 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/hdx_desktop Query-parameters:

cr_enabled Use this query-parameter to indicate cr is enabled or not.

Possible Values: 0, 1 report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds asc Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values: yes, no sla_enabled Use this query-parameter to indicate sla is enabled or not.

Possible Values: 0, 1 order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: desktop_count, ica_rtt type Use this query-parameter to specify the type.

Possible Values: desktop_count, ica_rtt 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, "hdx_desktop":[{
"ica_user_name":<String_value>,
"client_srtt":<Double_value>,
"__count":<Double_value>,
"active_session_count":<Double_value>,
"hdx_desktop_username":<String_value>,
"edt_type":<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>}]}

<!--NeedCopy-->
hdx_desktop
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.