win_reg_stat — Получение информации о ключах реестра Windows
Новое в версии 2.3.
Описание
- Как и win_file, модуль win_reg_stat возвращает информацию о существовании ключа/свойства.
- Он также возвращает подключаемые ключи и свойства указанного ключа.
- Если имя свойства задано через параметр property, возвращается информация, специфичная для этого свойства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name | Имя свойства реестра, для которого требуется информация. Возвращаемый JSON не будет содержать вложенные подключаемые ключи и свойства для указанного key. псевдонимы: entry, value, property | |
| path обязательно | Полный путь к ключу реестра, включая раздел, в котором необходимо выполнить поиск. псевдонимы: 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 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 |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/win_reg_stat_module.html
