1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
#
# Author:: Doug Ireton <doug@1strategy.com>
# Copyright:: 2012-2018, Nordstrom, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# See here for more info:
# http://msdn.microsoft.com/en-us/library/windows/desktop/aa394492(v=vs.85).aspx
require_relative "../resource"
class Chef
class Resource
class WindowsPrinterPort < Chef::Resource
unified_mode true
autoload :Resolv, "resolv"
provides(:windows_printer_port) { true }
description "Use the **windows_printer_port** resource to create and delete TCP/IPv4 printer ports on Windows."
introduced "14.0"
examples <<~DOC
**Delete a printer port**
```ruby
windows_printer_port '10.4.64.37' do
action :delete
end
```
**Delete a port with a custom port_name**
```ruby
windows_printer_port '10.4.64.38' do
port_name 'My awesome port'
action :delete
end
```
**Create a port with more options**
```ruby
windows_printer_port '10.4.64.39' do
port_name 'My awesome port'
snmp_enabled true
port_protocol 2
end
```
DOC
property :ipv4_address, String,
name_property: true,
description: "An optional property for the IPv4 address of the printer if it differs from the resource block's name.",
callbacks: {
"The ipv4_address property must be in the format of WWW.XXX.YYY.ZZZ!" =>
proc { |v| v.match(Resolv::IPv4::Regex) },
}
property :port_name, String,
description: "The port name."
property :port_number, Integer,
description: "The port number.",
default: 9100
property :port_description, String,
description: "The description of the port."
property :snmp_enabled, [TrueClass, FalseClass],
description: "Determines if SNMP is enabled on the port.",
default: false
property :port_protocol, Integer,
description: "The printer port protocol: 1 (RAW) or 2 (LPR).",
validation_message: "port_protocol must be either 1 for RAW or 2 for LPR!",
default: 1, equal_to: [1, 2]
PORTS_REG_KEY = 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\Standard TCP/IP Port\Ports\\'.freeze unless defined?(PORTS_REG_KEY)
# @todo Set @current_resource port properties from registry
load_current_value do |new_resource|
name new_resource.name
ipv4_address new_resource.ipv4_address
port_name new_resource.port_name || "IP_#{new_resource.ipv4_address}"
end
action :create, description: "Create the printer port, if one doesn't already exist" do
description "Create the new printer port if it does not already exist."
if port_exists?
Chef::Log.info "#{@new_resource} already exists - nothing to do."
else
converge_by("Create #{@new_resource}") do
create_printer_port
end
end
end
action :delete, description: "Delete an existing printer port" do
description "Delete an existing printer port."
if port_exists?
converge_by("Delete #{@new_resource}") do
delete_printer_port
end
else
Chef::Log.info "#{@current_resource} doesn't exist - can't delete."
end
end
action_class do
private
def port_exists?
name = new_resource.port_name || "IP_#{new_resource.ipv4_address}"
port_reg_key = PORTS_REG_KEY + name
logger.trace "Checking to see if this reg key exists: '#{port_reg_key}'"
registry_key_exists?(port_reg_key)
end
def create_printer_port
port_name = new_resource.port_name || "IP_#{new_resource.ipv4_address}"
# create the printer port using PowerShell
declare_resource(:powershell_script, "Creating printer port #{new_resource.port_name}") do
code <<-EOH
Set-WmiInstance -class Win32_TCPIPPrinterPort `
-EnableAllPrivileges `
-Argument @{ HostAddress = "#{new_resource.ipv4_address}";
Name = "#{port_name}";
Description = "#{new_resource.port_description}";
PortNumber = "#{new_resource.port_number}";
Protocol = "#{new_resource.port_protocol}";
SNMPEnabled = "$#{new_resource.snmp_enabled}";
}
EOH
end
end
def delete_printer_port
port_name = new_resource.port_name || "IP_#{new_resource.ipv4_address}"
declare_resource(:powershell_script, "Deleting printer port: #{new_resource.port_name}") do
code <<-EOH
$port = Get-WMIObject -class Win32_TCPIPPrinterPort -EnableAllPrivileges -Filter "name = '#{port_name}'"
$port.Delete()
EOH
end
end
end
end
end
end
|
