Module: Chef::Knife::WinrmBase

Defined in:
lib/chef/knife/helpers/winrm_base.rb

Class Method Summary collapse

Class Method Details

.included(includer) ⇒ Object

:nodoc: Would prefer to do this in a rational way, but can’t be done b/c of Mixlib::CLI’s design :(



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/chef/knife/helpers/winrm_base.rb', line 31

def self.included(includer)
  includer.class_eval do

    deps do
      require "chef/encrypted_data_bag_item"
      require "kconv"
      require "readline"
      require "chef/json_compat"
    end

    option :winrm_user,
      short: "-x USERNAME",
      long: "--winrm-user USERNAME",
      description: "The WinRM username",
      default: "Administrator"

    option :winrm_password,
      short: "-P PASSWORD",
      long: "--winrm-password PASSWORD",
      description: "The WinRM password"

    option :winrm_shell,
      long: "--winrm-shell SHELL",
      description: "The WinRM shell type. Valid choices are [cmd, powershell, elevated]. 'elevated' runs powershell in a scheduled task",
      default: :cmd,
      proc: Proc.new { |shell| shell.to_sym }

    option :winrm_transport,
      short: "-w TRANSPORT",
      long: "--winrm-transport TRANSPORT",
      description: "The WinRM transport type. Valid choices are [ssl, plaintext]",
      default: "plaintext"

    option :winrm_port,
      short: "-p PORT",
      long: "--winrm-port PORT",
      description: "The WinRM port, by default this is '5985' for 'plaintext' and '5986' for 'ssl' winrm transport"

    option :kerberos_keytab_file,
      short: "-T KEYTAB_FILE",
      long: "--keytab-file KEYTAB_FILE",
      description: "The Kerberos keytab file used for authentication"

    option :kerberos_realm,
      short: "-R KERBEROS_REALM",
      long: "--kerberos-realm KERBEROS_REALM",
      description: "The Kerberos realm used for authentication"

    option :kerberos_service,
      short: "-S KERBEROS_SERVICE",
      long: "--kerberos-service KERBEROS_SERVICE",
      description: "The Kerberos service used for authentication"

    option :ca_trust_file,
      short: "-f CA_TRUST_FILE",
      long: "--ca-trust-file CA_TRUST_FILE",
      description: "The Certificate Authority (CA) trust file used for SSL transport"

    option :winrm_ssl_verify_mode,
      long: "--winrm-ssl-verify-mode SSL_VERIFY_MODE",
      description: "The WinRM peer verification mode. Valid choices are [verify_peer, verify_none]",
      default: :verify_peer,
      proc: Proc.new { |verify_mode| verify_mode.to_sym }

    option :ssl_peer_fingerprint,
      long: "--ssl-peer-fingerprint FINGERPRINT",
      description: "ssl Cert Fingerprint to bypass normal cert chain checks"

    option :winrm_authentication_protocol,
      long: "--winrm-authentication-protocol AUTHENTICATION_PROTOCOL",
      description: "The authentication protocol used during WinRM communication. The supported protocols are #{WINRM_AUTH_PROTOCOL_LIST.join(",")}. Default is 'negotiate'.",
      default: "negotiate"

    option :session_timeout,
      long: "--session-timeout Minutes",
      description: "The timeout for the client for the maximum length of the WinRM session",
      default: 30

    option :winrm_codepage,
      long: "--winrm-codepage Codepage",
      description: "The codepage to use for the winrm cmd shell",
      default: 65001
  end
end