Product Documentation

session_params

Oct 21, 2015

Configuration of session parameters.

Properties

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

GUI banner text.

guibannerenable
<Boolean>
No

GUI banner enable.

Possible values = [true, false]

clisessiontimeout
<Integer>
No

CLI session timeout minutes. Timeout value 0 means, infinite timeout.

Minimum value = 0

loginfailurelimit
<Integer>
No

Login failure limit.

Minimum value = 1

guisessiontimeout
<Integer>
No

GUI session timeout minutes. Timeout value 0 means, infinite timeout.

Minimum value = 0

maxuserfailures
<Integer>
No

Maximum failures per user.

Minimum value = 1

clibanner
<String>
No

CLI banner text.

clibannerenable
<Boolean>
No

CLI banner enable.

Possible values = [true, false]

lockouttime
<Integer>
No

Lockout time seconds.

Minimum value = 1

Operations

Hinweis

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

GET

Use this operation to get session parameter details

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"session_params":{
"guibanner": <string_value>,
"guibannerenable": <boolean_value>,
"clisessiontimeout": <integer_value>,
"loginfailurelimit": <integer_value>,
"guisessiontimeout": <integer_value>,
"maxuserfailures": <integer_value>,
"clibanner": <string_value>,
"clibannerenable": <boolean_value>,
"lockouttime": <integer_value>
}}

MODIFY

Use this operation to modify session parameter configuration

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"session_params":{
"guibanner": <string_value>,
"guibannerenable": <boolean_value>,
"clisessiontimeout": <integer_value>,
"loginfailurelimit": <integer_value>,
"guisessiontimeout": <integer_value>,
"maxuserfailures": <integer_value>,
"clibanner": <string_value>,
"clibannerenable": <boolean_value>,
"lockouttime": <integer_value>
}}

Response Headers:

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

Response Payload: JSON

{"session_params":{
"guibanner": <string_value>,
"guibannerenable": <boolean_value>,
"clisessiontimeout": <integer_value>,
"loginfailurelimit": <integer_value>,
"guisessiontimeout": <integer_value>,
"maxuserfailures": <integer_value>,
"clibanner": <string_value>,
"clibannerenable": <boolean_value>,
"lockouttime": <integer_value>
}}