Channel type "SSH" (via HTTP)

Use the following file for an SSH channel.

JSON


{
"type": "SSH",
"operation": "add",
"name": "My SSH channel",
"relation": "My partner",
"dmz": true,
"direction": "both",
"active": true,
"id": 0,
"local": {
"id": "my local id",
"password": "secret",
"server": ""
},
"remote": {
"id": "my remote id",
"password": "secret",
},
"types": {
"sftp": true,
"scp": true,
},
"logSettings": {
"retainDays": -1,
"enabled": true
},
"certificates": {
"own": {
"encryption": 0,
},
"partner": {
"encryption": 0
}
},
"home": "./transfer/ssh/sample",
"chroot": false,
"charset": "",
"keyType": "",
"fingerprint": "",
"access": [
{
"path": "/",
"permission": "01011111"
},
{
"path": "/sub1",
"permission": "11111111"
}
],
"contact": {
"language": "de",
"name": "John Doe",
"fax": "",
"email": "john.doe@example.com",
"note": ""
}
}

Parameters


Name

Description

type

Fixed value SSH.

operation

Fixed value add.

name

Name of the channel to be added.

relation

Name of the existing partner for which the channel is to be added.

dmz

Checkbox Invisible to DMZ in the channel GUI will be set for value false.

direction

The value in sets the value incoming in field Direction in the channel GUI.

The value out sets the value outgoing in field Direction in the channel GUI.

The value both sets the value incoming and outgoing in field Direction in the channel GUI.

active

Checkbox Active in the channel GUI will be set for value true.

id

Fixed value 0.

local (id, password, server)

Fields Own ID, Own password and Partner address in tab Own ID in the channel GUI.

remote (id, password)

Fields Partner ID and Partner password in tab Partner ID in the channel GUI.

types (sftp, scp)

Area Allowed sub types in the channel GUI.

logSettings (retainDays, enabled)

Checkboxes Retain days and Use Comm-Log in the channel GUI.

certificates

own (encryption)

partner (encryption)

Here you can specify the certificate ID (see sections Local Certificates and Partner Certificates) for the fields Local certificate (encryption) and Partner certificate (encryption) in the channel GUI.

home

Field User directory (local) in the channel GUI.

chroot

If true, the home directory is displayed as root directory during an SFTP session, i.e. you are then not in /home/[username], but in /

charset

Field Filename charset in the channel GUI.

keyType

Field Key type in the channel GUI.

fingerprint

Field Key fingerprint in the channel GUI.

access (path, permission)

Area Access rights in the channel GUI.

contact (language, name, fax, email, note)

See tab "Partner contact" (self-explanatory) in the channel GUI.