Class Net::SSH::Session
In: lib/net-ssh-session/version.rb
lib/net/ssh/session.rb
Parent: Object

Methods

close   exec   last_command   logger=   method_missing   new   on_output   open   run   run_multiple  

Included Modules

Net::SSH::SessionHelpers

Constants

VERSION = '0.1.6'

Attributes

connection  [R] 
history  [R] 
host  [R] 
logger  [R] 
options  [R] 
password  [R] 
shell  [R] 
timeout  [R] 
user  [R] 

Public Class methods

new(host, user, password='', options={})

Initialize a new ssh session @param [String] remote hostname or ip address @param [String] remote account username @param [String] remote account password @param [Hash] options hash

Public Instance methods

close()

Close connection with remote server @return [Boolean]

exec(command, &on_output)

Execute command @param [String] command to execute @param [Block] output event block @return [Integer] command execution exit code

last_command()

Get last executed command @return [SessionCommand]

logger=(log)

Set a global session logger for commands @param [Logger] logger instance

method_missing(name, *args)

Execute a dynamic command @param [String] command name @params [Array] command arguments

open(timeout=nil)

Establish connection with remote server @param [Integer] max timeout in seconds @return [Boolean]

run(command, options={}) {|data if block_given?| ...}

Execute a single command @param [String] comand to execute @param [Hash] execution options @return [SessionCommand]

run_multiple(commands=[], options={}) {|result| ...}

Execute multiple commands @param [Array] set of commands to execute @param [Hash] execution options @return [Array] set of command execution results

Execution options are the following: options[:break] - If set to `true`, execution chain will break on first failed command

[Validate]