Модуль community.windows.win_regmerge — объединяет содержимое файла реестра с реестром Windows

Примечание

Этот модуль входит в коллекцию community.windows (версия 3.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в плейбуке, укажите: community.windows.win_regmerge.

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

Краткое описание

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

Параметры

Параметр	Комментарии
compare_to string	Родительский ключ, используемый для сравнения содержимого реестра с содержимым файла. Должен находиться в разделе HKLM или HKCU реестра. Используйте путь в формате PS-Drive, например HKLM:\SOFTWARE, а не HKEY_LOCAL_MACHINE\SOFTWARE. Если параметр не указан или ключ реестра не найден, сравнение выполняться не будет, и модуль сообщит об изменении.
content string добавлено в community.windows 2.2.0	При использовании вместо `path` объединяет указанное значение с реестром Windows. Оно не должно содержать метку порядка байтов (BOM).
path path	Полный путь, включая имя файла реестра на удалённом компьютере, который необходимо объединить

Примечания

Примечание

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

См. также

ansible.windows.win_reg_stat: Получение сведений о ключах реестра Windows.
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

- name: Merge in a registry file specified as content without comparing to current registry
  community.windows.win_regmerge:
    content: |
      Windows Registry Editor Version 5.00

      [HKEY_LOCAL_MACHINE\SOFTWARE\myCompany]
      "ExampleKey"=dword:00000001

- name: Compare and merge registry file specified as content
  community.windows.win_regmerge:
    content: |
      Windows Registry Editor Version 5.00

      [HKEY_LOCAL_MACHINE\SOFTWARE\myCompany]
      "ExampleKey"=dword:00000001
    compare_to: HKLM:\SOFTWARE\myCompany

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

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

Ключ	Описание
compare_to_key_found boolean	найден ли родительский ключ реестра для сравнения Возвращается: если ключ для сравнения не найден в реестре Пример: `false`
compared boolean	выполнялось ли сравнение реестра с файлом Возвращается: если указан ключ для сравнения и была предпринята попытка сравнения Пример: `true`
difference_count integer	количество различий между реестром и файлом Возвращается: если обнаружены изменения Пример: `1`

Авторы

Jon Hawkesworth (@jhawkesworth)

Ссылки на коллекцию

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