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

Примечание

Этот плагин входит в коллекцию ansible.windows (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ansible.windows.

Чтобы использовать его в книге задач, укажите: ansible.windows.win_reg_stat.

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

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

Параметры

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

Примечания

Примечание

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

См. также

ansible.windows.win_regedit: Официальная документация модуля ansible.windows.win_regedit.
ansible.windows.win_regmerge: Официальная документация модуля ansible.windows.win_regmerge.

Примеры

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

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

- name: Obtain the registry key's (Default) property
  ansible.windows.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

Авторы

Jordan Borean (@jborean93)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_reg_stat_module.html