Product Documentation

tune_setting

Oct 21, 2015

Get and Set for parameters on tuning page

Properties

Name Data Type Read-Only? Description
virtualinlinemode
<String>
No

Virtual Inline mode

Possible values = [SendToGateway, ReturnToEthernetSender]

ftpcontrolports
<[Integer,...]>
No

vector of FTP control ports

Minimum value = 1

Maximum value = 65535

privilegedportslowest
<Integer>
No

lower value of privileged port range

Minimum value = 1

Maximum value = 1023

tcpmaximummss
<Integer>
No

Maximum value of TCP MSS should be greater than or equal to tcpdefaultmss. Note: The range of MSS specified above is for when IPV6 is disabled. If IPV6 enabled range is between 1220 to 1380.

Minimum value = 536

Maximum value = 1380

tcpdefaultmss
<Integer>
No

Default value of TCP MSS should be less than or equal to tcpmaximummss. Note: The range of MSS specified above is for when IPV6 is disabled. If IPV6 enabled range is between 1220 to 1380.

Minimum value = 536

Maximum value = 1380

idletimeout
<Double>
No

Timeout in seconds. Precision of this field is upto microseconds, a value precised more than microsecond may not get handled.

Minimum value = 1.0E-6

Maximum value = 9.99999999999E8

wanscalelimit
<Integer>
No

WAN window scale limit

Minimum value = 10

Maximum value = 27

lanscalelimit
<Integer>
No

LAN window scale limit

Minimum value = 10

Maximum value = 20

timeoutenabled
<Boolean>
No

Timeout Enabled flag

Possible values = [true, false]

privilegedportshighest
<Integer>
No

Upper value of privileged port range

Minimum value = 1

Maximum value = 1023

fwdloopprevent
<Boolean>
No

Forwarding loop prevention flag

Possible values = [true, false]

rshellports
<[Integer,...]>
No

Vector of Rshell ports

Minimum value = 1

Maximum value = 65535

daisychain
<Boolean>
No

Daisy chain enabled flag

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 tuning parameters

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"tune_setting":{
"virtualinlinemode": <string_value>,
"ftpcontrolports": <integer_value>,
"privilegedportslowest": <integer_value>,
"tcpmaximummss": <integer_value>,
"tcpdefaultmss": <integer_value>,
"idletimeout": <double_value>,
"wanscalelimit": <integer_value>,
"lanscalelimit": <integer_value>,
"timeoutenabled": <boolean_value>,
"privilegedportshighest": <integer_value>,
"fwdloopprevent": <boolean_value>,
"rshellports": <integer_value>,
"daisychain": <boolean_value>
}}

MODIFY

Use this operation to set tuning parameters

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"tune_setting":{
"virtualinlinemode": <string_value>,
"ftpcontrolports": <integer_value>,
"privilegedportslowest": <integer_value>,
"tcpmaximummss": <integer_value>,
"tcpdefaultmss": <integer_value>,
"idletimeout": <double_value>,
"wanscalelimit": <integer_value>,
"lanscalelimit": <integer_value>,
"timeoutenabled": <boolean_value>,
"privilegedportshighest": <integer_value>,
"fwdloopprevent": <boolean_value>,
"rshellports": <integer_value>,
"daisychain": <boolean_value>
}}

Response Headers:

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

Response Payload: JSON

{"tune_setting":{
"virtualinlinemode": <string_value>,
"ftpcontrolports": <integer_value>,
"privilegedportslowest": <integer_value>,
"tcpmaximummss": <integer_value>,
"tcpdefaultmss": <integer_value>,
"idletimeout": <double_value>,
"wanscalelimit": <integer_value>,
"lanscalelimit": <integer_value>,
"timeoutenabled": <boolean_value>,
"privilegedportshighest": <integer_value>,
"fwdloopprevent": <boolean_value>,
"rshellports": <integer_value>,
"daisychain": <boolean_value>
}}