Skip to main content
Version: 2.7

SSH Client Driver Configuration

Plugin Configuration

The plugin configuration file is named settings.json located in <install directory>\Config\HumanOS.UHAL.SshClient\. It contains all global settings of the plugin.

See Generic Plugin Configuration for more details.

Device Information File

The device information file is used to configure the access to the SSH devices. It contains:

  • Id: unique device id (GUID), which MUST match the device license id.
  • DriverId: 900EA6EC-6361-48B9-ADAE-18D89393B7E6
  • Address: Connection address
  • Commands

See Device Information Model for more details.

Connection Address

The address field contains the ip-address of the device.

Following properties precise the connection:

NameDescriptionData Type
UserNameThis property specifies the username the plugin uses to sign in the SSHSystem.String
PasswordThe password of the specified userSystem.String

Example:

{
"Name": "TestServer",
"Id": "6ae9da3f-4606-4c78-9eb3-aa70cebcb571",
"DriverId": "900EA6EC-6361-48B9-ADAE-18D89393B7E6",
"Address": "10.196.24.12",
"Properties": [
{
"Name": "UserName",
"Value": "yourLoginUser"
},
{
"Name": "Password",
"Value": "yourPassword"
}
]
}