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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#
# Author:: Doug Ireton (<doug@1strategy.com>)
# Copyright:: 2012-2018, Nordstrom, Inc.
# Copyright:: Chef Software, 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
# @todo
# 1. Allow updating the printer properties
# 2. Fail with a warning if the port can't be found and create_port is false
# 3. Fail with helpful messaging if the printer driver can't be installed
class WindowsPrinter < Chef::Resource
autoload :Resolv, "resolv"
provides(:windows_printer) { true }
description "Use the **windows_printer** resource to setup Windows printers. This resource will automatically install the driver specified in the `driver_name` property and will automatically create a printer port using either the `ipv4_address` property or the `port_name` property."
introduced "14.0"
examples <<~DOC
**Create a printer**:
```ruby
windows_printer 'HP LaserJet 5th Floor' do
driver_name 'HP LaserJet 4100 Series PCL6'
ipv4_address '10.4.64.38'
end
```
**Delete a printer**:
Note: this doesn't delete the associated printer port. See windows_printer_port above for how to delete the port.
```ruby
windows_printer 'HP LaserJet 5th Floor' do
action :delete
end
```
**Create a printer port and a printer that uses that port (new in 17.3)**
```ruby
windows_printer_port '10.4.64.39' do
port_name 'My awesome printer port'
snmp_enabled true
port_protocol 2
end
windows_printer 'HP LaserJet 5th Floor' do
driver_name 'HP LaserJet 4100 Series PCL6'
port_name 'My awesome printer port'
ipv4_address '10.4.64.38'
create_port false
end
```
DOC
property :device_id, String,
description: "An optional property to set the printer queue name if it differs from the resource block's name. Example: `HP LJ 5200 in fifth floor copy room`.",
name_property: true
property :comment, String,
description: "Optional descriptor for the printer queue."
property :default, [TrueClass, FalseClass],
description: "Determines whether or not this should be the system's default printer.",
default: false
property :driver_name, String,
description: "The exact name of printer driver installed on the system.",
required: [:create]
property :location, String,
description: "Printer location, such as `Fifth floor copy room`."
property :shared, [TrueClass, FalseClass],
description: "Determines whether or not the printer is shared.",
default: false
property :share_name, String,
description: "The name used to identify the shared printer."
property :ipv4_address, String,
description: "The IPv4 address of the printer, such as `10.4.64.23`",
callbacks: {
"The ipv4_address property must be in the IPv4 format of `WWW.XXX.YYY.ZZZ`" =>
proc { |v| v.match(Resolv::IPv4::Regex) },
}
property :create_port, [TrueClass, FalseClass],
description: "Create a printer port for the printer. Set this to false and specify the `port_name` property if using the `windows_printer_port` resource to create the port instead.",
introduced: "17.3",
default: true, desired_state: false
property :port_name, String,
description: "The port name.",
default: lazy { |x| "IP_#{x.ipv4_address}" },
introduced: "17.3",
default_description: "The resource block name or the ipv4_address prepended with IP_."
load_current_value do |new_resource|
printer_data = powershell_exec(%Q{Get-WmiObject -Class Win32_Printer -Filter "Name='#{new_resource.device_id}'"}).result
if printer_data.empty?
current_value_does_not_exist!
else
device_id new_resource.device_id
comment printer_data["Comment"]
default printer_data["Default"]
location printer_data["Location"]
shared printer_data["Shared"]
share_name printer_data["ShareName"]
port_name printer_data["PortName"]
driver_data = powershell_exec(%Q{Get-PrinterDriver -Name="#{new_resource.driver_name}"}).result
unless driver_data.empty?
driver_name new_resource.driver_name
end
end
end
action :create, description: "Create a new printer and printer port, if one doesn't already." do
if current_resource
Chef::Log.info "#{@new_resource} already exists - nothing to do."
else
# Create the printer port first unless the property is set to false
if new_resource.create_port
windows_printer_port new_resource.port_name do
ipv4_address new_resource.ipv4_address
port_name new_resource.port_name
end
end
converge_by("install driver #{new_resource.driver_name}") do
powershell_exec!("Add-PrinterDriver -Name '#{new_resource.driver_name}'")
end
converge_by("create #{@new_resource.device_id}") do
powershell_exec! <<-EOH
Set-WmiInstance -class Win32_Printer `
-EnableAllPrivileges `
-Argument @{ DeviceID = "#{new_resource.device_id}";
Comment = "#{new_resource.comment}";
Default = "$#{new_resource.default}";
DriverName = "#{new_resource.driver_name}";
Location = "#{new_resource.location}";
PortName = "#{new_resource.port_name}";
Shared = "$#{new_resource.shared}";
ShareName = "#{new_resource.share_name}";
}
EOH
end
end
end
action :delete, description: "Delete an existing printer. Note that this resource does not delete the associated printer port." do
if current_resource
converge_by("Delete #{new_resource.device_id}") do
powershell_exec!("Remove-Printer -Name '#{new_resource.device_id}'")
end
else
Chef::Log.info "#{new_resource.device_id} doesn't exist - can't delete."
end
end
end
end
end
|
