win_reg_stat – Получение информации о ключах реестра Windows

Обзор
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Как и win_file, модуль win_reg_stat возвращает информацию о существовании ключа/свойства.
Он также возвращает вложенные ключи и свойства указанного ключа.
При указании имени свойства через параметр property, он вернёт информацию, специфичную для этого свойства.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
name строка		Имя свойства реестра для получения информации, возвращаемый JSON не будет содержать записи sub_keys и properties для указанного ключа. Установите пустую строку, чтобы получить значение свойства реестра ключа (`(Default`). псевдонимы: запись, значение, свойство
path строка / обязательно		Полный путь к ключу реестра, включая раздел для поиска. псевдонимы: ключ

Примечания

Примечание

Значение возврата properties будет содержать пустой ключ "", который ссылается на значение ключа (Default). Если значение не задано, этот ключ не возвращается.

См. также

win_regedit – Добавление, изменение или удаление ключей и значений реестра: Официальная документация модуля win_regedit.
win_regmerge – Слияние содержимого файла реестра в реестр Windows: Официальная документация модуля win_regmerge.

Примеры

- name: Obtain information about a registry key using short form
  win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
  register: current_version

- name: Obtain information about a registry key property
  win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
    name: CommonFilesDir
  register: common_files_dir

- name: Obtain the registry key's (Default) property
  win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
    name: ''
  register: current_version_default

Значения возврата

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

Ключ	Возвращаемое значение	Описание
changed булево	всегда	Указывает, были ли изменения. Пример: True
exists булево	успех и путь/свойство существуют	Указывает, существует ли ключ/свойство реестра. Пример: True
properties словарь	успех, путь существует и свойство не указано	Словарь, содержащий все свойства и их значения в ключе реестра. Пример: {'': {'raw_value': '', 'type': 'REG_SZ', 'value': ''}, 'binary_property': {'raw_value': ['0x01', '0x16'], 'type': 'REG_BINARY', 'value': [1, 22]}, 'multi_string_property': {'raw_value': ['a', 'b'], 'type': 'REG_MULTI_SZ', 'value': ['a', 'b']}}
raw_value строка	успех, путь/свойство существуют и свойство указано	Возвращает исходное значение свойства реестра, для REG_EXPAND_SZ расширения строк нет, REG_BINARY или REG_NONE в формате шестнадцатеричного 0x. REG_NONE, это шестнадцатеричная строка в формате 0x. Пример: %ProgramDir%\\Common Files
sub_keys список	успех, путь существует и свойство не указано	Список всех вложенных ключей указанного ключа. Пример: ['AppHost', 'Casting', 'DateTime']
type строка	успех, путь/свойство существуют и свойство указано	Тип свойства. Пример: REG_EXPAND_SZ
value строка	успех, путь/свойство существуют и свойство указано	Значение свойства. Пример: C:\\Program Files\\Common Files

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/win_reg_stat_module.html