Ресурс windows_printer

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

Страница справочника ресурсов

Используйте ресурс windows_printer для настройки принтеров Windows. Обратите внимание, что данный ресурс не устанавливает драйвер принтера. Драйвер должен быть уже установлен на системе.

Новое в Chef Infra Client 14.0.

Синтаксис

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

windows_printer 'name' do
  comment           String
  default           true, false # default value: false
  device_id         String # default value: 'name' unless specified
  driver_name       String
  ipv4_address      String
  location          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, default, device_id, driver_name, ipv4_address, location, share_name, и shared — доступные свойства этого ресурса.

Действия

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

:create

По умолчанию. Создаёт новый принтер и порт принтера, если они ещё не существуют.

:delete

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

:nothing

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

Свойства

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

comment

Тип в Ruby: Строка

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

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.

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 InfraClient.

Уведомления

notifies

Тип в Ruby: Символ, 'Chef::Resource[Строка]'

Ресурс может уведомить другой ресурс о действии при изменении его состояния. Укажите '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[Строка]'

Ресурс может следить за другим ресурсом и выполнять действие, если состояние отслеживаемого ресурса изменяется. Укажите 'resource[name]', :action действие и :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