Spec-Zone.ru › Ansible 2.6

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

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Поддержка
    • Автор

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
data
Значение записи реестра name в path.
Если не указано, значение свойства будет равно null для соответствующего type.
Данные типа двоичного и None должны быть представлены в формате массива байтов YAML или в виде шестнадцатеричных значений, разделенных запятыми.
Легкий способ их генерации — запустить regedit.exe и использовать опцию export для сохранения значений реестра в файл.
В экспортированном файле двоичное значение будет выглядеть как hex:be,ef,be,ef, префикс hex: необязателен.
Значения DWORD и QWORD должны быть представлены в виде десятичного числа или шестнадцатеричного значения.
Значения типа многострочный должны передаваться в виде списка.
См. примеры для получения более подробной информации о формате этих данных.
delete_key
bool

(добавлен в 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
  • многострочный
  • строка ←
  • qword
Тип данных значения реестра.

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

Примечания

Примечание

  • Поддерживается режим проверки -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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых Командой ядра Ansible, см. здесь.

Поддержка

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

Spec-Zone.ru

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