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/netssh/known_hosts.rb,
lib/sshkit/mapping_interaction_handler.rb

Overview

 @author Lee Hambley

Defined Under Namespace

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

Constant Summary collapse

StandardError =
Class.new(::StandardError)
UnparsableHostStringError =
Class.new(SSHKit::StandardError)
PARSERS =
[
  SimpleHostParser,
  HostWithPortParser,
  HostWithUsernameAndPortParser,
  IPv6HostWithPortParser,
  HostWithUsernameParser,
].freeze
VERSION =
"1.18.0".freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configObject



14
15
16
# File 'lib/sshkit.rb', line 14

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

Class Method Details

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

Yields:



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

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

.reset_configuration!Object



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

def reset_configuration!
  @@config = nil
end