ansible / ansible.builtin / v2.8.18 / module / win_regedit Add, change, or remove registry keys and values | "added in version" 2.0 of ansible.builtin" Authors: Adam Keech (@smadam813), Josh Ludwig (@joshludwig), Jordan Borean (@jborean93) preview | supported by coreansible.builtin.win_regedit (v2.8.18) — module
pip
Install with pip install ansible==2.8.18
Add, modify or remove registry keys and values.
More information about the windows registry from Wikipedia U(https://en.wikipedia.org/wiki/Windows_Registry).
- name: Create registry path MyCompany win_regedit: path: HKCU:\Software\MyCompany
- name: Add or update registry path MyCompany, with entry 'hello', and containing 'world' win_regedit: path: HKCU:\Software\MyCompany name: hello data: world
- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 1337 as the decimal value win_regedit: path: HKCU:\Software\MyCompany name: hello data: 1337 type: dword
- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 0xff2500ae as the hex value win_regedit: path: HKCU:\Software\MyCompany name: hello data: 0xff2500ae type: dword
- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in hex-string format win_regedit: path: HKCU:\Software\MyCompany name: hello data: hex:be,ef,be,ef,be,ef,be,ef,be,ef type: binary
- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in yaml format win_regedit: path: HKCU:\Software\MyCompany name: hello data: [0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef] type: binary
- name: Add or update registry path MyCompany, with expand string entry 'hello' win_regedit: path: HKCU:\Software\MyCompany name: hello data: '%appdata%\local' type: expandstring
- name: Add or update registry path MyCompany, with multi string entry 'hello' win_regedit: path: HKCU:\Software\MyCompany name: hello data: ['hello', 'world'] type: multistring
- name: Disable keyboard layout hotkey for all users (changes existing) win_regedit: path: HKU:\.DEFAULT\Keyboard Layout\Toggle name: Layout Hotkey data: 3 type: dword
- name: Disable language hotkey for current users (adds new) win_regedit: path: HKCU:\Keyboard Layout\Toggle name: Language Hotkey data: 3 type: dword
- name: Remove registry path MyCompany (including all entries it contains) win_regedit: path: HKCU:\Software\MyCompany state: absent delete_key: yes
- name: Clear the existing (Default) entry at path MyCompany win_regedit: path: HKCU:\Software\MyCompany state: absent delete_key: no
- name: Remove entry 'hello' from registry path MyCompany win_regedit: path: HKCU:\Software\MyCompany name: hello state: absent
- name: Change default mouse trailing settings for new users win_regedit: path: HKLM:\ANSIBLE\Control Panel\Mouse name: MouseTrails data: 10 type: str state: present hive: C:\Users\Default\NTUSER.dat
data: description: - Value of the registry entry C(name) in C(path). - If not specified then the value for the property will be null for the corresponding C(type). - Binary and None data should be expressed in a yaml byte array or as comma separated hex values. - An easy way to generate this is to run C(regedit.exe) and use the I(export) option to save the registry values to a file. - In the exported file, binary value will look like C(hex:be,ef,be,ef), the C(hex:) prefix is optional. - DWORD and QWORD values should either be represented as a decimal number or a hex value. - Multistring values should be passed in as a list. - See the examples for more details on how to format this data. type: str hive: description: - A path to a hive key like C:\Users\Default\NTUSER.DAT to load in the registry. - This hive is loaded under the HKLM:\ANSIBLE key which can then be used in I(name) like any other path. - This can be used to load the default user profile registry hive or any other hive saved as a file. - Using this function requires the user to have the C(SeRestorePrivilege) and C(SeBackupPrivilege) privileges enabled. type: path version_added: '2.5' version_added_collection: ansible.builtin name: aliases: - entry description: - Name of the registry entry in the above C(path) parameters. - If not provided, or empty then the '(Default)' property for the key will be used. type: str path: aliases: - key description: - Name of the registry path. - 'Should be in one of the following registry hives: HKCC, HKCR, HKCU, HKLM, HKU.' required: true type: str type: aliases: - datatype choices: - binary - dword - expandstring - multistring - string - qword default: string description: - The registry value data type. type: str state: choices: - absent - present default: present description: - The state of the registry entry. type: str delete_key: default: true description: - When C(state) is 'absent' then this will delete the entire key. - If C(no) then it will only clear out the '(Default)' property for that key. type: bool version_added: '2.4' version_added_collection: ansible.builtin
data_changed: description: Whether this invocation changed the data in the registry value. returned: success sample: false type: bool data_type_changed: description: Whether this invocation changed the datatype of the registry value. returned: success sample: true type: bool