Product Documentation

log_params

Oct 20, 2015

Configuration of Logging parameters

Properties

Name Data Type Read-Only? Description
alertrecords
<Boolean>
No

Log alert records or not

Possible values = [true, false]

flowrecords
<Boolean>
No

Log flow records or not

Possible values = [true, false]

adapterrecords
<Boolean>
No

Log adapter records or not

Possible values = [true, false]

maxsize
<Integer>
No

Maximum log size on disk in megabytes

Minimum value = 1

Maximum value = 1024

cifssmbrecords
<Boolean>
No

Log CIFS/SMB records or not

Possible values = [true, false]

connectionrecords
<Boolean>
No

Log connection records or not

Possible values = [true, false]

opencloserecords
<Boolean>
No

Log open/close records or not

Possible values = [true, false]

maxexportcount
<Integer>
No

Maximum number of export count

Minimum value = 1

Maximum value = 1048576

httprecords
<Boolean>
No

Log HTTP records or not

Possible values = [true, false]

systemrecords
<Boolean>
No

Log system records or not

Possible values = [true, false]

textrecords
<Boolean>
No

Log text records or not

Possible values = [true, false]

Operations

注意

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

GET

Use this operation to get log settings

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"log_params":{
"alertrecords": <boolean_value>,
"flowrecords": <boolean_value>,
"adapterrecords": <boolean_value>,
"maxsize": <integer_value>,
"cifssmbrecords": <boolean_value>,
"connectionrecords": <boolean_value>,
"opencloserecords": <boolean_value>,
"maxexportcount": <integer_value>,
"httprecords": <boolean_value>,
"systemrecords": <boolean_value>,
"textrecords": <boolean_value>
}}

MODIFY

Use this operation to modify log settings

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"log_params":{
"alertrecords": <boolean_value>,
"flowrecords": <boolean_value>,
"adapterrecords": <boolean_value>,
"maxsize": <integer_value>,
"cifssmbrecords": <boolean_value>,
"connectionrecords": <boolean_value>,
"opencloserecords": <boolean_value>,
"maxexportcount": <integer_value>,
"httprecords": <boolean_value>,
"systemrecords": <boolean_value>,
"textrecords": <boolean_value>
}}

Response Headers:

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

Response Payload: JSON

{"log_params":{
"alertrecords": <boolean_value>,
"flowrecords": <boolean_value>,
"adapterrecords": <boolean_value>,
"maxsize": <integer_value>,
"cifssmbrecords": <boolean_value>,
"connectionrecords": <boolean_value>,
"opencloserecords": <boolean_value>,
"maxexportcount": <integer_value>,
"httprecords": <boolean_value>,
"systemrecords": <boolean_value>,
"textrecords": <boolean_value>
}}