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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
compare_to строка	Родительский ключ для сравнения содержимого реестра с содержимым файла. Должен быть частью HKLM или HKCU реестра. Используйте путь в стиле PS-Drive, например HKLM:\SOFTWARE, а не HKEY_LOCAL_MACHINE\SOFTWARE. Если не указано или ключ реестра не найден, сравнение не будет произведено, и модуль сообщит об изменениях.
content строка добавлен в community.windows 2.2.0	При использовании вместо `path`, объединяет указанное значение в реестр Windows. Оно не должно содержать символ обозначения порядка байтов.
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 логическое	Найден ли родительский ключ реестра для сравнения Возвращается: когда родительский ключ реестра не найден Пример: `false`
compared логическое	Выполнено ли сравнение между реестром и файлом Возвращается: когда ключ сравнения был указан и сравнение было выполнено Пример: `true`
difference_count целое число	Количество различий между реестром и файлом Возвращается: при изменении Пример: `1`

Авторы

Jon Hawkesworth (@jhawkesworth)

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

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