win_regedit - Добавление, изменение или удаление ключей и значений реестра
Новая версия с 2.0.
Описание
- Добавление, изменение или удаление ключей и значений реестра.
- Дополнительная информация о реестре Windows из Википедии https://en.wikipedia.org/wiki/Windows_Registry.
Параметры
| Параметр | Обязателен | Значение по умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| data | нет | Значение записи реестра name в path. Если не указано, значение свойства будет null для соответствующего type. Данные типа binary и None должны быть выражены в виде yaml-байтового массива или через запятую с шестнадцатеричными значениями. Простой способ их получения — запустить regedit.exe и использовать опцию экспорт для сохранения значений реестра в файл.В экспортированном файле двоичные значения будут выглядеть как hex:be,ef,be,ef, префикс hex: необязателен.Значения DWORD и QWORD должны быть представлены либо десятичным числом, либо шестнадцатеричным значением. Значения Multistring должны передаваться в виде списка. См. примеры для получения более подробной информации о формате данных. | ||
| delete_key (добавлено в 2.4)
| нет | да |
| Если state имеет значение 'absent', это приведет к удалению всего ключа.Если значение ложно, то будет очищено только свойство '(Default)' для данного ключа. |
| name | нет | Имя записи реестра в вышеперечисленных параметрах path. Если не указано или пустое, используется свойство '(Default)' ключа. псевдонимы: запись | ||
| path | да | Имя пути к реестру. Должен находиться в одном из следующих разделов реестра: HKCC, HKCR, HKCU, HKLM, HKU. псевдонимы: ключ | ||
| state | нет | present |
| Состояние записи реестра. |
| type | нет | строка |
| Тип данных значения реестра. псевдонимы: тип_данных |
Примеры
- name: Create registry path MyCompany
win_regedit:
path: HKCU:\Software\MyCompany
- name: Add or update registry path MyCompany, with entry 'hello', and containing 'world'
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
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
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
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
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'
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'
win_regedit:
path: HKCU:\Software\MyCompany
name: hello
data: ['hello', 'world']
type: multistring
- name: Disable keyboard layout hotkey for all users (changes existing)
win_regedit:
path: HKU:\.DEFAULT\Keyboard Layout\Toggle
name: Layout Hotkey
data: 3
type: dword
- name: Disable language hotkey for current users (adds new)
win_regedit:
path: HKCU:\Keyboard Layout\Toggle
name: Language Hotkey
data: 3
type: dword
- name: Remove registry path MyCompany (including all entries it contains)
win_regedit:
path: HKCU:\Software\MyCompany
state: absent
delete_key: yes
- name: Clear the existing (Default) entry at path MyCompany
win_regedit:
path: HKCU:\Software\MyCompany
state: absent
delete_key: no
- name: Remove entry 'hello' from registry path MyCompany
win_regedit:
path: HKCU:\Software\MyCompany
name: hello
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращаемое | Тип | Пример |
|---|---|---|---|---|
| data_changed | Изменились ли данные в значении реестра в ходе выполнения | Успех | булево | Ложь |
| data_type_changed | Изменился ли тип данных значения реестра в ходе выполнения | Успех | булево | Истина |
Примечания
Примечание
- Режим проверки
-C/--checkи вывод различий-D/--diffподдерживаются, так что вы можете проверить каждое изменение относительно активной конфигурации перед применением изменений. - Обратите внимание, что некоторые разделы реестра (
HKEY_USERSв частности) не позволяют создавать новые пути к реестру. - С Ansible 2.4 при проверке изменения строкового значения реестра используется чувствительный к регистру тест. Раньше применялся тест, нечувствительный к регистру.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке данного модуля компанией Red Hat, пожалуйста, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если у вас есть такие желания, пожалуйста, прочтите Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_regedit_module.html