Citrix

Produktdokumentation



Ganzes Dokument herunterladen

ssh

Oct. 21, 2015

Configure SSH status.

Properties

Name Data Type Read-Only? Description
status
<Boolean>
Yes

Current status of SSH daemon.

Possible values = [true, false]

enable
<Boolean>
No

Enable/Disable SSH.

Possible values = [true, false]

Operations

Note:

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

GET

Use this operation to get SSH status

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"ssh":{
"status": <boolean_value>,
"enable": <boolean_value>
}}

MODIFY

Use this operation to modify SSH status

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"ssh":{
"enable": <boolean_value>
}}

Response Headers:

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

Response Payload: JSON

{"ssh":{
"status": <boolean_value>,
"enable": <boolean_value>
}}
Back to Top