community.windows.win_regmerge – Объединяет содержимое файла реестра в реестр Windows

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Для использования в книге задач укажите: community.windows.win_regmerge.

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Оборачивает команду reg.exe для импорта содержимого файла реестра.
Подходит для использования с файлами реестра, созданными с помощью ansible.windows.win_template.
Файлы реестра Windows имеют специфический формат и должны быть правильно построены с переносами строк вида carriage return и line feed, иначе они не будут объединены.
Экспортированные файлы реестра часто начинаются с маркера порядка байтов, который должен быть удалён, если файл должен быть шаблонизирован с помощью ansible.windows.win_template.
Формат файла реестра описан по адресу https://support.microsoft.com/en-us/kb/310516
См. также ansible.windows.win_template, ansible.windows.win_regedit

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
compare_key строка		Ключ родительского узла для сравнения содержимого реестра с содержимым файла. Должен быть в части HKLM или HKCU реестра. Используйте путь в стиле PS-привода, например, HKLM:\SOFTWARE, а не HKEY_LOCAL_MACHINE\SOFTWARE. Если параметр не указан или ключ реестра не найден, сравнение не будет выполнено, и модуль сообщит о изменениях.
path путь / обязательно		Полный путь, включая имя файла, к файлу реестра на удалённой машине, который необходимо объединить.

Примечания

Примечание

Организуйте файлы реестра так, чтобы они содержали один корневой ключ реестра, если вы хотите использовать функциональность сравнения.
Этот модуль не заставляет настройки реестра соответствовать состоянию, описанному в файле. Если настройки реестра были изменены внешним образом, модуль объединит содержимое файла, но продолжит сообщать о различиях при последующих запусках.
Чтобы принудительно изменить реестр, используйте ansible.windows.win_regedit с state=absent перед использованием community.windows.win_regmerge.

См. также

ansible.windows.win_reg_stat: Официальная документация модуля ansible.windows.win_reg_stat.
ansible.windows.win_regedit: Официальная документация модуля ansible.windows.win_regedit.

Примеры

- name: Merge in a registry file without comparing to current registry
  community.windows.win_regmerge:
    path: C:\autodeploy\myCompany-settings.reg

- name: Compare and merge registry file
  community.windows.win_regmerge:
    path: C:\autodeploy\myCompany-settings.reg
    compare_to: HKLM:\SOFTWARE\myCompany

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
compare_to_key_found логический тип	при отсутствии ключа сравнения в реестре	указывает, найден ли родительский ключ реестра для сравнения
compared логический тип	когда предоставлен ключ сравнения и выполнено сравнение	указывает, было ли выполнено сравнение между реестром и файлом Пример: True
difference_count целое число	изменён	количество различий между реестром и файлом Пример: 1

Авторы

Jon Hawkesworth (@jhawkesworth)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_regmerge_module.html