win_reg_stat - возвращает информацию о ключе или свойстве реестра Windows
Новая в версии 2.3.
Описание
- Как и win_file, win_reg_stat вернёт, существует ли ключ/свойство.
- Он также возвращает вложенные ключи и свойства указанного ключа.
- Если задано имя свойства через параметр property, он вернёт информацию, специфичную для этого свойства.
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| name | нет | Имя свойства реестра, для которого нужно получить информацию. Возвращаемый JSON не будет содержать записи sub_keys и properties для указанного ключа key. псевдонимы: entry, value, property | ||
| path | да | Полный путь к ключу реестра, включая раздел для поиска. псевдонимы: key |
Примеры
# Obtain information about a registry key using short form
- win_reg_stat:
path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
register: current_version
# Obtain information about a registry key property
- win_reg_stat:
path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
name: CommonFilesDir
register: common_files_dir
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие являются полями, уникальными для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| changed | Изменилось ли что-либо. | всегда | логическое значение | True |
| exists | Указывает, существует ли ключ/свойство реестра. | при успехе и наличии пути/свойства | логическое значение | 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 и разработкой модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_reg_stat_module.html
