Class: Train::Transports::WinRM::Connection
- Inherits:
-
BaseConnection
- Object
- BaseConnection
- Train::Transports::WinRM::Connection
- Defined in:
- lib/train/transports/winrm_connection.rb
Overview
A Connection instance can be generated and re-generated, given new connection details such as connection port, hostname, credentials, etc. This object is responsible for carrying out the actions on the remote host such as executing commands, transferring files, etc.
Instance Attribute Summary collapse
-
#hostname ⇒ Object
readonly
rubocop:disable Metrics/ClassLength.
Instance Method Summary collapse
- #close ⇒ Object
- #download(remotes, local) ⇒ Object
-
#initialize(options) ⇒ Connection
constructor
A new instance of Connection.
- #login_command ⇒ Object
- #upload(locals, remote) ⇒ Object
- #uri ⇒ Object
- #wait_until_ready ⇒ Object
Constructor Details
#initialize(options) ⇒ Connection
Returns a new instance of Connection.
32 33 34 35 36 37 38 39 40 |
# File 'lib/train/transports/winrm_connection.rb', line 32 def initialize() super() @hostname = @options.delete(:hostname) @rdp_port = @options.delete(:rdp_port) @connection_retries = @options.delete(:connection_retries) @connection_retry_sleep = @options.delete(:connection_retry_sleep) @max_wait_until_ready = @options.delete(:max_wait_until_ready) @operation_timeout = @options.delete(:operation_timeout) end |
Instance Attribute Details
#hostname ⇒ Object (readonly)
rubocop:disable Metrics/ClassLength
31 32 33 |
# File 'lib/train/transports/winrm_connection.rb', line 31 def hostname @hostname end |
Instance Method Details
#close ⇒ Object
43 44 45 46 47 48 |
# File 'lib/train/transports/winrm_connection.rb', line 43 def close return if @session.nil? session.close ensure @session = nil end |
#download(remotes, local) ⇒ Object
71 72 73 74 75 |
# File 'lib/train/transports/winrm_connection.rb', line 71 def download(remotes, local) Array(remotes).each do |remote| file_manager.download(remote, local) end end |
#login_command ⇒ Object
51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/train/transports/winrm_connection.rb', line 51 def login_command case RbConfig::CONFIG['host_os'] when /darwin/ login_command_for_mac when /mswin|msys|mingw|cygwin|bccwin|wince|emc/ login_command_for_windows when /linux/ login_command_for_linux else fail ActionFailed, "Remote login not supported in #{self.class} " \ "from host OS '#{RbConfig::CONFIG['host_os']}'." end end |
#upload(locals, remote) ⇒ Object
67 68 69 |
# File 'lib/train/transports/winrm_connection.rb', line 67 def upload(locals, remote) file_manager.upload(locals, remote) end |
#uri ⇒ Object
87 88 89 |
# File 'lib/train/transports/winrm_connection.rb', line 87 def uri "winrm://#{[:user]}@#{[:endpoint]}:#{@rdp_port}" end |
#wait_until_ready ⇒ Object
78 79 80 81 82 83 84 85 |
# File 'lib/train/transports/winrm_connection.rb', line 78 def wait_until_ready delay = 3 session( retry_limit: @max_wait_until_ready / delay, retry_delay: delay, ) run_command_via_connection(PING_COMMAND.dup) end |