Spec-Zone.ru › Ansible 2.8

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

Новая версия с 2.0.

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
data
строка
Значение записи реестра name в path.
Если не указано, значение свойства будет равно null для соответствующего type.
Данные типа binary и None должны быть представлены в виде массива байтов YAML или в виде разделенных запятыми шестнадцатеричных значений.
Простой способ генерации этих данных — запуск regedit.exe и использование опции export для сохранения значений реестра в файл.
В экспортированном файле двоичные значения будут выглядеть как hex:be,ef,be,ef, префикс hex: необязателен.
Значения DWORD и QWORD должны быть представлены либо десятичным числом, либо шестнадцатеричным значением.
Значения multistring должны передаваться в виде списка.
См. примеры для получения дополнительной информации о формате этих данных.
delete_key
логическое
добавлено в 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
строка
    Варианты:
  • двоичный
  • dword
  • expandstring
  • multistring
  • строка ←
  • qword
Тип данных значения реестра.

псевдонимы: тип данных

Примечания

Примечание

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

См. также

См. также

win_reg_stat – Получение информации о ключах реестра Windows
Официальная документация модуля win_reg_stat.
win_regmerge – Объединение содержимого файла реестра в реестр Windows
Официальная документация модуля win_regmerge.

Примеры

- 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: str
    state: present
    hive: C:\Users\Default\NTUSER.dat

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

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

Ключ Возвращаемое значение Описание
data_changed
логическое
успех
Изменились ли данные в значении реестра при данном вызове.

data_type_changed
логическое
успех
Изменился ли тип данных значения реестра при данном вызове.

Пример:
True


Статус

  • Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
  • Этот модуль поддерживается командой разработчиков Ansible. [ядро]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля 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.8/modules/win_regedit_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API