mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
win_reg_stat change the module parameters for standardisation (#22732)
This commit is contained in:
Jordan Borean
Matt Davis
parent
89b78cb5e8
commit
f1ab879bb6
3 changed files with 175 additions and 189 deletions
|
|
@ -19,14 +19,13 @@
|
|||
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
$params = Parse-Args $args -supports_check_mode $true
|
||||
$params = Parse-Args -arguments $args -supports_check_mode $true
|
||||
|
||||
$key = Get-AnsibleParam -obj $params -name "key" -type "str" -failifempty $true
|
||||
$property = Get-AnsibleParam -obj $params -name "property" -type "str"
|
||||
$path = Get-AnsibleParam -obj $params -name "path" -type "str" -failifempty $true -aliases "key"
|
||||
$name = Get-AnsibleParam -obj $params -name "name" -type "str" -aliases "entry","value"
|
||||
|
||||
$result = @{
|
||||
changed = $false
|
||||
win_reg_stat = @{}
|
||||
}
|
||||
|
||||
Function Get-NetHiveName($hive) {
|
||||
|
|
@ -94,57 +93,57 @@ Function Test-RegistryProperty($hive, $path, $property) {
|
|||
}
|
||||
|
||||
# Will validate the key parameter to make sure it matches known format
|
||||
if ($key -match "^([a-zA-Z_]*):\\(.*)$") {
|
||||
if ($path -match "^([a-zA-Z_]*):\\(.*)$") {
|
||||
$hive = $matches[1]
|
||||
$path = $matches[2]
|
||||
$reg_path = $matches[2]
|
||||
} else {
|
||||
Fail-Json $result "key does not match format 'HIVE:\KEY_PATH'"
|
||||
Fail-Json $result "path does not match format 'HIVE:\KEY_PATH'"
|
||||
}
|
||||
|
||||
# Used when getting the actual REG_EXPAND_SZ value as well as checking the hive is a known value
|
||||
$net_hive = Get-NetHiveName -hive $hive
|
||||
if ($net_hive -eq 'unsupported') {
|
||||
Fail-Json $result "the hive in key is '$hive'; must be 'HKCR', 'HKCC', 'HKCU', 'HKLM' or 'HKU'"
|
||||
Fail-Json $result "the hive in path is '$hive'; must be 'HKCR', 'HKCC', 'HKCU', 'HKLM' or 'HKU'"
|
||||
}
|
||||
|
||||
if (Test-Path REGISTRY::$hive\$path) {
|
||||
if ($property -eq $null) {
|
||||
if (Test-Path REGISTRY::$hive\$reg_path) {
|
||||
if ($name -eq $null) {
|
||||
$property_info = @{}
|
||||
$properties = Get-ItemProperty REGISTRY::$hive\$path
|
||||
$properties = Get-ItemProperty REGISTRY::$hive\$reg_path
|
||||
|
||||
foreach ($property in $properties.PSObject.Properties) {
|
||||
# Powershell adds in some metadata we need to filter out
|
||||
$real_property = Test-RegistryProperty -hive $hive -path $path -property $property.Name
|
||||
$real_property = Test-RegistryProperty -hive $hive -path $reg_path -property $property.Name
|
||||
if ($real_property -eq $true) {
|
||||
$property_object = Get-PropertyObject -hive $hive -net_hive $net_hive -path $path -property $property.Name
|
||||
$property_object = Get-PropertyObject -hive $hive -net_hive $net_hive -path $reg_path -property $property.Name
|
||||
$property_info.Add($property.Name, $property_object)
|
||||
}
|
||||
}
|
||||
|
||||
$sub_keys = @()
|
||||
$sub_keys_raw = Get-ChildItem REGISTRY::$hive\$path -ErrorAction SilentlyContinue
|
||||
$sub_keys_raw = Get-ChildItem REGISTRY::$hive\$reg_path -ErrorAction SilentlyContinue
|
||||
|
||||
foreach ($sub_key in $sub_keys_raw) {
|
||||
$sub_keys += $sub_key.PSChildName
|
||||
}
|
||||
|
||||
$result.win_reg_stat.exists = $true
|
||||
$result.win_reg_stat.sub_keys = $sub_keys
|
||||
$result.win_reg_stat.properties = $property_info
|
||||
$result.exists = $true
|
||||
$result.sub_keys = $sub_keys
|
||||
$result.properties = $property_info
|
||||
} else {
|
||||
$exists = Test-RegistryProperty -hive $hive -path $path -property $property
|
||||
$exists = Test-RegistryProperty -hive $hive -path $reg_path -property $name
|
||||
if ($exists -eq $true) {
|
||||
$propertyObject = Get-PropertyObject -hive $hive -net_hive $net_hive -path $path -property $property
|
||||
$result.win_reg_stat.exists = $true
|
||||
$result.win_reg_stat.raw_value = $propertyObject.raw_value
|
||||
$result.win_reg_stat.value = $propertyObject.value
|
||||
$result.win_reg_stat.type = $propertyObject.type
|
||||
$propertyObject = Get-PropertyObject -hive $hive -net_hive $net_hive -path $reg_path -property $name
|
||||
$result.exists = $true
|
||||
$result.raw_value = $propertyObject.raw_value
|
||||
$result.value = $propertyObject.value
|
||||
$result.type = $propertyObject.type
|
||||
} else {
|
||||
$result.win_reg_stat.exists = $false
|
||||
$result.exists = $false
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$result.win_reg_stat.exists = $false
|
||||
$result.exists = $false
|
||||
}
|
||||
|
||||
Exit-Json $result
|
||||
|
|
|
|||
|
|
@ -36,86 +36,81 @@ description:
|
|||
- It also returns the sub keys and properties of the key specified.
|
||||
- If specifying a property name through I(property), it will return the information specific for that property.
|
||||
options:
|
||||
key:
|
||||
description:
|
||||
- The full registry key path including the hive to search for.
|
||||
required: true
|
||||
property:
|
||||
description:
|
||||
- The registry property name to get information for, the return json will not include the sub_keys and properties entries for the I(key) specified.
|
||||
required: false
|
||||
|
||||
path:
|
||||
description: The full registry key path including the hive to search for.
|
||||
required: true
|
||||
aliases: [ key ]
|
||||
name:
|
||||
description:
|
||||
- The registry property name to get information for, the return json will not include the sub_keys and properties entries for the I(key) specified.
|
||||
required: false
|
||||
aliases: [ entry, value, property ]
|
||||
author: "Jordan Borean (@jborean93)"
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
# Obtain information about a registry key using short form
|
||||
- win_reg_stat:
|
||||
key: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
|
||||
path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
|
||||
register: current_version
|
||||
|
||||
# Obtain information about a registry key property
|
||||
- win_reg_stat:
|
||||
key: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
|
||||
property: CommonFilesDir
|
||||
path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
|
||||
name: CommonFilesDir
|
||||
register: common_files_dir
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
changed:
|
||||
description: Whether anything was changed.
|
||||
returned: always
|
||||
type: boolean
|
||||
sample: True
|
||||
win_reg_stat:
|
||||
description: Information about the registry key or property specified.
|
||||
returned: success
|
||||
type: dictionary
|
||||
contains:
|
||||
exists:
|
||||
description: States whether the registry key/property exists.
|
||||
returned: success and path/property exists
|
||||
type: boolean
|
||||
sample: True
|
||||
properties:
|
||||
description: A list of all the properties and their values in the key.
|
||||
returned: success, path exists and property not specified
|
||||
type: list
|
||||
sample: [
|
||||
"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"]
|
||||
}
|
||||
]
|
||||
sub_keys:
|
||||
description: A list of all the sub keys of the key specified.
|
||||
returned: success, path exists and property not specified
|
||||
type: list
|
||||
sample: [
|
||||
"AppHost",
|
||||
"Casting",
|
||||
"DateTime"
|
||||
]
|
||||
raw_value:
|
||||
description: Returns the raw value of the registry property, REG_EXPAND_SZ has no string expansion, REG_BINARY or REG_NONE is in hex 0x format.
|
||||
REG_NONE, this value is a hex string in the 0x format.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: '%ProgramDir%\\Common Files'
|
||||
type:
|
||||
description: The property type.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: "REG_EXPAND_SZ"
|
||||
value:
|
||||
description: The value of the property.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: 'C:\\Program Files\\Common Files'
|
||||
description: Whether anything was changed.
|
||||
returned: always
|
||||
type: boolean
|
||||
sample: True
|
||||
exists:
|
||||
description: States whether the registry key/property exists.
|
||||
returned: success and path/property exists
|
||||
type: boolean
|
||||
sample: True
|
||||
properties:
|
||||
description: A list of all the properties and their values in the key.
|
||||
returned: success, path exists and property not specified
|
||||
type: list
|
||||
sample: [
|
||||
"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"]
|
||||
}
|
||||
]
|
||||
sub_keys:
|
||||
description: A list of all the sub keys of the key specified.
|
||||
returned: success, path exists and property not specified
|
||||
type: list
|
||||
sample: [
|
||||
"AppHost",
|
||||
"Casting",
|
||||
"DateTime"
|
||||
]
|
||||
raw_value:
|
||||
description: Returns the raw value of the registry property, REG_EXPAND_SZ has no string expansion, REG_BINARY or REG_NONE is in hex 0x format.
|
||||
REG_NONE, this value is a hex string in the 0x format.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: '%ProgramDir%\\Common Files'
|
||||
type:
|
||||
description: The property type.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: "REG_EXPAND_SZ"
|
||||
value:
|
||||
description: The value of the property.
|
||||
returned: success, path/property exists and property specified
|
||||
type: string
|
||||
sample: 'C:\\Program Files\\Common Files'
|
||||
'''
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue