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

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

Описание
Параметры
Примеры
Значения возврата
Статус

Описание

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

Параметры

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

Примеры

- 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

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

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	Указывает, были ли внесены изменения. Пример: True
exists boolean	успех и путь/свойство существуют	Указывает, существует ли ключ/свойство реестра. Пример: True
properties словарь	успех, путь существует и свойство не указано	Словарь, содержащий все свойства и их значения в ключе реестра. Пример: {'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.7/modules/win_reg_stat_module.html