Skip to content
Was this article helpful?

ica_device_active

Configuration for Af report for ICA Device active resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
__count <Double> Read-write count..
active_session_count <Double> Read-write active_session_count..
active_launches <Double> Read-write ica active_launches.
active_app_count <Double> Read-write ica active_app_count..
active_desktop_count <Double> Read-write ica active_desktop_count..
app_launch_count <Double> Read-write App launch count..
id <String> Read-write Id is ICA Device IPAddress.

Minimum length = 1

Maximum length = 64
ip_address <String> Read-write ICA Device IP Address..

Minimum length = 1

Maximum length = 64
app_count <Double> Read-write ica_app_no_of_apps.
name <String> Read-write Name of ICA Device.

Minimum length = 1

Maximum length = 128
total_bytes <Double> Read-write Total bytes accounted ICA Device..
rpt_sample_time <Double> Read-write Report Sample time..
ica_rtt <Double> Read-write ICA rtt..
type <String> Read-write Device Type.

Minimum length = 1

Maximum length = 64
user_count <Double> Read-write ica ica_user_no_of_users..

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_device_active

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: active_session_count

type Use this query-parameter to specify the type.

Possible Values: active_session_count

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_device_active":[{
      "ica_user_name":<String_value>,
      "__count":<Double_value>,
      "active_session_count":<Double_value>,
      "active_launches":<Double_value>,
      "active_app_count":<Double_value>,
      "active_desktop_count":<Double_value>,
      "app_launch_count":<Double_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "app_count":<Double_value>,
      "name":<String_value>,
      "total_bytes":<Double_value>,
      "rpt_sample_time":<Double_value>,
      "ica_rtt":<Double_value>,
      "ica_app_name":<String_value>,
      "type":<String_value>,
      "user_count":<Double_value>}]}
Was this article helpful?