Citrix

Produktdokumentation



Ganzes Dokument herunterladen

plugin_diag

Oct. 21, 2015

Configuration of FTP server/path for uploading plugin diagnostics.

Properties

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

IP address of FTP Server

diagftpuser
<String>
No

FTP username.

diagftppassword
<String>
No

FTP password.

diagftpport
<Integer>
No

FTP Server port

Minimum value = 1

Maximum value = 65535

diagemail
<String>
No

Email account to send plugin diagnostic notification

diagautoupload
<String>
No

Automatically upload diagnostic reports

diagpopups
<Boolean>
No

Allow pop ups on the plugin to prompt user for uploading diagnostic report.

Possible values = [true, false]

diagftpdirectory
<String>
No

Path on the FTP server to upload files

Operations

Note:

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_diag/

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"plugin_diag":{
"diagftpserver": <string_value>,
"diagftpuser": <string_value>,
"diagftppassword": <string_value>,
"diagftpport": <integer_value>,
"diagemail": <string_value>,
"diagautoupload": <string_value>,
"diagpopups": <boolean_value>,
"diagftpdirectory": <string_value>
}}

MODIFY

Use this operation to modify plugin diagnostic configuration

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"plugin_diag":{
"diagftpserver": <string_value>,
"diagftpuser": <string_value>,
"diagftppassword": <string_value>,
"diagftpport": <integer_value>,
"diagemail": <string_value>,
"diagautoupload": <string_value>,
"diagpopups": <boolean_value>,
"diagftpdirectory": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"plugin_diag":{
"diagftpserver": <string_value>,
"diagftpuser": <string_value>,
"diagftppassword": <string_value>,
"diagftpport": <integer_value>,
"diagemail": <string_value>,
"diagautoupload": <string_value>,
"diagpopups": <boolean_value>,
"diagftpdirectory": <string_value>
}}
Back to Top