Product Documentation

accel_connections

Oct 20, 2015

Accelerated Connections

Properties

Name Data Type Read-Only? Description
duration
<Integer>
Yes

Duration of connection in seconds

idletime
<Integer>
Yes

Idle time for connection is seconds

serviceclass
<String>
Yes

Service Class under which connection is established

initiator
<String>
Yes

IP address and port number of connection initiator

bytestransferred
<String>
Yes

Total data transfered by this connection in bytes

iscompressed
<Boolean>
Yes

Compression is enabled or disabled

Possible values = [true, false]

state
<String>
Yes

State of connection

Possible values = [Open, Opening, Closed, Closing]

issslproxy
<Boolean>
Yes

SSL proxy enabled or disabled

Possible values = [true, false]

compressionalgorithm
<String>
Yes

Compression algorithm either Memory based compression, Disk based compression or None

Possible values = [None, Memory, Disk]

compressionratio
<Double>
Yes

Compression Ratio

responder
<String>
Yes

IP address and port number of responder

partnerunit
<String>
Yes

Operations

Note

Mandatory parameters are marked in red and placeholder content is marked in <green>.

GET

Use this operation to get connection running

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/stat/accel_connections/

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.accel_connections+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.accel_connections+json

Response Payload: JSON

{"accel_connections":{
"duration": <integer_value>,
"idletime": <integer_value>,
"serviceclass": <string_value>,
"initiator": <string_value>,
"bytestransferred": <string_value>,
"iscompressed": <boolean_value>,
"state": <string_value>,
"issslproxy": <boolean_value>,
"compressionalgorithm": <string_value>,
"compressionratio": <double_value>,
"responder": <string_value>,
"partnerunit": <string_value>
}}