summaryrefslogtreecommitdiff
path: root/windows/win_regedit.py
diff options
context:
space:
mode:
authorAdam Keech <akeech@chathamfinancial.com>2015-07-06 15:25:01 -0400
committerAdam Keech <akeech@chathamfinancial.com>2015-07-06 16:22:55 -0400
commit389e59b9708d005c73ed84b5c1703a4c9a3d931a (patch)
tree6e1a1def1377f23e307609c8b48dda399d9fe385 /windows/win_regedit.py
parente84666fd7428012e29e013e792aa5574e6892c75 (diff)
downloadansible-modules-extras-389e59b9708d005c73ed84b5c1703a4c9a3d931a.tar.gz
Adding functionality to not only edit Values, but also Keys.
Diffstat (limited to 'windows/win_regedit.py')
-rw-r--r--windows/win_regedit.py61
1 files changed, 35 insertions, 26 deletions
diff --git a/windows/win_regedit.py b/windows/win_regedit.py
index d8fd3a7c..5087a5ea 100644
--- a/windows/win_regedit.py
+++ b/windows/win_regedit.py
@@ -25,11 +25,17 @@ DOCUMENTATION = '''
---
module: win_regedit
version_added: "2.0"
-short_description: Add, Edit, or Remove Registry Value
+short_description: Add, Edit, or Remove Registry Keys and Values
description:
- - Add, Edit, or Remove Registry Value using ItemProperties Cmdlets
+ - Add, Edit, or Remove Registry Keys and Values using ItemProperties Cmdlets
options:
- name:
+ key:
+ description:
+ - Name of Registry Key
+ required: true
+ default: null
+ aliases: []
+ value:
description:
- Name of Registry Value
required: true
@@ -41,7 +47,7 @@ options:
required: false
default: null
aliases: []
- type:
+ datatype:
description:
- Registry Value Data Type
required: false
@@ -54,12 +60,6 @@ options:
- qword
default: string
aliases: []
- path:
- description:
- - Path of Registry Value
- required: true
- default: null
- aliases: []
state:
description:
- State of Registry Value
@@ -73,28 +73,37 @@ author: "Adam Keech (@smadam813), Josh Ludwig (@joshludwig)"
'''
EXAMPLES = '''
- # Add Registry Value (Default is String)
+ # Creates Registry Key called MyCompany.
win_regedit:
- name: testvalue
- data: 1337
- path: HKCU:\Software\MyCompany
+ key: HKCU:\Software\MyCompany
+
+ # Creates Registry Key called MyCompany,
+ # a value within MyCompany Key called "hello", and
+ # data for the value "hello" containing "world".
+ win_regedit:
+ key: HKCU:\Software\MyCompany
+ value: hello
+ data: world
- # Add Registry Value with Type DWord
+ # Creates Registry Key called MyCompany,
+ # a value within MyCompany Key called "hello", and
+ # data for the value "hello" containing "1337" as type "dword".
win_regedit:
- name: testvalue
+ key: HKCU:\Software\MyCompany
+ value: hello
data: 1337
- type: dword
- path: HKCU:\Software\MyCompany
+ datatype: dword
- # Edit Registry Value called testvalue
+ # Delete Registry Key MyCompany
+ # NOTE: Not specifying a value will delete the root key which means
+ # all values will be deleted
win_regedit:
- name: testvalue
- data: 8008
- path: HKCU:\Software\MyCompany
-
- # Remove Registry Value called testvalue
+ key: HKCU:\Software\MyCompany
+ state: absent
+
+ # Delete Registry Value "hello" from MyCompany Key
win_regedit:
- name: testvalue
- path: HKCU:\Software\MyCompany
+ key: HKCU:\Software\MyCompany
+ value: hello
state: absent
'''