Ресурс windows_printer

Редактировать эту страницу в репозитории Chef

Все страницы ресурсов Infra

Используйте ресурс windows_printer для настройки принтеров Windows. Этот ресурс автоматически установит драйвер, указанный в свойстве driver_name, и автоматически создаст порт принтера, используя свойство ipv4_address или свойство port_name.

Новинка в Chef Infra Client 14.0.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса windows_printer:

windows_printer 'name' do
  comment           String
  create_port       true, false # default value: true
  default           true, false # default value: false
  device_id         String # default value: 'name' unless specified
  driver_name       String
  ipv4_address      String
  location          String
  port_name         String
  share_name        String
  shared            true, false # default value: false
  action            Symbol # defaults to :create if not specified
end

где:

• windows_printer — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет, какие шаги Chef Infra Client предпримет для приведения узла в желаемое состояние.
• comment, create_port, default, device_id, driver_name, ipv4_address, location, port_name, share_name, и shared — доступные для этого ресурса свойства.

Действия

Ресурс windows_printer имеет следующие действия:

:create

Создать новый принтер и порт принтера, если их еще нет. (по умолчанию)

:delete

Удалить существующий принтер. Обратите внимание, что этот ресурс не удаляет связанный порт принтера.

:nothing

Этот блок ресурса не выполняет действий, пока не получит уведомление от другого ресурса о необходимости действий. После получения уведомления этот блок ресурса либо выполняется немедленно, либо помещается в очередь для выполнения в конце выполнения Chef Infra Client.

Свойства

Ресурс windows_printer имеет следующие свойства:

comment

Тип Ruby: Строка

Необязательное описание очереди печати.

create_port

Тип Ruby: true, false | Значение по умолчанию: true

Создать порт принтера для принтера. Установите значение false и укажите свойство port_name, если вы используете ресурс windows_printer_port для создания порта вместо этого.

Новая функция в Chef Infra Client 17.3

default

Тип Ruby: true, false | Значение по умолчанию: false

Определяет, будет ли этот принтер системным принтером по умолчанию.

device_id

Тип Ruby: Строка | Значение по умолчанию: The resource block's name

Необязательное свойство для установки имени очереди принтера, если оно отличается от имени блока ресурса. Пример: HP LJ 5200 in fifth floor copy room.

driver_name

Тип Ruby: Строка | REQUIRED

Точное имя установленного на системе драйвера принтера.

ipv4_address

Тип Ruby: Строка

IP-адрес принтера, например 10.4.64.23

location

Тип Ruby: Строка

Расположение принтера, например Fifth floor copy room.

port_name

Тип Ruby: Строка | Значение по умолчанию: The resource block name or the ipv4_address prepended with IP_.

Имя порта.

Новая функция в Chef Infra Client 17.3

share_name

Тип Ruby: Строка

Имя, используемое для идентификации общего принтера.

shared

Тип Ruby: true, false | Значение по умолчанию: false

Определяет, является ли принтер общим.

Общие функциональные возможности ресурсов

Ресурсы Chef включают общие свойства, уведомления и блокировки ресурсов.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

Тип Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс выполняется на узле. Установите значение true, чтобы запустить ресурс во время построения коллекции ресурсов (compile phase). Установите значение false, чтобы запустить ресурс во время настройки узла Chef Infra Client (converge phase).

ignore_failure

Тип Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжить выполнение рецепта, если ресурс завершился ошибкой по любой причине. :quiet не будет отображать полный стек вызовов, и рецепт продолжит выполнение, если ресурс завершится ошибкой.

retries

Тип Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехвата исключений и повторного выполнения ресурса.

retry_delay

Тип Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

Тип Ruby: true, false | Значение по умолчанию: false

Обеспечение того, что конфиденциальные данные ресурса не регистрируются Chef Infra Client.

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о необходимости действий при изменении его состояния. Укажите 'resource[name]', действие, которое должен предпринять :action, и :timer для этого действия. Ресурс может уведомлять несколько ресурсов; используйте оператор notifies для каждого ресурса, который должен быть уведомлен.

Если указанный ресурс не существует, возникает ошибка. В отличие от этого, subscribes не завершится ошибкой, если исходный ресурс не найден.

Таймер указывает момент во время выполнения Chef Infra Client, в который выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно для каждого уведомленного ресурса.

Синтаксис для notifies:

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

subscribes

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может прослушивать другой ресурс и затем выполнять действие, если состояние прослушиваемого ресурса меняется. Укажите 'resource[name]', действие, которое нужно предпринять, и :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он прослушивает — например:

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

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный по адресу /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, он просто прослушивает изменения файла и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменения.

Если другого ресурса не существует, подписка не генерирует ошибку. В отличие от более жесткой семантики notifies, которая генерирует ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения Chef Infra Client, в который выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно для каждого уведомленного ресурса.

Синтаксис для subscribes:

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

Блокировки

Свойство блокировки может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. На основании результатов этой оценки свойство блокировки затем используется для указания Chef Infra Client, следует ли продолжать выполнение ресурса. Свойство блокировки принимает либо строковое значение, либо значение блока Ruby:

• Строка выполняется как команда оболочки. Если команда возвращает 0, блокировка применяется. Если команда возвращает любое другое значение, то свойство блокировки не применяется. Строковые блокировки в powershell_script выполняют команды Windows PowerShell и могут возвращать true, а также 0.
• Блок выполняется как код Ruby, который должен вернуть либо true, либо false. Если блок возвращает true, свойство блокировки применяется. Если блок возвращает false, свойство блокировки не применяется.

Свойство блокировки полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние по мере его выполнения и, если желаемое состояние присутствует, не выполнять никаких действий Chef Infra Client.

Следующие свойства могут использоваться для определения блокировки, которая оценивается во время фазы выполнения Chef Infra Client:

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

В следующих примерах демонстрируются различные подходы к использованию ресурса windows_printer в рецептах:

Создать принтер:

windows_printer 'HP LaserJet 5th Floor' do
  driver_name 'HP LaserJet 4100 Series PCL6'
  ipv4_address '10.4.64.38'
end

Удалить принтер:

Примечание: это не удаляет связанный порт принтера. Для удаления порта см. windows_printer_port выше.

windows_printer 'HP LaserJet 5th Floor' do
  action :delete
end

Создать порт принтера и принтер, использующий этот порт (новая функция в версии 17.3)

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