Class: Bolt::Config::Transport::WinRM

Inherits:

Base

• Object
• Base
• Bolt::Config::Transport::WinRM

Defined in:

lib/bolt/config/transport/winrm.rb

Constant Summary

OPTIONS =

NOTE: All transport configuration options should have a corresponding schema definition

in schemas/bolt-transport-definitions.json

{
  "basic-auth-only" => { type: TrueClass,
                         desc: "Force basic authentication. This option is only available when using SSL." },
  "cacert"          => { type: String,
                         desc: "The path to the CA certificate." },
  "cleanup"         => { type: TrueClass,
                         desc: "Whether to clean up temporary files created on targets." },
  "connect-timeout" => { type: Integer,
                         desc: "How long Bolt should wait when establishing connections." },
  "extensions"      => { type: Array,
                         desc: "List of file extensions that are accepted for scripts or tasks. "\
                              "Scripts with these file extensions rely on the target's file type "\
                              "association to run. For example, if Python is installed on the system, "\
                              "a `.py` script runs with `python.exe`. The extensions `.ps1`, `.rb`, and "\
                              "`.pp` are always allowed and run via hard-coded executables." },
  "file-protocol"   => { type: String,
                         desc: "Which file transfer protocol to use. Either `winrm` or `smb`. Using `smb` is "\
                              "recommended for large file transfers." },
  "host"            => { type: String,
                         desc: "Host name." },
  "interpreters"    => { type: Hash,
                         desc: "A map of an extension name to the absolute path of an executable, "\
                              "enabling you to override the shebang defined in a task executable. The "\
                              "extension can optionally be specified with the `.` character (`.py` and "\
                              "`py` both map to a task executable `task.py`) and the extension is case "\
                              "sensitive. When a target's name is `localhost`, Ruby tasks run with the "\
                              "Bolt Ruby interpreter by default." },
  "password"        => { type: String,
                         desc: "Login password. **Required unless using Kerberos.**" },
  "port"            => { type: Integer,
                         desc: "Connection port." },
  "realm"           => { type: String,
                         desc: "Kerberos realm (Active Directory domain) to authenticate against." },
  "smb-port"        => { type: Integer,
                         desc: "With file-protocol set to smb, this is the port to establish a "\
                              "connection on." },
  "ssl"             => { type: TrueClass,
                         desc: "When true, Bolt uses secure https connections for WinRM." },
  "ssl-verify"      => { type: TrueClass,
                         desc: "When true, verifies the targets certificate matches the cacert." },
  "tmpdir"          => { type: String,
                         desc: "The directory to upload and execute temporary files on the target." },
  "user"            => { type: String,
                         desc: "Login user. **Required unless using Kerberos.**" }
}.freeze

DEFAULTS =

{
  "basic-auth-only" => false,
  "cleanup"         => true,
  "connect-timeout" => 10,
  "ssl"             => true,
  "ssl-verify"      => true,
  "file-protocol"   => "winrm"
}.freeze

Instance Attribute Summary

Attributes inherited from Base

#input

Method Summary

Methods inherited from Base

#[], #dig, #fetch, #include?, #initialize, #merge, options, #resolve, #resolved?, #to_h

Constructor Details

This class inherits a constructor from Bolt::Config::Transport::Base