Module: SSHKit

Defined in:
lib/sshkit/command.rb,
lib/sshkit.rb,
lib/sshkit/dsl.rb,
lib/sshkit/host.rb,
lib/sshkit/version.rb,
lib/sshkit/coordinator.rb,
lib/sshkit/configuration.rb,
lib/sshkit/runners/group.rb,
lib/sshkit/formatters/dot.rb,
lib/sshkit/backends/netssh.rb,
lib/sshkit/backends/printer.rb,
lib/sshkit/runners/abstract.rb,
lib/sshkit/runners/parallel.rb,
lib/sshkit/backends/abstract.rb,
lib/sshkit/formatters/pretty.rb,
lib/sshkit/runners/sequential.rb,
lib/sshkit/formatters/abstract.rb,
lib/sshkit/formatters/black_hole.rb

Overview

 @author Lee Hambley

Defined Under Namespace

Modules: Backend, CommandHelper, DSL, Formatter, Runner Classes: Command, Configuration, Coordinator, Host

Constant Summary collapse

StandardError =
Class.new(::StandardError)
UnparsableHostStringError =
Class.new(SSHKit::StandardError)
VERSION =
"0.0.14"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configObject

Returns the value of attribute config.



6
7
8
# File 'lib/sshkit.rb', line 6

def config
  @config
end

Class Method Details

.capture_output(io, &block) ⇒ Object



9
10
11
12
13
14
15
# File 'lib/sshkit.rb', line 9

def self.capture_output(io, &block)
  original_io = config.output
  config.output = io
  yield
ensure
  config.output = original_io
end

.configure {|config| ... } ⇒ Object

Yields:



17
18
19
20
# File 'lib/sshkit.rb', line 17

def self.configure
  @@config ||= Configuration.new
  yield config
end

.reset_configuration!Object



26
27
28
# File 'lib/sshkit.rb', line 26

def self.reset_configuration!
  @@config = nil
end