cookie alert

Nous utilisons des cookies afin de vous offrir une meilleure navigation, analyser les visites du site, personnaliser les contenus et mieux cibler nos publicités. Si vous poursuivez votre visite sur ce site, vous acceptez notre utilisation des cookies

Nexthink Library

Windows Registry

Back

Windows Registry

Latest Version: 3.0.3.0
|
Updated on February 28, 2024
Install

Description

This Library pack is composed of a Remote Action script which retrieves the value data of up to three Windows Registry properties.Please use the link on the left menu to learn more about the function and range of action of the script.

Versions

  • 3.0.3.0 - 28 Feb 2024 - Updated OS requirements
  • 3.0.2.0 - 22 Jul 2022 - Updated documentation for "Set Windows Registry Key" Remote Action
  • 3.0.1.0 - 20 May 2020 - Fixed "Get Windows Registry Key Values" Remote Action
  • 3.0.0.0 - 12 Mar 2020 - Added "Set Windows Registry Key" Remote Action
  • 2.0.0.0 - 18 Jul 2019 - Major redesign of the Remote Action
  • 1.0.0.1 - Corrected bug in the Get Windows Registry Key Values when retrieving registry key with specific abbreviation
  • 1.0.0.0 - Initial release

Required Products

Nexthink Act

Platforms

Windows 7 and newer

Compatibility

V6.14 and later

This Might Interest You

Workflow: Windows 11 migration
New

Orchestrate the Windows 11 migration process with automated compatibility checks and pre-to-post migration user engagement.

Released on April 11, 2024
View Library Pack

Workflow: Device assignment verification
New

Orchestrate the verification and update of device assignee information in the ServiceNow Hardware Asset Management database through a dedicated workflow.

Released on April 10, 2024
View Library Pack

Get Windows Registry Key Values

Script Description

Returns the value data of up to three Windows Registry properties.

Caveat!This Remote Action IS NOT able to return QWORD, and BINARY values.

Execution context and suggested scheduling

Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Registry Key1 Registry key path in the format specified in this remote action documentation
Value Name1 Name of the registry value whose data will be retrieved
Registry Key2 Registry key path in the format specified in this remote action documentation
Value Name2 Name of the registry value whose data will be retrieved
Registry Key3 Registry key path in the format specified in this remote action documentation
Value Name3 Name of the registry value whose data will be retrieved

Outputs

Label Type Description
Value Data1 String Data associated to the corresponding value name indicated in the parameters
Value Data2 String Data associated to the corresponding value name indicated in the parameters
Value Data3 String Data associated to the corresponding value name indicated in the parameters

Further Information

Root of registry keys should be provided as one of the following options:
* Fully-qualified name (Registry::\HKEY_LOCAL_MACHINE\...).
* Full name (HKEY_LOCAL_MACHINE:.....).
* Abbreviations (HKLM, HKCU, HKU).
There are two paths that are currently blacklisted and no properties can be obtained:
* Registry::HKEY_LOCAL_MACHINE\SAM\* .
* Registry::HKEY_LOCAL_MACHINE\Security\* .

Test Scenarios

PathMultipleFormats
Test Case Multiple registry keys were provided with different abbreviations
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputted the values of the registry key properties correctly
PathIsBlacklisted
Test Case Checked if values were retrieved from blacklisted paths
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputted the empty values as expected ("-")
RegKeyPathCouldNotBeRead
Test Case The path provided for any of the "RegistryKey" input parameters cannot be accessed by current interactive user
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputted the empty values as expected ("-")

Set Windows Registry Key Value

Script Description

Modifies or creates a String, Binary, DWORD or QWORD value on the Windows Registry.

Execution context and suggested scheduling

Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Registry Key Full registry key path. Root of registry keys should be provided as a fully-qualified name (Registry::HKEY_LOCAL_MACHINE\...), the full name (HKEY_LOCAL_MACHINE) or an abbreviation (HKLM, HKCU, HKU)
Value Name Full name of the Registry Key value
Value Value to be set. If ValueType is Binary, it should be a positive hexadecimal value with even digits. Eg. 'A4789F', 'A4 78 9F'. If ValueType is a DWORD, the value should be a positive 32-bit number. It can be decimal or hexadecimal if it is preceded by '0x'. Eg. '345', '0xA76D9E'. If ValueType is a QWORD, the value should be a positive 64-bit number. It can be decimal or hexadecimal if it is preceded by '0x'. Eg. '345981694', '0xA76D9EF78'
Value Type Type of the Registry Key value to be created or modified. Accepted values are String, Binary, DWORD or QWORD

Outputs

None.

Restrictions

Further Information

To know more about the registry and its values take a look at the official documentation.

Test Scenarios

StringValue
Test Case ValueType is set as String and Value is a test text.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.
BinaryValue
Test Case ValueType is set as Binary and Value is a positive hexadecimal value with a even number of digits.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.
DWORDHexValue
Test Case ValueType is set as DWORD and Value is a positive 32-bit hexadecimal value preceded by '0x'.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.
DWORDDecimalValue
Test Case ValueType is set as DWORD and Value is a positive 32-bit decimal value.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.
QWORDHexValue
Test Case ValueType is set as QWORD and Value is a positive 64-bit hexadecimal value preceded by '0x'.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.
QWORDDecimalValue
Test Case ValueType is set as QWORD and Value is a positive 64-bit decimal value.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Successful execution. The key value is created or modified if it already existed.