ansible.windows.win_regedit – Добавление, изменение или удаление ключей и значений реестра

Примечание

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

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

Для использования в плейбуке укажите: ansible.windows.win_regedit.

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

Описание

Добавление, изменение или удаление ключей и значений реестра.
Дополнительную информацию о реестре Windows можно найти на Википедии https://ru.wikipedia.org/wiki/Реестр_Windows.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
data raw		Значение записи реестра `name` в `path`. Если не указано, значение свойства будет null для соответствующего `type`. Двоичные и None данные должны быть представлены в виде массива байтов YAML или в виде шестнадцатеричных значений, разделенных запятыми. Легкий способ сгенерировать это — запустить `regedit.exe` и использовать опцию export для сохранения значений реестра в файл. В экспортированном файле двоичное значение будет выглядеть как `hex:be,ef,be,ef`, префикс `hex:` необязателен. Значения DWORD и QWORD должны быть представлены либо в виде десятичного числа, либо в виде шестнадцатеричного значения. Значения Multistring должны передаваться как список. Подробные сведения о формате этих данных см. в примерах.
delete_key boolean	Варианты: no yes ←	Если `state` равно 'absent', то этот параметр удалит весь ключ. Если `no`, то он только очистит свойство '(Default)' для данного ключа.
hive path		Путь к ключу раздела реестра, например, C:\Users\Default\NTUSER.DAT для загрузки в реестр. Этот раздел загружается под ключом HKLM:\ANSIBLE, который затем можно использовать в параметре name как любой другой путь. Это можно использовать для загрузки раздела реестра профиля пользователя по умолчанию или любого другого раздела, сохранённого в файле. Использование этой функции требует, чтобы у пользователя были разрешения `SeRestorePrivilege` и `SeBackupPrivilege`.
name string		Имя записи реестра в вышеуказанных параметрах `path`. Если не указано или пусто, будет использоваться свойство '(Default)' ключа. псевдонимы: запись, значение
path string / required		Имя пути реестра. Должен находиться в одном из следующих разделов реестра: HKCC, HKCR, HKCU, HKLM, HKU. псевдонимы: ключ
state string	Варианты: absent present ←	Состояние записи реестра.
type string	Варианты: none binary dword expandstring multistring string ← qword	Тип данных значения реестра. псевдонимы: тип_данных

Примечания

Примечание

Поддерживаются режим проверки -C/--check и вывод различий -D/--diff, чтобы вы могли протестировать каждое изменение по отношению к активной конфигурации перед применением изменений.
Будьте осторожны, так как некоторые разделы реестра (в частности, HKEY_USERS) не позволяют создавать новые пути реестра в корневой папке.

См. также

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

Примеры

- name: Create registry path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany

- name: Add or update registry path MyCompany, with entry 'hello', and containing 'world'
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: world

- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 1337 as the decimal value
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: 1337
    type: dword

- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 0xff2500ae as the hex value
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: 0xff2500ae
    type: dword

- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in hex-string format
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: hex:be,ef,be,ef,be,ef,be,ef,be,ef
    type: binary

- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in yaml format
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: [0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef]
    type: binary

- name: Add or update registry path MyCompany, with expand string entry 'hello'
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: '%appdata%\local'
    type: expandstring

- name: Add or update registry path MyCompany, with multi string entry 'hello'
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: ['hello', 'world']
    type: multistring

- name: Disable keyboard layout hotkey for all users (changes existing)
  ansible.windows.win_regedit:
    path: HKU:\.DEFAULT\Keyboard Layout\Toggle
    name: Layout Hotkey
    data: 3
    type: dword

- name: Disable language hotkey for current users (adds new)
  ansible.windows.win_regedit:
    path: HKCU:\Keyboard Layout\Toggle
    name: Language Hotkey
    data: 3
    type: dword

- name: Remove registry path MyCompany (including all entries it contains)
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    state: absent
    delete_key: yes

- name: Clear the existing (Default) entry at path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    state: absent
    delete_key: no

- name: Remove entry 'hello' from registry path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    state: absent

- name: Change default mouse trailing settings for new users
  ansible.windows.win_regedit:
    path: HKLM:\ANSIBLE\Control Panel\Mouse
    name: MouseTrails
    data: 10
    type: str
    state: present
    hive: C:\Users\Default\NTUSER.dat

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

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

Ключ	Возвращаемое значение	Описание
data_changed boolean	success	Указывает, было ли изменено значение реестра.
data_type_changed boolean	success	Указывает, был ли изменён тип данных значения реестра. Пример: True

Авторы

Adam Keech (@smadam813)
Josh Ludwig (@joshludwig)
Jordan Borean (@jborean93)

© 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/ansible/windows/win_regedit_module.html