win_regedit – Добавление, изменение или удаление ключей и значений реестра
Новая версия с 2.0.
Описание
- Добавление, изменение или удаление ключей и значений реестра.
- Дополнительная информация о реестре Windows из Википедии https://en.wikipedia.org/wiki/Windows_Registry.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| data - | Значение записи реестра name в path. Если не указано, значение свойства будет равно null для соответствующего type. Данные бинарного и None типа должны быть представлены в виде массива байтов YAML или в виде шестнадцатеричных значений, разделённых запятыми. Простой способ генерации — запуск regedit.exe и использование опции экспорт для сохранения значений реестра в файл.В экспортированном файле бинарное значение будет выглядеть как hex:be,ef,be,ef, префикс hex: необязателен.Значения DWORD и QWORD должны быть представлены либо как десятичные, либо как шестнадцатеричные значения. Значения типа Multistring должны передаваться в виде списка. Более подробную информацию о формате этих данных см. в примерах. | |
| delete_key boolean добавлен в 2.4 |
| Когда state отсутствует, это приводит к удалению всего ключа.Если no, то будет очищено только свойство '(Default)' для этого ключа. |
| hive путь добавлен в 2.5 | Путь к ключу раздела реестра, например, C:\Users\Default\NTUSER.DAT для загрузки в реестр. Этот раздел загружается под ключом HKLM:\ANSIBLE, который затем может использоваться в параметре name, как любой другой путь. Его можно использовать для загрузки раздела реестра профиля пользователя по умолчанию или любого другого раздела, сохранённого в виде файла. Для использования этой функции необходимо, чтобы у пользователя были включены разрешения SeRestorePrivilege и SeBackupPrivilege. | |
| name - | Имя записи реестра в параметрах path выше.Если не указано или пусто, используется свойство '(Default)' ключа. алиасы: запись | |
| path - / обязательно | Имя пути реестра. Должен находиться в одном из следующих разделов реестра: HKCC, HKCR, HKCU, HKLM, HKU. алиасы: ключ | |
| state - |
| Состояние записи реестра. |
| type - |
| Тип данных значения реестра. алиасы: тип данных |
Примечания
Примечание
- Поддерживаются режимы проверки
-C/--checkи вывод сравнения-D/--diff, чтобы можно было протестировать каждое изменение относительно активной конфигурации перед применением изменений. - Следует помнить, что некоторые разделы реестра (в частности,
HKEY_USERS) не позволяют создавать новые пути реестра в корневой папке. - С Ansible 2.4 при проверке изменения строкового значения реестра используется чувствительный к регистру тест. Ранее тест был нечувствителен к регистру.
Примеры
- 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
- name: Change default mouse trailing settings for new users
win_regedit:
path: HKLM:\ANSIBLE\Control Panel\Mouse
name: MouseTrails
data: 10
type: string
state: present
hive: C:\Users\Default\NTUSER.dat
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| data_changed boolean | успех | указывает, было ли изменено значение в записи реестра в ходе вызова |
| data_type_changed boolean | успех | указывает, был ли изменён тип данных в записи реестра в ходе вызова Пример: Истина |
Статус
- Гарантия обратной совместимости этого модуля не предоставляется. [превью]
- Этот модуль поддерживается основной командой Ansible. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Adam Keech (@smadam813)
- Josh Ludwig (@joshludwig)
- Jordan Borean (@jborean93)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_regedit_module.html