windows_printer_port

[edit on GitHub]

Use the windows_printer_port resource to create and delete TCP/IPv4 printer ports on Windows.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

windows_printer_port 'name' do
  ipv4_address               String # default value: 'name'
  notifies                   # see description
  port_description           String
  port_name                  String
  port_number                Integer # default value: '9100'
  port_protocol              Integer # default value: '1'
  snmp_enabled               True, False # default value: 'false'
  subscribes                 # see description
  action                     Symbol # defaults to :create if not specified
end

where:

  • windows_printer_port is the resource
  • 'name' is the IP address of the printer, or the name of the resource block
  • and subscribes are the properties available to this resource

Actions

:create
Default. Create the printer port, if one doesn’t already exist.
:delete
Delete an existing printer port.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.

Properties

ipv4_address

Ruby Type: String | Default Value: 'name'

The IPv4 address of the printer, if it differs from the resource block name.

notifies

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may notify another resource to take action when its state changes. Specify a 'resource[name]', the :action that resource should take, and then the :timer for that action. A resource may notify more than one resource; use a notifies statement for each resource to be notified.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
port_description

Ruby Type: String

A description of the port.

port_name

Ruby Type: String

The port name.

port_number

Ruby Type: Integer | Default Value: 9100

The port number.

port_protocol

Ruby Type: Integer | Default Value: 1

The printer port protocol; 1 (RAW) or 2 (LPR).

snmp_enabled

Ruby Type: True, False | Default Value: false

Determines ig SNMP is enabled on the port.

subscribes

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]', the :action to be taken, and then the :timer for that action.

Note that subscribes does not apply the specified action to the resource that it listens to - for example:

file '/etc/nginx/ssl/example.crt' do
   mode '0600'
   owner 'root'
end

service 'nginx' do
   subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

In this case the subscribes property reloads the nginx service whenever its certificate file, located under /etc/nginx/ssl/example.crt, is updated. subscribes does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the :reload action for its resource (in this example nginx) when a change is detected.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

subscribes :action, 'resource[name]', :timer