Class: SSHKit::Backend::Netssh

### Home Classes Methods

### In Files

- lib/sshkit/backends/netssh.rb

### Parent

Printer

### Namespace

- CLASS SSHKit::Backend::Netssh::Configuration

### Methods

- ::config
- ::configure
- #background
- #capture
- #download!
- #execute
- #run
- #test
- #upload!

### Included Modules

- SSHKit::CommandHelper

### Class/Module Index

Quicksearch

- SSHKit
- SSHKit::Backend
- SSHKit::Backend::Abstract
- SSHKit::Backend::ConnectionPool
- SSHKit::Backend::Local
- SSHKit::Backend::Netssh
- SSHKit::Backend::Netssh::Configuration
- SSHKit::Backend::Printer
- SSHKit::Backend::Skipper
- SSHKit::CommandMap
- SSHKit::CommandMap::CommandHash
- SSHKit::CommandMap::PrefixProvider
- SSHKit::Configuration
- SSHKit::Coordinator
- SSHKit::DSL
- SSHKit::Formatter
- SSHKit::Formatter::Abstract
- SSHKit::Formatter::BlackHole
- SSHKit::Formatter::Dot
- SSHKit::Formatter::Pretty
- SSHKit::Formatter::SimpleText
- SSHKit::Host
- SSHKit::HostWithPortParser
- SSHKit::HostWithUsernameAndPortParser
- SSHKit::HostWithUsernameParser
- SSHKit::IPv6HostWithPortParser
- SSHKit::LogMessage
- SSHKit::Logger
- SSHKit::Logger::SSHKit
- SSHKit::Logger::SSHKit::Logger
- SSHKit::Logger::SSHKit::Logger::Net
- SSHKit::Logger::SSHKit::Logger::Net::SSH
- SSHKit::Logger::SSHKit::Logger::Net::SSH::LogLevelShim
- SSHKit::Runner
- SSHKit::Runner::Abstract
- SSHKit::Runner::ExecuteError
- SSHKit::Runner::Group
- SSHKit::Runner::Null
- SSHKit::Runner::Parallel
- SSHKit::Runner::Sequential
- SSHKit::SimpleHostParser
- SSHKit::Utils
- SSHKit::Utils::CaptureOutputMethods
- Net
- Net::SSH
- Net::SSH::Config
- Array
- Color
- Hash
- Object

No matching classes.

# SSHKit::Backend::Netssh

### Attributes

pool[RW]

### Public Class Methods

config() click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 103
    def config
      @config ||= Configuration.new
    end

configure() click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 99
    def configure
      yield config
    end

### Public Instance Methods

background(*args) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 69
    def background(*args)
      warn "[Deprecated] The background method is deprecated. Blame badly behaved pseudo-daemons!"
      options = args.extract_options!.merge(run_in_background: true)
      _execute(*[*args, options]).success?
    end

capture(*args) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 75
    def capture(*args)
      options = { verbosity: Logger::DEBUG }.merge(args.extract_options!)
      _execute(*[*args, options]).full_stdout.strip
    end

download!(remote, local=nil, options = {}) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 87
    def download!(remote, local=nil, options = {})
      summarizer = transfer_summarizer('Downloading')
      with_ssh do |ssh|
        ssh.scp.download!(remote, local, options, &summarizer)
      end
    end

execute(*args) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 65
    def execute(*args)
      _execute(*args).success?
    end

run() click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 53
    def run
      instance_exec(host, &@block)
    end

test(*args) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 57
    def test(*args)
      options = args.extract_options!.merge(
        raise_on_non_zero_exit: false,
        verbosity: Logger::DEBUG
      )
      _execute(*[*args, options]).success?
    end

upload!(local, remote, options = {}) click to toggle source

    # File lib/sshkit/backends/netssh.rb, line 80
    def upload!(local, remote, options = {})
      summarizer = transfer_summarizer('Uploading')
      with_ssh do |ssh|
        ssh.scp.upload!(local, remote, options, &summarizer)
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.