Class: EventMachine::Ssh

Inherits:

Object

• Object
• EventMachine::Ssh

Defined in:

lib/em-ssh.rb,
lib/em-ssh/log.rb,
lib/em-ssh/shell.rb,
lib/em-ssh/session.rb,
lib/em-ssh/version.rb,
lib/em-ssh/callbacks.rb,
lib/em-ssh/connection.rb,
lib/em-ssh/packet-stream.rb,
lib/em-ssh/server-version.rb,
lib/em-ssh/authentication-session.rb,
lib/em-ssh/connection/channel/interactive.rb,
lib/em-ssh/connection/channel/null-logger.rb

Overview

end

Examples:

EM::Ssh.start(host, user, :password => password) do |ssh|
 ssh.exec("hostname") do |ch,stream,data|
   puts "data: #{data}"
 end

Defined Under Namespace

Modules: Callbacks, Error, Log Classes: AuthenticationSession, ChannelOpenFailed, ClosedChannel, Connection, ConnectionFailed, ConnectionTerminated, ConnectionTimeout, Disconnect, Disconnected, NegotiationTimeout, PacketStream, ServerVersion, Session, Shell, SshError, TimeoutError

Constant Summary

DEFAULT_PORT =

Net::SSH::Transport::Session::DEFAULT_PORT

VERSION =

'0.8.2'

Class Attribute Summary

• .logger(level = Logger::WARN) ⇒ Logger

  Creates a logger when necessary.

Class Method Summary

• .connect(host, user, opts = {}) {|Session| ... } ⇒ Session (also: start)

  Connect to an ssh server.

Class Attribute Details

.logger(level = Logger::WARN) ⇒ Logger

Creates a logger when necessary

Returns:

• (Logger)

# File 'lib/em-ssh.rb', line 99

def logger(level = Logger::WARN)
  @logger ||= ::Logger.new(STDERR).tap{ |l| l.level = level }
end

Class Method Details

.connect(host, user, opts = {}) {|Session| ... } ⇒ Session Also known as: start

Connect to an ssh server

Examples:

EM::Ssh.start(host, user, options) do |connection|
 log.debug "**** connected: #{connection}"
 connection.open_channel do |channel|
   log.debug "**** channel: #{channel}"
   channel.request_pty(options[:pty] || {}) do |pty,suc|

Parameters:

• host (String)
• user (String)
• opts (Hash) (defaults to: {}) —

  all options accepted by Net::SSH.start

Yields:

• (Session) —

  an EventMachine compatible Net::SSH::Session

Returns:

• (Session)

See Also:

• http://net-ssh.github.com/ssh/v2/api/index.html

# File 'lib/em-ssh.rb', line 116

def connect(host, user, opts = {}, &blk)
  opts[:logger] || logger.debug("#{self}.connect(#{host}, #{user}, #{opts})")

  options = {
    host: host,
    user: user,
    port: DEFAULT_PORT
  }.merge(opts)

  EM.connect(options[:host], options[:port], Connection, options, &blk)
end