Skip to main content

SSHConfig

Definição da configuração do SSH.


getConnectTimeout​


getConnectTimeout() : int​

Description​

Returns the connection timeout of the current object.

Return​

( int )

Connection timeout of the current object.


getHost​


getHost() : string​

Description​

Returns the host of the current object.

Return​

( string )

Host of the current object.


getPassword​


getPassword() : string​

Description​

Returns the password of the current object.

Return​

( string )

Password of the current object.


getPort​


getPort() : int​

Description​

Returns the port of the current object.

Return​

( int )

Port of the current object.


getPublicKey​


getPublicKey() : string​

Description​

Returns the public key of the current object.

Return​

( string )

Public key of the current object.


getUsername​


getUsername() : string​

Description​

Returns the username of the current object.

Return​

( string )

Username of the current object.


isCompression​


isCompression() : boolean​

Description​

Returns whether compression is active on the current object.

Return​

( boolean )

Whether or not it is active on the current object.


isDebug​


isDebug() : boolean​

Description​

Returns whether the current object is in debug mode.

Return​

( boolean )

Whether the current object is in debug mode or not.


isEnabled​


isEnabled() : boolean​

Description​

Returns whether the current object is active.

Return​

( boolean )

Whether the current object is active or not.


setCompression​


setCompression(compression: boolean) : void​

Description​

Defines whether compression is active on the current object.

Attributes​
NAMETYPEDESCRIPTION
compressionbooleanWhether or not it is active on the current object.
Return​

( void )


setConnectTimeout​


setConnectTimeout(connectTimeout: int) : SSHConfig​

Description​

Defines the connection timeout of the current object.

Attributes​
NAMETYPEDESCRIPTION
connectTimeoutintConnection timeout to defines on the current object.
Return​

( SSHConfig )

The current SSHConfig object.


setDebug​


setDebug(debug: boolean) : SSHConfig​

Description​

Defines whether the current object is in debug mode.

Attributes​
NAMETYPEDESCRIPTION
debugbooleanWhether the current object is in debug mode or not.
Return​

( SSHConfig )

The current SSHConfig object.


setEnabled​


setEnabled(enabled: boolean) : SSHConfig​

Description​

Defines whether the current object is active.

Attributes​
NAMETYPEDESCRIPTION
enabledbooleanWhether the current object is active or not.
Return​

( SSHConfig )

The current SSHConfig object.


setHost​


setHost(host: string) : SSHConfig​

Description​

Defines the host of the current object.

Attributes​
NAMETYPEDESCRIPTION
hoststringHost to defines on the current object.
Return​

( SSHConfig )

The current SSHConfig object.


setPassword​


setPassword(password: string) : SSHConfig​

Description​

Defines the password of the current object.

Attributes​
NAMETYPEDESCRIPTION
passwordstringPassword to defines on the current object.
Return​

( SSHConfig )

The current SSHConfig object.


setPort​


setPort(port: int) : SSHConfig​

Description​

Defines the port of the current object.

Attributes​
NAMETYPEDESCRIPTION
portintPort to defines on the current object.
Return​

( SSHConfig )

The current SSHConfig object.


setPublicKey​


setPublicKey(publicKey: string) : void​

Description​

Defines the public key of the current object.

Attributes​
NAMETYPEDESCRIPTION
publicKeystringPublic key to defines on the current object.
Return​

( void )


setUsername​


setUsername(username: string) : SSHConfig​

Description​

Defines the username of the current object.

Attributes​
NAMETYPEDESCRIPTION
usernamestringUsername to defines on the current object.
Return​

( SSHConfig )

The current SSHConfig object.