ica_device_session_hop_detail

Configuration for Af report for ICA Device Session hop detail resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name	<String>	Read-write	Name of ICA Device. Minimum length = 1 Maximum length = 128
client_latency	<Double>	Read-write	ica session client latency..
__count	<Double>	Read-write	count..
id	<String>	Read-write	Id is ICA Device IPAddress. Minimum length = 1 Maximum length = 64
server_latency	<Double>	Read-write	ica session server latency..
is_gateway	<Boolean>	Read-write	Is this device acting as Gateway..
license	<String>	Read-write	Feature License for Citrix ADC Instance, needs to be set while provisioning (standard, enterprise, platinum). Minimum length = 1 Maximum length = 64
device_ip_address	<String>	Read-write	ICA Device IP Address.. Minimum length = 1 Maximum length = 64
instance_state	<String>	Read-only	State of device, UP only if device accessible.
version	<String>	Read-only	Device Version.

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_session_hop_detail

Query-parameters:

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_session_hop_detail":[{
      "instance_state":<String_value>,
      "name":<String_value>,
      "client_latency":<Double_value>,
      "version":<String_value>,
      "ica_user_name":<String_value>,
      "__count":<Double_value>,
      "id":<String_value>,
      "server_latency":<Double_value>,
      "ica_session_id":<String_value>,
      "is_gateway":<Boolean_value>,
      "license":<String_value>,
      "device_ip_address":<String_value>}]}