Merge pull request #1166 from jhawkesworth/2nd_go_at_win_regmerge
New module: win_regmerge for handling multiple changes to windows registry
This commit is contained in:
Matt Davis
commit
6b607551ba
2 changed files with 160 additions and 0 deletions
90
windows/win_regmerge.ps1
Normal file
90
windows/win_regmerge.ps1
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
#!powershell
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Copyright 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
Function Convert-RegistryPath {
|
||||
Param (
|
||||
[parameter(Mandatory=$True)]
|
||||
[ValidateNotNullOrEmpty()]$Path
|
||||
)
|
||||
|
||||
$output = $Path -replace "HKLM:", "HKLM"
|
||||
$output = $output -replace "HKCU:", "HKCU"
|
||||
|
||||
Return $output
|
||||
}
|
||||
|
||||
$params = Parse-Args $args
|
||||
$result = New-Object PSObject
|
||||
Set-Attr $result "changed" $False
|
||||
|
||||
$path = Get-Attr -obj $params -name path -failifempty $True -resultobj $result
|
||||
$compare_to = Get-Attr -obj $params -name compare_to -failifempty $False -resultobj $result
|
||||
|
||||
# check it looks like a reg key, warn if key not present - will happen first time
|
||||
# only accepting PS-Drive style key names (starting with HKLM etc, not HKEY_LOCAL_MACHINE etc)
|
||||
|
||||
$do_comparison = $False
|
||||
|
||||
If ($compare_to) {
|
||||
$compare_to_key = $params.compare_to.ToString()
|
||||
If (Test-Path $compare_to_key -pathType container ) {
|
||||
$do_comparison = $True
|
||||
} Else {
|
||||
Set-Attr $result "compare_to_key_found" $False
|
||||
}
|
||||
}
|
||||
|
||||
If ( $do_comparison -eq $True ) {
|
||||
$guid = [guid]::NewGuid()
|
||||
$exported_path = $env:TEMP + "\" + $guid.ToString() + 'ansible_win_regmerge.reg'
|
||||
|
||||
$expanded_compare_key = Convert-RegistryPath ($compare_to_key)
|
||||
|
||||
# export from the reg key location to a file
|
||||
$reg_args = @("EXPORT", "$expanded_compare_key", $exported_path)
|
||||
& reg.exe $reg_args
|
||||
|
||||
# compare the two files
|
||||
$comparison_result = Compare-Object -ReferenceObject $(Get-Content $path) -DifferenceObject $(Get-Content $exported_path)
|
||||
|
||||
If (Get-Member -InputObject $comparison_result -Name "count" -MemberType Properties )
|
||||
{
|
||||
# Something is different, actually do reg merge
|
||||
$reg_import_args = @("IMPORT", "$path")
|
||||
& reg.exe $reg_import_args
|
||||
Set-Attr $result "changed" $True
|
||||
Set-Attr $result "difference_count" $comparison_result.count
|
||||
} Else {
|
||||
Set-Attr $result "difference_count" 0
|
||||
}
|
||||
|
||||
Remove-Item $exported_path
|
||||
Set-Attr $result "compared" $True
|
||||
|
||||
} Else {
|
||||
# not comparing, merge and report changed
|
||||
$reg_import_args = @("IMPORT", "$path")
|
||||
& reg.exe $reg_import_args
|
||||
Set-Attr $result "changed" $True
|
||||
Set-Attr $result "compared" $False
|
||||
}
|
||||
|
||||
Exit-Json $result
|
||||
70
windows/win_regmerge.py
Normal file
70
windows/win_regmerge.py
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# this is a windows documentation stub. actual code lives in the .ps1
|
||||
# file of the same name
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: win_regmerge
|
||||
version_added: "2.0"
|
||||
short_description: Merges the contents of a registry file into the windows registry
|
||||
description:
|
||||
- Wraps the reg.exe command to import the contents of a registry file.
|
||||
- Suitable for use with registry files created using M(win_template).
|
||||
- Windows registry files have a specific format and must be constructed correctly with carriage return and line feed line endings otherwise they will not be merged.
|
||||
- Exported registry files often start with a Byte Order Mark which must be removed if the file is to templated using M(win_template).
|
||||
- Registry file format is described here: https://support.microsoft.com/en-us/kb/310516
|
||||
- See also M(win_template), M(win_regedit)
|
||||
options:
|
||||
path:
|
||||
description:
|
||||
- The full path including file name to the registry file on the remote machine to be merged
|
||||
required: true
|
||||
default: no default
|
||||
compare_key:
|
||||
description:
|
||||
- The parent key to use when comparing the contents of the registry to the contents of the file. Needs to be in HKLM or HKCU part of registry. Use a PS-Drive style path for example HKLM:\SOFTWARE not HKEY_LOCAL_MACHINE\SOFTWARE
|
||||
If not supplied, or the registry key is not found, no comparison will be made, and the module will report changed.
|
||||
required: false
|
||||
default: no default
|
||||
author: "Jon Hawkesworth (@jhawkesworth)"
|
||||
notes:
|
||||
- Organise your registry files so that they contain a single root registry
|
||||
key if you want to use the compare_to functionality.
|
||||
This module does not force registry settings to be in the state
|
||||
described in the file. If registry settings have been modified externally
|
||||
the module will merge the contents of the file but continue to report
|
||||
differences on subsequent runs.
|
||||
To force registry change, use M(win_regedit) with state=absent before
|
||||
using M(win_regmerge).
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Merge in a registry file without comparing to current registry
|
||||
# Note that paths using / to separate are preferred as they require less special handling than \
|
||||
win_regmerge:
|
||||
path: C:/autodeploy/myCompany-settings.reg
|
||||
# Compare and merge registry file
|
||||
win_regmerge:
|
||||
path: C:/autodeploy/myCompany-settings.reg
|
||||
compare_to: HKLM:\SOFTWARE\myCompany
|
||||
'''
|
||||
|
||||
Loading…
Reference in a new issue