Developer Documentation
Citrix ADM NITRO API Reference

ica_user

June 20, 2023
Contributed by: 
C

Configuration for Af report for ICA User resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
serverside_packet_retransmits Read-write Server side packet retransmits..
__count Read-write count..
country_code Read-write country_code.
ip_block_name Read-write ip_block_name.
app_launch_count Read-write ica app_launch_count.
active_desktop_count Read-write ica active_desktop_count..
launch_duration Read-write ICA App launch duration..
l7_clientside_latency Read-write L7 clientside latency.
server_jitter Read-write ICA User server jitter..
latitude Read-write latitude.
client_jitter Read-write ICA User client jitter..
id Read-write Id is ICA User Name.

Minimum length = 1

Maximum length = 64
app_enumeration_duration Read-write app_enumeration_duration..
server_latency Read-write ICA User server latency..
serverside_0_win Read-write server side 0 window count..
longitude Read-write longitude.
region_code Read-write region_code.
user_agent Read-write User Agent Information.
name Read-write Name of ICA User.

Minimum length = 1

Maximum length = 128
region Read-write region.
total_bytes Read-write Total bytes accounted by this URL in sampled timeframe..
client_subnet Read-write Client Subnet..

Maximum length = 64
ica_rtt Read-write ICA rtt..
user_count Read-write user_count..
client_latency Read-write ICA User client latency..
client_srtt Read-write client Smothen RTT..
edt_type Read-write edt_type.
active_app_count Read-write ica active_app_count..
city Read-write city.
session_reconnect Read-write Session reconnect..
serverside_rto Read-write serverside rto..
latency Read-write ICA User total latency..
country Read-write country.
clientside_packet_retransmits Read-write Client side packet retransmits..
rpt_sample_time Read-write Report Sample time..
clientside_0_win Read-write Client side 0 window count..
bandwidth Read-write Avg Bandwidth..
clientside_rto Read-write clientside rto..
server_srtt Read-write server Smothen RTT..
l7_serverside_latency 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/ica_user 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: ica_rtt, client_latency, server_latency, total_bytes, bandwidth type Use this query-parameter to specify the type.

Possible Values: ica_rtt, geo 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, "ica_user":[{
"serverside_packet_retransmits":<Double_value>,
"__count":<Double_value>,
"country_code":<String_value>,
"ip_block_name":<String_value>,
"app_launch_count":<Double_value>,
"active_desktop_count":<Double_value>,
"launch_duration":<Double_value>,
"l7_clientside_latency":<Double_value>,
"server_jitter":<Double_value>,
"latitude":<Double_value>,
"client_jitter":<Double_value>,
"id":<String_value>,
"app_enumeration_duration":<Double_value>,
"server_latency":<Double_value>,
"serverside_0_win":<Double_value>,
"longitude":<Double_value>,
"region_code":<String_value>,
"user_agent":<String_value>,
"name":<String_value>,
"region":<String_value>,
"total_bytes":<Double_value>,
"client_subnet":<String_value>,
"ica_rtt":<Double_value>,
"user_count":<Double_value>,
"client_latency":<Double_value>,
"client_srtt":<Double_value>,
"edt_type":<String_value>,
"ica_device_ip_address":<String_value>,
"active_app_count":<Double_value>,
"city":<String_value>,
"session_reconnect":<Double_value>,
"ica_session_id":<String_value>,
"serverside_rto":<Double_value>,
"latency":<Double_value>,
"country":<String_value>,
"clientside_packet_retransmits":<Double_value>,
"rpt_sample_time":<Double_value>,
"clientside_0_win":<Double_value>,
"bandwidth":<Double_value>,
"clientside_rto":<Double_value>,
"server_srtt":<Double_value>,
"ica_app_name":<String_value>,
"l7_serverside_latency":<Double_value>}]}

<!--NeedCopy-->
ica_user
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.