Product Documentation

plugin_config

Oct 21, 2015

Configuration of Redirector IP/port etc to establish signalling channel.

Properties

Name Data Type Read-Only? Description
landetectrttthreshold
<Integer>
No

RTT below which enviroment for connection is assumed to be LAN

Minimum value = 1

Maximum value = 50

redirectoripprefix
<Integer>
No

Signaling IP prefix

Minimum value = 1

Maximum value = 31

redirectorip
<String>
No
filteringlist
<[Object,...]>
No
Filtering list to allow/disallow traffic from configured subnets
filteringlist.subnet
<String>
No

Filtering list subnet. (IPv4/IPv6 string).

Bitmask = Optional (format IP[/bitmask])

filteringlist.allow
<Boolean>
No

IP address of FTP Server

Possible values = [true, false]

redirectorstatus
<String>
Yes

Informatory status of plugin feature

lanwandetectenabled
<Boolean>
No

Enable/disable detection of LAN/WAN enviroment

Possible values = [true, false]

connectionmode
<String>
No

Plugin redirection mode

Possible values = [transparent, redirector]

filteringenabled
<Boolean>
No

Enable/disable source filtering

Possible values = [true, false]

redirectorport
<Integer>
No

Listening port for signalling connections

Minimum value = 1

Maximum value = 65535

redirectorenabled
<Boolean>
No

Plugin enabled

Possible values = [true, false]

Operations

Hinweis

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

GET

Use this operation to get plugin diagnostic configuration details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/plugin_config/

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"plugin_config":{
"landetectrttthreshold": <integer_value>,
"redirectoripprefix": <integer_value>,
"redirectorip": <string_value>,
"filteringlist": [{
"subnet": <string_value>,
"allow": <boolean_value>
}, ...],
"redirectorstatus": <string_value>,
"lanwandetectenabled": <boolean_value>,
"connectionmode": <string_value>,
"filteringenabled": <boolean_value>,
"redirectorport": <integer_value>,
"redirectorenabled": <boolean_value>
}}

MODIFY

Use this operation to modify plugin diagnostic configuration

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/plugin_config

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.plugin_config+json

Request Payload: JSON

{"plugin_config":{
"landetectrttthreshold": <integer_value>,
"redirectoripprefix": <integer_value>,
"redirectorip": <string_value>,
"filteringlist": [{
"subnet": <string_value>,
"allow": <boolean_value>
}, ...],
"lanwandetectenabled": <boolean_value>,
"connectionmode": <string_value>,
"filteringenabled": <boolean_value>,
"redirectorport": <integer_value>,
"redirectorenabled": <boolean_value>
}}

Response Headers:

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

Response Payload: JSON

{"plugin_config":{
"landetectrttthreshold": <integer_value>,
"redirectoripprefix": <integer_value>,
"redirectorip": <string_value>,
"filteringlist": [{
"subnet": <string_value>,
"allow": <boolean_value>
}, ...],
"redirectorstatus": <string_value>,
"lanwandetectenabled": <boolean_value>,
"connectionmode": <string_value>,
"filteringenabled": <boolean_value>,
"redirectorport": <integer_value>,
"redirectorenabled": <boolean_value>
}}