win_reg_stat - возвращает информацию о ключе или свойстве ключа реестра Windows
Новое в версии 2.3.
Описание
- Как и win_file, win_reg_stat вернёт, существует ли ключ/свойство.
- Он также возвращает дочерние ключи и свойства указанного ключа.
- Если указано имя свойства через property, он вернёт информацию, специфичную для этого свойства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name | Имя свойства реестра, для которого нужно получить информацию. Возвращаемый JSON не будет содержать записи sub_keys и properties для указанного ключа. Псевдонимы: 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 boolean | всегда | Изменилось ли что-либо. Пример: True |
| exists boolean | успех и путь/свойство существует | Указывает, существует ли ключ/свойство реестра. Пример: True |
| properties dict | успех, путь существует и свойство не указано | Словарь, содержащий все свойства и их значения в ключе реестра. Пример: {'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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратно совместимым.
Автор
- 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_reg_stat_module.html
