Module: SSHKit

Defined in:

lib/sshkit/command.rb,
lib/sshkit.rb,
lib/sshkit/dsl.rb,
lib/sshkit/host.rb,
lib/sshkit/color.rb,
lib/sshkit/logger.rb,
lib/sshkit/version.rb,
lib/sshkit/exception.rb,
lib/sshkit/command_map.rb,
lib/sshkit/coordinator.rb,
lib/sshkit/log_message.rb,
lib/sshkit/runners/null.rb,
lib/sshkit/configuration.rb,
lib/sshkit/runners/group.rb,
lib/sshkit/backends/local.rb,
lib/sshkit/formatters/dot.rb,
lib/sshkit/backends/netssh.rb,
lib/sshkit/backends/printer.rb,
lib/sshkit/backends/skipper.rb,
lib/sshkit/runners/abstract.rb,
lib/sshkit/runners/parallel.rb,
lib/sshkit/backends/abstract.rb,
lib/sshkit/formatters/pretty.rb,
lib/sshkit/deprecation_logger.rb,
lib/sshkit/runners/sequential.rb,
lib/sshkit/formatters/abstract.rb,
lib/sshkit/formatters/black_hole.rb,
lib/sshkit/formatters/simple_text.rb,
lib/sshkit/backends/connection_pool.rb,
lib/sshkit/mapping_interaction_handler.rb

Overview

 @author Lee Hambley

Defined Under Namespace

Modules: Backend, DSL, Formatter, Runner Classes: Color, Command, CommandMap, Configuration, Coordinator, DeprecationLogger, Host, HostWithPortParser, LogMessage, Logger, MappingInteractionHandler

Constant Summary

StandardError =

Class.new(::StandardError)

UnparsableHostStringError =

Class.new(SSHKit::StandardError)

VERSION =

"1.8.1"

Class Attribute Summary

• .config ⇒ Object

  Returns the value of attribute config.

Class Method Summary

• .configure {|config| ... } ⇒ Object
• .reset_configuration! ⇒ Object

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.

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

def config
  @config
end

Class Method Details

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

Yields:

• (config)

# File 'lib/sshkit.rb', line 9

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

.reset_configuration! ⇒ Object

# File 'lib/sshkit.rb', line 18

def reset_configuration!
  @@config = nil
end