Table of Contents - winrm-2.3.9 Documentation
Pages
- LICENSE
-
README
- Windows Remote Management (WinRM) for Ruby
- Supported Ruby Versions
- Supported WinRM Versions
- Install
- Example
- Connection Options
- Transports
:negotiate
:ssl
:kerberos
:plaintext
- Shells
- Shell options supported by the
:cmd
shell :codepage
and working with legacy Windows versions- Executing a WQL Query
- Create a self signed cert for WinRM
- Setting up Certificate based authentication
- Logging
- Troubleshooting
- Contributing
- Running the tests
- WinRM Author
- Maintainers
Classes and Modules
- WinRM
- WinRM::Connection
- WinRM::ConnectionOpts
- WinRM::HTTP
- WinRM::HTTP::BasicAuthSSL
- WinRM::HTTP::ClientCertAuthSSL
- WinRM::HTTP::HttpGSSAPI
- WinRM::HTTP::HttpNegotiate
- WinRM::HTTP::HttpPlaintext
- WinRM::HTTP::HttpTransport
- WinRM::HTTP::TransportFactory
- WinRM::InvalidExitCode
- WinRM::InvalidShellError
- WinRM::InvalidTransportError
- WinRM::Output
- WinRM::PSRP
- WinRM::PSRP::Fragment
- WinRM::PSRP::Message
- WinRM::PSRP::MessageData
- WinRM::PSRP::MessageData::Base
- WinRM::PSRP::MessageData::ErrorRecord
- WinRM::PSRP::MessageData::PipelineHostCall
- WinRM::PSRP::MessageData::PipelineOutput
- WinRM::PSRP::MessageData::PipelineState
- WinRM::PSRP::MessageData::RunspacepoolHostCall
- WinRM::PSRP::MessageData::RunspacepoolState
- WinRM::PSRP::MessageData::SessionCapability
- WinRM::PSRP::MessageDefragmenter
- WinRM::PSRP::MessageFactory
- WinRM::PSRP::MessageFragmenter
- WinRM::PSRP::PowershellOutputDecoder
- WinRM::PSRP::ReceiveResponseReader
- WinRM::PSRP::UUID
- WinRM::ResponseHandler
- WinRM::Shells
- WinRM::Shells::Base
- WinRM::Shells::Cmd
- WinRM::Shells::Powershell
- WinRM::Shells::Retryable
- WinRM::Shells::ShellFactory
- WinRM::WSMV
- WinRM::WSMV::Base
- WinRM::WSMV::CleanupCommand
- WinRM::WSMV::CloseShell
- WinRM::WSMV::Command
- WinRM::WSMV::CommandOutput
- WinRM::WSMV::CommandOutputDecoder
- WinRM::WSMV::Configuration
- WinRM::WSMV::CreatePipeline
- WinRM::WSMV::CreateShell
- WinRM::WSMV::Header
- WinRM::WSMV::InitRunspacePool
- WinRM::WSMV::Iso8601Duration
- WinRM::WSMV::KeepAlive
- WinRM::WSMV::ReceiveResponseReader
- WinRM::WSMV::SOAP
- WinRM::WSMV::SendData
- WinRM::WSMV::WqlPull
- WinRM::WSMV::WqlQuery
- WinRM::WSMV::WriteStdin
- WinRM::WinRMAuthorizationError
- WinRM::WinRMError
- WinRM::WinRMHTTPTransportError
- WinRM::WinRMSoapFault
- WinRM::WinRMWMIError
- WinRM::WinRMWSManFault
Methods
- ::camelize — WinRM::PSRP::MessageData
- ::close_shell — WinRM::Shells::Cmd
- ::close_shell — WinRM::Shells::Powershell
- ::create_pipeline_message — WinRM::PSRP::MessageFactory
- ::create_with_defaults — WinRM::ConnectionOpts
- ::default — WinRM::ConnectionOpts
- ::ensure_receive_timeout_is_greater_than_operation_timeout — WinRM::ConnectionOpts
- ::finalize — WinRM::Shells::Base
- ::init_runspace_pool_message — WinRM::PSRP::MessageFactory
- ::new — WinRM::Connection
- ::new — WinRM::InvalidTransportError
- ::new — WinRM::WinRMWSManFault
- ::new — WinRM::WinRMSoapFault
- ::new — WinRM::WinRMWMIError
- ::new — WinRM::WinRMHTTPTransportError
- ::new — WinRM::ResponseHandler
- ::new — WinRM::HTTP::HttpTransport
- ::new — WinRM::HTTP::HttpPlaintext
- ::new — WinRM::HTTP::HttpNegotiate
- ::new — WinRM::HTTP::BasicAuthSSL
- ::new — WinRM::HTTP::ClientCertAuthSSL
- ::new — WinRM::HTTP::HttpGSSAPI
- ::new — WinRM::Output
- ::new — WinRM::PSRP::Fragment
- ::new — WinRM::PSRP::Message
- ::new — WinRM::PSRP::MessageData::Base
- ::new — WinRM::PSRP::MessageDefragmenter
- ::new — WinRM::PSRP::MessageFragmenter
- ::new — WinRM::PSRP::ReceiveResponseReader
- ::new — WinRM::Shells::Base
- ::new — WinRM::Shells::Powershell
- ::new — WinRM::Shells::ShellFactory
- ::new — WinRM::WSMV::CleanupCommand
- ::new — WinRM::WSMV::CloseShell
- ::new — WinRM::WSMV::Command
- ::new — WinRM::WSMV::CommandOutput
- ::new — WinRM::WSMV::Configuration
- ::new — WinRM::WSMV::CreatePipeline
- ::new — WinRM::WSMV::CreateShell
- ::new — WinRM::WSMV::InitRunspacePool
- ::new — WinRM::WSMV::KeepAlive
- ::new — WinRM::WSMV::ReceiveResponseReader
- ::new — WinRM::WSMV::SendData
- ::new — WinRM::WSMV::WqlPull
- ::new — WinRM::WSMV::WqlQuery
- ::new — WinRM::WSMV::WriteStdin
- ::parse — WinRM::PSRP::MessageData
- ::render — WinRM::PSRP::MessageFactory
- ::sec_to_dur — WinRM::WSMV::Iso8601Duration
- ::session_capability_message — WinRM::PSRP::MessageFactory
- #<< — WinRM::Output
- #action_command — WinRM::WSMV::Header
- #action_create — WinRM::WSMV::CreateShell
- #action_create — WinRM::WSMV::InitRunspacePool
- #action_delete — WinRM::WSMV::Header
- #action_enumerate — WinRM::WSMV::Header
- #action_enumerate_pull — WinRM::WSMV::Header
- #action_get — WinRM::WSMV::Header
- #action_receive — WinRM::WSMV::Header
- #action_send — WinRM::WSMV::WriteStdin
- #action_send — WinRM::WSMV::Header
- #action_signal — WinRM::WSMV::Header
- #add_finalizer — WinRM::Shells::Base
- #arguments — WinRM::WSMV::CreatePipeline
- #base64_deflated — WinRM::Shells::Powershell
- #basic_auth_only! — WinRM::HTTP::HttpTransport
- #body — WinRM::HTTP::HttpTransport
- #build — WinRM::WSMV::Base
- #build — WinRM::WSMV::Command
- #byte_order_mark — WinRM::PSRP::Message
- #bytes — WinRM::PSRP::Fragment
- #bytes — WinRM::PSRP::Message
- #channel_binding — WinRM::HTTP::HttpNegotiate
- #cleanup_body — WinRM::WSMV::CleanupCommand
- #cleanup_command — WinRM::Shells::Base
- #cleanup_header — WinRM::WSMV::CleanupCommand
- #clixml — WinRM::PSRP::MessageData::Base
- #close — WinRM::Shells::Base
- #close_header — WinRM::WSMV::CloseShell
- #command_body — WinRM::WSMV::Command
- #command_body — WinRM::WSMV::CreatePipeline
- #command_body — WinRM::WSMV::SendData
- #command_done? — WinRM::WSMV::ReceiveResponseReader
- #command_header_opts — WinRM::WSMV::Command
- #command_headers — WinRM::WSMV::Command
- #command_headers — WinRM::WSMV::CreatePipeline
- #command_headers — WinRM::WSMV::SendData
- #command_output_message — WinRM::Shells::Base
- #configuration_headers — WinRM::WSMV::Configuration
- #configure_connection_opts — WinRM::Connection
- #configure_logger — WinRM::Connection
- #create_body — WinRM::WSMV::Base
- #create_body — WinRM::WSMV::CleanupCommand
- #create_body — WinRM::WSMV::CloseShell
- #create_body — WinRM::WSMV::Command
- #create_body — WinRM::WSMV::CommandOutput
- #create_body — WinRM::WSMV::Configuration
- #create_body — WinRM::WSMV::CreatePipeline
- #create_body — WinRM::WSMV::CreateShell
- #create_body — WinRM::WSMV::InitRunspacePool
- #create_body — WinRM::WSMV::KeepAlive
- #create_body — WinRM::WSMV::SendData
- #create_body — WinRM::WSMV::WqlPull
- #create_body — WinRM::WSMV::WqlQuery
- #create_body — WinRM::WSMV::WriteStdin
- #create_header — WinRM::WSMV::Base
- #create_header — WinRM::WSMV::CleanupCommand
- #create_header — WinRM::WSMV::CloseShell
- #create_header — WinRM::WSMV::Command
- #create_header — WinRM::WSMV::CommandOutput
- #create_header — WinRM::WSMV::Configuration
- #create_header — WinRM::WSMV::CreatePipeline
- #create_header — WinRM::WSMV::CreateShell
- #create_header — WinRM::WSMV::InitRunspacePool
- #create_header — WinRM::WSMV::KeepAlive
- #create_header — WinRM::WSMV::SendData
- #create_header — WinRM::WSMV::WqlPull
- #create_header — WinRM::WSMV::WqlQuery
- #create_header — WinRM::WSMV::WriteStdin
- #create_shell — WinRM::Shells::ShellFactory
- #create_transport — WinRM::HTTP::TransportFactory
- #data_bytes — WinRM::PSRP::Message
- #decode — WinRM::PSRP::PowershellOutputDecoder
- #decode — WinRM::WSMV::CommandOutputDecoder
- #decode_error_record — WinRM::PSRP::PowershellOutputDecoder
- #decode_host_call — WinRM::PSRP::PowershellOutputDecoder
- #decode_pipeline_output — WinRM::PSRP::PowershellOutputDecoder
- #decode_raw_output — WinRM::WSMV::CommandOutputDecoder
- #default_protocol_envelope_size — WinRM::Shells::Powershell
- #defragment — WinRM::PSRP::MessageDefragmenter
- #doc — WinRM::PSRP::MessageData::ErrorRecord
- #empty_pipeline_envelope — WinRM::Shells::Powershell
- #encode_bytes — WinRM::WSMV::Base
- #end_start_fragment — WinRM::PSRP::Fragment
- #environment_vars_body — WinRM::WSMV::CreateShell
- #error_category_message — WinRM::PSRP::MessageData::ErrorRecord
- #error_details_script_stack_trace — WinRM::PSRP::MessageData::ErrorRecord
- #exception — WinRM::PSRP::MessageData::ErrorRecord
- #exception_as_error_record — WinRM::PSRP::MessageData::PipelineState
- #exitcode= — WinRM::Output
- #extract_out_string — WinRM::PSRP::MessageData::PipelineOutput
- #find_exit_code — WinRM::PSRP::ReceiveResponseReader
- #format_idle_timeout — WinRM::WSMV::CreateShell
- #fragment — WinRM::PSRP::MessageFragmenter
- #fragment_from — WinRM::PSRP::MessageDefragmenter
- #fragmenter — WinRM::Shells::Powershell
- #fully_qualified_error_id — WinRM::PSRP::MessageData::ErrorRecord
- #handle_invalid_encoding — WinRM::WSMV::CommandOutputDecoder
- #handle_stream — WinRM::WSMV::ReceiveResponseReader
- #header_opts — WinRM::WSMV::CommandOutput
- #header_opts — WinRM::WSMV::CreateShell
- #header_opts — WinRM::WSMV::InitRunspacePool
- #header_opts — WinRM::WSMV::KeepAlive
- #hex_decode — WinRM::PSRP::PowershellOutputDecoder
- #init_auth — WinRM::HTTP::HttpNegotiate
- #init_kerberos_transport — WinRM::HTTP::TransportFactory
- #init_krb — WinRM::HTTP::HttpGSSAPI
- #init_negotiate_transport — WinRM::HTTP::TransportFactory
- #init_ops — WinRM::WSMV::Command
- #init_ops — WinRM::WSMV::WriteStdin
- #init_plaintext_transport — WinRM::HTTP::TransportFactory
- #init_ssl_transport — WinRM::HTTP::TransportFactory
- #int16be — WinRM::PSRP::Fragment
- #int16le — WinRM::PSRP::Message
- #int64be — WinRM::PSRP::Fragment
- #invocation_info — WinRM::PSRP::MessageData::ErrorRecord
- #issue69_unescape_single_quotes — WinRM::WSMV::Command
- #issue_challenge_response — WinRM::HTTP::HttpNegotiate
- #keep_alive_body — WinRM::WSMV::KeepAlive
- #keep_alive_headers — WinRM::WSMV::KeepAlive
- #log_soap_message — WinRM::HTTP::HttpTransport
- #max_envelope_size_kb — WinRM::Shells::Powershell
- #max_fragment_blob_size — WinRM::Shells::Powershell
- #merge_headers — WinRM::WSMV::Header
- #message_from — WinRM::PSRP::MessageDefragmenter
- #method_identifier — WinRM::PSRP::MessageData::PipelineHostCall
- #method_identifier — WinRM::PSRP::MessageData::RunspacepoolHostCall
- #method_parameters — WinRM::PSRP::MessageData::PipelineHostCall
- #method_parameters — WinRM::PSRP::MessageData::RunspacepoolHostCall
- #namespaces — WinRM::WSMV::SOAP
- #no_ssl_peer_verification! — WinRM::HTTP::HttpTransport
- #no_sspi_auth! — WinRM::HTTP::HttpTransport
- #open — WinRM::Shells::Base
- #open_shell — WinRM::Shells::Base
- #open_shell — WinRM::Shells::Cmd
- #open_shell — WinRM::Shells::Powershell
- #open_shell_payload — WinRM::Shells::Powershell
- #opt_or_default — WinRM::WSMV::CreateShell
- #out_streams — WinRM::Shells::Base
- #out_streams — WinRM::Shells::Cmd
- #out_streams — WinRM::Shells::Powershell
- #output — WinRM::Output
- #output — WinRM::PSRP::MessageData::PipelineOutput
- #output_body — WinRM::WSMV::CommandOutput
- #output_header — WinRM::WSMV::CommandOutput
- #parse_to_xml — WinRM::ResponseHandler
- #parsed_data — WinRM::PSRP::Message
- #pipeline_state — WinRM::PSRP::MessageData::PipelineState
- #process_items — WinRM::WSMV::WqlQuery
- #process_response — WinRM::WSMV::WqlPull
- #process_response — WinRM::WSMV::WqlQuery
- #property_hash — WinRM::PSRP::MessageData::ErrorRecord
- #protocol_version — WinRM::PSRP::MessageData::SessionCapability
- #ps_version — WinRM::PSRP::MessageData::SessionCapability
- #raise_if_auth_error — WinRM::ResponseHandler
- #raise_if_error — WinRM::ResponseHandler
- #raise_if_soap_fault — WinRM::ResponseHandler
- #raise_if_wmi_error — WinRM::ResponseHandler
- #raise_if_wsman_fault — WinRM::ResponseHandler
- #raise_transport_error — WinRM::ResponseHandler
- #read_message — WinRM::PSRP::ReceiveResponseReader
- #read_output — WinRM::PSRP::ReceiveResponseReader
- #read_output — WinRM::WSMV::ReceiveResponseReader
- #read_response — WinRM::WSMV::ReceiveResponseReader
- #read_streams — WinRM::WSMV::ReceiveResponseReader
- #remove_bom — WinRM::PSRP::MessageData::PipelineOutput
- #remove_bom — WinRM::WSMV::CommandOutputDecoder
- #remove_finalizer — WinRM::Shells::Base
- #render_exception — WinRM::PSRP::PowershellOutputDecoder
- #render_exception_as_error_record — WinRM::PSRP::PowershellOutputDecoder
- #render_native_command_error — WinRM::PSRP::PowershellOutputDecoder
- #render_write_error_exception — WinRM::PSRP::PowershellOutputDecoder
- #reset_on_error — WinRM::Shells::Base
- #resource_uri_cmd — WinRM::WSMV::Header
- #resource_uri_shell — WinRM::WSMV::Header
- #resource_uri_wmi — WinRM::WSMV::Header
- #response_reader — WinRM::Shells::Base
- #response_reader — WinRM::Shells::Cmd
- #response_reader — WinRM::Shells::Powershell
- #response_xml — WinRM::ResponseHandler
- #retryable — WinRM::Shells::Retryable
- #run — WinRM::Shells::Base
- #run_wql — WinRM::Connection
- #runspace_state — WinRM::PSRP::MessageData::RunspacepoolState
- #seal — WinRM::HTTP::HttpNegotiate
- #selector_shell_id — WinRM::WSMV::Header
- #send_command — WinRM::Shells::Base
- #send_command — WinRM::Shells::Cmd
- #send_command — WinRM::Shells::Powershell
- #send_get_output_message — WinRM::WSMV::ReceiveResponseReader
- #send_kerberos_request — WinRM::HTTP::HttpGSSAPI
- #send_pipeline_command — WinRM::Shells::Powershell
- #send_request — WinRM::HTTP::HttpTransport
- #send_request — WinRM::HTTP::HttpNegotiate
- #send_request — WinRM::HTTP::HttpGSSAPI
- #serialization_version — WinRM::PSRP::MessageData::SessionCapability
- #shared_headers — WinRM::WSMV::Header
- #shell — WinRM::Connection
- #shell_body — WinRM::WSMV::CreateShell
- #shell_body — WinRM::WSMV::InitRunspacePool
- #shell_factory — WinRM::Connection
- #shell_headers — WinRM::WSMV::CreateShell
- #shell_headers — WinRM::WSMV::InitRunspacePool
- #ssl_peer_fingerprint_verification! — WinRM::HTTP::HttpTransport
- #stderr — WinRM::Output
- #stdin_body — WinRM::WSMV::WriteStdin
- #stdin_headers — WinRM::WSMV::WriteStdin
- #stdout — WinRM::Output
- #stream_type — WinRM::PSRP::ReceiveResponseReader
- #string_prop — WinRM::PSRP::MessageData::ErrorRecord
- #transport — WinRM::Connection
- #underscore — WinRM::PSRP::MessageData::ErrorRecord
- #uuid_to_windows_guid_bytes — WinRM::PSRP::UUID
- #validate — WinRM::ConnectionOpts
- #validate_data_types — WinRM::ConnectionOpts
- #validate_integer — WinRM::ConnectionOpts
- #validate_opts — WinRM::WSMV::Command
- #validate_opts — WinRM::WSMV::WriteStdin
- #validate_required_fields — WinRM::ConnectionOpts
- #validate_transport! — WinRM::HTTP::TransportFactory
- #verify_ssl_fingerprint — WinRM::HTTP::HttpTransport
- #wait_for_running — WinRM::Shells::Powershell
- #winrm_decrypt — WinRM::HTTP::HttpNegotiate
- #winrm_decrypt — WinRM::HTTP::HttpGSSAPI
- #winrm_encrypt — WinRM::HTTP::HttpGSSAPI
- #with_command_shell — WinRM::Shells::Base
- #with_output — WinRM::WSMV::ReceiveResponseReader
- #with_untrusted_ssl_connection — WinRM::HTTP::HttpTransport
- #wql_body — WinRM::WSMV::WqlPull
- #wql_body — WinRM::WSMV::WqlQuery
- #wql_header — WinRM::WSMV::WqlPull
- #wql_header — WinRM::WSMV::WqlQuery