SSH

Recurso para conectar, transferir arquivos e executar comandos via SSH.

---

close

---

_ssh.close() : void

Descrição

Fecha todas as sessões abertas e realiza a desconexão SSH com o servidor.

Retorno

( void )

Objeto SSH atual.

---

config

---

_ssh.config() : SSHConfig

Descrição

Inicia uma nova configuração própria.

Retorno

( SSHConfig )

Objeto de configuração carregada a partir dos dados recebidos.

---

_ssh.config(config: Values) : SSHConfig

Descrição

Inicia uma nova configuração própria.

Atributos

NOME	TIPO	DESCRIÇÃO
config	Values	Estrutura de dados da definição da configuração.

Retorno

( SSHConfig )

Objeto de configuração carregada a partir dos dados recebidos.

---

_ssh.config(config: SSHConfig) : SSH

Descrição

Define outra configuração que deve ser utilizada.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SSHConfig	Definição da nova configuração.

Retorno

( SSH )

Recurso SSH atual.

---

connect

---

_ssh.connect() : SSH

Descrição

Inicia a conexão com o servidor através do SSH.

Retorno

( SSH )

Recurso SSH atual.

---

disconnect

---

_ssh.disconnect() : SSH

Descrição

Fecha todas as sessões abertas e realiza a desconexão SSH com o servidor.

Retorno

( SSH )

Recurso SSH atual.

---

enabled

---

_ssh.enabled() : boolean

Retorno

( boolean )

---

_ssh.enabled(ativo: boolean) : SSH

Descrição

Define se está habilitado.

Atributos

NOME	TIPO	DESCRIÇÃO
ativo	boolean	Se fica ativo ou inactivo.

Retorno

( SSH )

Recurso SSH atual.

---

getClient

---

_ssh.getClient() : org.netuno.psamata.ssh.SSHClient

Descrição

Obtém o cliente SSH base.

Retorno

( org.netuno.psamata.ssh.SSHClient )

Cliente SSH original de base.

---

getConfig

---

_ssh.getConfig() : SSHConfig

Descrição

Obtém a configuração que está a ser utilizada.

Retorno

( SSHConfig )

Objeto da configuração ativa.

---

init

---

_ssh.init() : SSH

Descrição

Inicia uma nova instância do SSH utilizando a configuração do SSH da chave default.

Retorno

( SSH )

A nova instância do recurso SSH com base na configuração do SSH default.

---

_ssh.init(configKey: string) : SSH

Descrição

Inicia uma nova instância do SSH a partir de uma configuração específica.

Atributos

NOME	TIPO	DESCRIÇÃO
configKey	string	Chave da configuração SSH que será utilizada.

Retorno

( SSH )

A nova instância do recurso SSH com base na configuração do SSH especificada.

---

_ssh.init(config: SSHConfig) : SSH

Descrição

Inicia uma nova instância do SSH a partir de uma configuração que é definida em um objeto de configuração própria.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SSHConfig	Configuração que será utilizada.

Retorno

( SSH )

A nova instância do recurso SSH com base na configuração definida.

---

initSCP

---

_ssh.initSCP() : SSHSCP

Descrição

Inicia a sessão SCP para gerir pastas e transferir arquivos.

Retorno

( SSHSCP )

A sessão SCP iniciada para executar comandos.

---

initSFTP

---

_ssh.initSFTP() : SSHSFTP

Descrição

Inicia a sessão SFTP para gerir pastas e transferir arquivos.

Retorno

( SSHSFTP )

A sessão SFTP iniciada para executar comandos.

---

initSession

---

_ssh.initSession() : SSHSession

Descrição

Inicia a sessão SSH para executar comandos.

Retorno

( SSHSession )

A sessão iniciada para executar comandos.

---

isEnabled

---

_ssh.isEnabled() : boolean

Descrição

Verifica se está habilitado.

Retorno

( boolean )

Resultado se está ou não ativado.

---

setConfig

---

_ssh.setConfig(config: SSHConfig) : SSH

Descrição

Define outra configuração que deve ser utilizada.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SSHConfig	Definição da nova configuração.

Retorno

( SSH )

Recurso SSH atual.

---

setEnabled

---

_ssh.setEnabled(ativo: boolean) : SSH

Descrição

Define se está habilitado.

Atributos

NOME	TIPO	DESCRIÇÃO
ativo	boolean	Se fica ativo ou inactivo.

Retorno

( SSH )

Recurso SSH atual.

---