session_hop_distribution

Configuration for Session Hop Distribution Report resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
source	<String>	Read-write	Text to display for the source [e.g.: User name, Citrix ADC IP, Server IP, etc.]. Minimum length = 1 Maximum length = 128
__count	<Double>	Read-write	count..
rpt_sample_time	<Double>	Read-write	ReportSampletime..
exporter_id	<String>	Read-write	Exported ID..
target	<String>	Read-write	Text to display for the target [e.g.: User name, Citrix ADC IP, Server IP, etc.]. Minimum length = 1 Maximum length = 128
hop_count	<Double>	Read-write	Index of the hop [1, 2, 3, etc.] .
source_type	<String>	Read-write	Type of the source, this will decide the icon to show in the UI for source [Client, Citrix ADC, Server, etc.] . Minimum length = 1 Maximum length = 128
id	<String>	Read-write	Id is ICA Session ID. Minimum length = 1 Maximum length = 64
target_type	<String>	Read-write	Type of the source, this will decide the icon to show in the UI for source [Client, Citrix ADC, Server, etc.]. Minimum length = 1 Maximum length = 128
latency	<Double>	Read-write	ica session 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/session_hop_distribution

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, "session_hop_distribution":[{
      "source":<String_value>,
      "__count":<Double_value>,
      "rpt_sample_time":<Double_value>,
      "exporter_id":<String_value>,
      "target":<String_value>,
      "hop_count":<Double_value>,
      "source_type":<String_value>,
      "id":<String_value>,
      "target_type":<String_value>,
      "latency":<Double_value>}]}