Spec-Zone.ru › Ansible 2.5

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 должны быть представлены как десятичное число или шестнадцатеричное значение.
Значения многострочного типа должны передаваться как список.
Более подробную информацию о формате этих данных см. в примерах.
delete_key
(добавлено в 2.4)
    Варианты:
  • нет
  • да ←
Если state имеет значение 'отсутствует', это приведет к удалению всего ключа.
Если значение ложно, будет удалено только свойство '(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
  • строка с расширением
  • многострочная
  • строка ←
  • 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
булево
успех
указывает, изменились ли данные в значении реестра при этом вызове

data_type_changed
булево
успех
указывает, изменился ли тип данных значения реестра при этом вызове

Пример:
Истина


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Поддержка

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

Spec-Zone.ru

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