SSH
Feature to connect, transfer files and execute commands via SSH.
close
_ssh.close() : void
Description
Closes all open sessions and performs SSH disconnection from the server.
Return
( void )
Current SSH object.
config
_ssh.config() : SSHConfig
Description
Starts a new configuration of its own.
Return
( SSHConfig )
Configuration object loaded from received data.
_ssh.config(config: Values) : SSHConfig
Description
Starts a new configuration of its own.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | Values | Configuration definition data structure. |
Return
( SSHConfig )
Configuration object loaded from received data.
_ssh.config(config: SSHConfig) : SSH
Description
Define outra configuração que deve ser utilizada.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | SSHConfig | Definition of the new configuration. |
Return
( SSH )
Current SSH resource.
connect
_ssh.connect() : SSH
Description
Starts connecting to the server via SSH.
Return
( SSH )
Current SSH resource.
disconnect
_ssh.disconnect() : SSH
Description
Closes all open sessions and performs SSH disconnection from the server.
Return
( SSH )
Current SSH resource.
enabled
_ssh.enabled() : boolean
Return
( boolean )
_ssh.enabled(enabled: boolean) : SSH
Description
Sets whether it is enabled.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
enabled | boolean | Whether it is active or inactive. |
Return
( SSH )
Current SSH resource.
getClient
_ssh.getClient() : org.netuno.psamata.ssh.SSHClient
Description
Gets the base SSH client.
Return
( org.netuno.psamata.ssh.SSHClient )
Original base SSH client
getConfig
_ssh.getConfig() : SSHConfig
Description
Gets the configuration that is being used.
Return
( SSHConfig )
Object of the active configuration.
init
_ssh.init() : SSH
Description
Starts a new instance of SSH using the SSH configuration of the default
key.
Return
( SSH )
The new instance of the SSH resource based on the default
SSH configuration.
_ssh.init(configKey: string) : SSH
Description
Starts a new instance of SSH from a specific configuration.