TestimoX

API Reference

Command

Get-CxRegistryKey

Namespace ComputerX.PowerShell
Outputs
ComputerX.Registry.RegistryReader+KeyDump

Returns a registry key snapshot from the local or a remote computer.

Examples

Authored help example

Example 1: Reads a local application registry key.

PS>


Get-CxRegistryKey -Path 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion'
        

Example 2: Reads a remote policy key from a server.

PS>


Get-CxRegistryKey -ComputerName APP01 -Path 'HKLM\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate'
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-CxRegistryKey -Path <string> [-ComputerName <string>] [<CommonParameters>]
#

Parameters

Path string requiredposition: 0pipeline: false
Registry key path to read, for example HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion.
ComputerName string optionalposition: 1pipeline: false
Target computer name. Use . for the local machine or provide a DNS/NetBIOS name. When omitted, the local computer is queried.

Outputs

ComputerX.Registry.RegistryReader+KeyDump