Mr.X

# -*- coding: utf-8 -*-

# Copyright: (c) 2015, Adam Keech <akeech@chathamfinancial.com>
# Copyright: (c) 2015, Josh Ludwig <jludwig@chathamfinancial.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = r'''
---
module: win_regedit
short_description: Add, change, or remove registry keys and values
description:
- Add, modify or remove registry keys and values.
- More information about the windows registry from Wikipedia
  U(https://en.wikipedia.org/wiki/Windows_Registry).
options:
  path:
    description:
    - Name of the registry path.
    - 'Should be in one of the following registry hives: HKCC, HKCR, HKCU,
      HKLM, HKU.'
    type: str
    required: yes
    aliases: [ key ]
  name:
    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
    aliases: [ entry, value ]
  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: raw
  type:
    description:
    - The registry value data type.
    type: str
    choices: [ none, binary, dword, expandstring, multistring, string, qword ]
    default: string
    aliases: [ datatype ]
  state:
    description:
    - The state of the registry entry.
    type: str
    choices: [ absent, present ]
    default: present
  delete_key:
    description:
    - When C(state) is 'absent' then this will delete the entire key.
    - If C(false) then it will only clear out the '(Default)' property for
      that key.
    type: bool
    default: yes
  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
notes:
- Check-mode C(-C/--check) and diff output C(-D/--diff) are supported, so that you can test every change against the active configuration before
  applying changes.
- Beware that some registry hives (C(HKEY_USERS) in particular) do not allow to create new registry paths in the root folder.
seealso:
- module: ansible.windows.win_reg_stat
- module: community.windows.win_regmerge
author:
- Adam Keech (@smadam813)
- Josh Ludwig (@joshludwig)
- Jordan Borean (@jborean93)
'''

EXAMPLES = r'''
- name: Create registry path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany

- name: Add or update registry path MyCompany, with entry 'hello', and containing 'world'
  ansible.windows.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
  ansible.windows.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
  ansible.windows.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
  ansible.windows.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
  ansible.windows.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'
  ansible.windows.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'
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    data: ['hello', 'world']
    type: multistring

- name: Disable keyboard layout hotkey for all users (changes existing)
  ansible.windows.win_regedit:
    path: HKU:\.DEFAULT\Keyboard Layout\Toggle
    name: Layout Hotkey
    data: 3
    type: dword

- name: Disable language hotkey for current users (adds new)
  ansible.windows.win_regedit:
    path: HKCU:\Keyboard Layout\Toggle
    name: Language Hotkey
    data: 3
    type: dword

- name: Remove registry path MyCompany (including all entries it contains)
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    state: absent
    delete_key: true

- name: Clear the existing (Default) entry at path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    state: absent
    delete_key: false

- name: Remove entry 'hello' from registry path MyCompany
  ansible.windows.win_regedit:
    path: HKCU:\Software\MyCompany
    name: hello
    state: absent

- name: Change default mouse trailing settings for new users
  ansible.windows.win_regedit:
    path: HKLM:\ANSIBLE\Control Panel\Mouse
    name: MouseTrails
    data: 10
    type: string
    state: present
    hive: C:\Users\Default\NTUSER.dat
'''

RETURN = r'''
data_changed:
    description: Whether this invocation changed the data in the registry value.
    returned: success
    type: bool
    sample: false
data_type_changed:
    description: Whether this invocation changed the datatype of the registry value.
    returned: success
    type: bool
    sample: true
'''

Name	Type	Size	Permission
__pycache__	Folder		0755
__init__.py	File	0 B	0644
async_status.ps1	File	1.81 KB	0644
async_status.yml	File	1.77 KB	0644
setup.ps1	File	49.89 KB	0644
setup.yml	File	2.35 KB	0644
slurp.ps1	File	728 B	0644
slurp.yml	File	1.5 KB	0644
win_acl.ps1	File	9.54 KB	0644
win_acl.py	File	4.14 KB	0644
win_acl_inheritance.ps1	File	4.72 KB	0644
win_acl_inheritance.py	File	2.34 KB	0644
win_certificate_store.ps1	File	19.78 KB	0644
win_certificate_store.py	File	8.08 KB	0644
win_command.ps1	File	3.98 KB	0644
win_command.py	File	6.13 KB	0644
win_copy.ps1	File	18.06 KB	0644
win_copy.py	File	6.55 KB	0644
win_dns_client.ps1	File	12.99 KB	0644
win_dns_client.py	File	2.13 KB	0644
win_domain.ps1	File	7.67 KB	0644
win_domain.py	File	4.15 KB	0644
win_domain_controller.ps1	File	12.37 KB	0644
win_domain_controller.py	File	5.66 KB	0644
win_domain_membership.ps1	File	10.36 KB	0644
win_domain_membership.py	File	3.35 KB	0644
win_dsc.ps1	File	19.46 KB	0644
win_dsc.py	File	7.31 KB	0644
win_environment.ps1	File	5.56 KB	0644
win_environment.py	File	4.13 KB	0644
win_feature.ps1	File	4.1 KB	0644
win_feature.py	File	4.63 KB	0644
win_file.ps1	File	5.4 KB	0644
win_file.py	File	2.16 KB	0644
win_find.ps1	File	14.29 KB	0644
win_find.py	File	11.19 KB	0644
win_get_url.ps1	File	11.59 KB	0644
win_get_url.py	File	5.82 KB	0644
win_group.ps1	File	1.64 KB	0644
win_group.py	File	1.1 KB	0644
win_group_membership.ps1	File	5.82 KB	0644
win_group_membership.py	File	2.95 KB	0644
win_hostname.ps1	File	1 KB	0644
win_hostname.py	File	1.07 KB	0644
win_optional_feature.ps1	File	2.84 KB	0644
win_optional_feature.py	File	2.32 KB	0644
win_owner.ps1	File	2.18 KB	0644
win_owner.py	File	1.05 KB	0644
win_package.ps1	File	51.85 KB	0644
win_package.py	File	15.68 KB	0644
win_path.ps1	File	6.17 KB	0644
win_path.py	File	2.94 KB	0644
win_ping.ps1	File	454 B	0644
win_ping.py	File	1.16 KB	0644
win_powershell.ps1	File	29.57 KB	0644
win_powershell.py	File	15.7 KB	0644
win_reboot.py	File	4.76 KB	0644
win_reg_stat.ps1	File	4.11 KB	0644
win_reg_stat.py	File	3.51 KB	0644
win_regedit.ps1	File	18.12 KB	0644
win_regedit.py	File	6.35 KB	0644
win_service.ps1	File	37.85 KB	0644
win_service.py	File	16.71 KB	0644
win_service_info.ps1	File	9.98 KB	0644
win_service_info.py	File	9.44 KB	0644
win_share.ps1	File	11.93 KB	0644
win_share.py	File	3.02 KB	0644
win_shell.ps1	File	4.93 KB	0644
win_shell.py	File	5.69 KB	0644
win_stat.ps1	File	7.24 KB	0644
win_stat.py	File	7.39 KB	0644
win_tempfile.ps1	File	2.46 KB	0644
win_tempfile.py	File	1.49 KB	0644
win_template.py	File	5.48 KB	0644
win_updates.ps1	File	57.42 KB	0644
win_updates.py	File	11.95 KB	0644
win_uri.ps1	File	7.95 KB	0644
win_uri.py	File	4.14 KB	0644
win_user.ps1	File	16.46 KB	0644
win_user.py	File	5.43 KB	0644
win_user_right.ps1	File	13.78 KB	0644
win_user_right.py	File	3.24 KB	0644
win_wait_for.ps1	File	9.56 KB	0644
win_wait_for.py	File	4.42 KB	0644
win_whoami.ps1	File	30.96 KB	0644
win_whoami.py	File	5.29 KB	0644

Upload:

Command:

Filemanager

Server Info

System Info