functions/Get-DbaSqlProductKey.ps1
|
function Get-DbaSqlProductKey { <# .SYNOPSIS Gets SQL Server Product Keys from local or destination SQL Servers. Works with SQL Server 2005-2016 .DESCRIPTION Using a string of servers, a text file, or Central Management Server to provide a list of servers, this script will go to each server and get the product key for all installed instances. Clustered instances are supported as well. Requires regular user access to the SQL instances, SMO installed locally, Remote Registry enabled and accessible by the account running the script. Uses key decoder by Jakob Bindslet (http://goo.gl/1jiwcB) .PARAMETER SqlInstance A comma separated list of servers. This can be the NetBIOS name, IP, or SQL instance name .PARAMETER SqlCms Compiles list of servers to inventory using all servers stored within a Central Management Server. Requires having SQL Management Studio installed. .PARAMETER ServersFromFile Uses a text file as input. The file must be formatted as such: sqlserver1 sqlserver2 .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .NOTES Author: Chrissy LeMaire (@cl), netnerds.net Tags: SQL, Product Key Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaSqlProductKey .EXAMPLE Get-DbaSqlProductKey -SqlInstance winxp, sqlservera, sqlserver2014a, win2k8 Gets SQL Server versions, editions and product keys for all instances within each server or workstation. #> [CmdletBinding(DefaultParameterSetName = "Default")] Param ( [parameter(Position = 0)] [Alias("ServerInstance", "SqlServer")] [string[]]$SqlInstance = $env:computername, [PSCredential]$SqlCredential, [switch]$EnablException ) begin { Function Unlock-SqlInstanceKey { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [byte[]]$data, [int]$version ) try { if ($version -ge 11) { $binArray = ($data)[0..66] } else { $binArray = ($data)[52..66] } $charsArray = "B", "C", "D", "F", "G", "H", "J", "K", "M", "P", "Q", "R", "T", "V", "W", "X", "Y", "2", "3", "4", "6", "7", "8", "9" for ($i = 24; $i -ge 0; $i--) { $k = 0 for ($j = 14; $j -ge 0; $j--) { $k = $k * 256 -bxor $binArray[$j] $binArray[$j] = [math]::truncate($k / 24) $k = $k % 24 } $productKey = $charsArray[$k] + $productKey if (($i % 5 -eq 0) -and ($i -ne 0)) { $productKey = "-" + $productKey } } } catch { $productkey = "Cannot decode product key." } return $productKey } } process { $basepath = "SOFTWARE\Microsoft\Microsoft SQL Server" foreach ($servername in $SqlInstance) { $servername = $servername.Split("\")[0] if ($servername -eq "." -or $servername -eq "localhost" -or $servername -eq $env:computername) { $localmachine = [Microsoft.Win32.RegistryHive]::LocalMachine $defaultview = [Microsoft.Win32.RegistryView]::Default $reg = [Microsoft.Win32.RegistryKey]::OpenBaseKey($localmachine, $defaultview) } else { # Get IP for remote registry access. It's the most reliable. try { ($ipaddr = Resolve-DbaNetworkName -ComputerName $servername -Turbo).IPAddress } catch { Write-Warning "Can't resolve $servername. Skipping."; continue } try { $reg = [Microsoft.Win32.RegistryKey]::OpenRemoteBaseKey("LocalMachine", $ipaddr) } catch { Write-Warning "Can't access registry for $servername. Is the Remote Registry service started?"; continue } } $instances = $reg.OpenSubKey("$basepath\Instance Names\SQL", $false) if ($instances -eq $null) { Write-Warning "No instances found on $servername. Skipping."; continue } # Get Product Keys for all instances on the server. foreach ($instancename in $instances.GetValueNames()) { if ($instancename -eq "MSSQLSERVER") { $instance = $servername } else { $instance = "$servername\$instancename" } $subkeys = $reg.OpenSubKey("$basepath", $false) $instancekey = $subkeys.GetSubKeynames() | Where-Object { $_ -like "*.$instancename" } if ($null -eq $instancekey) { $instancekey = $instancename } # SQL 2k5 # Cluster instance hostnames are required for SMO connection $cluster = $reg.OpenSubKey("$basepath\$instancekey\Cluster", $false) if ($cluster -ne $null) { $clustername = $cluster.GetValue("ClusterName") if ($instancename -eq "MSSQLSERVER") { $instance = $clustername } else { $instance = "$clustername\$instancename" } } Write-Verbose "Attempting to connect to $instance" try { $server = Connect-SqlInstance -SqlInstance $SqlInstance -SqlCredential $SqlCredential } catch { Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $SqlInstance -Continue } $servicePack = $server.ProductLevel Write-Debug "$servername $instancename version is $($server.VersionMajor)" switch ($server.VersionMajor) { 9 { $sqlversion = "SQL Server 2005 $servicePack" $findkeys = $reg.OpenSubKey("$basepath\90\ProductID", $false) foreach ($findkey in $findkeys.GetValueNames()) { if ($findkey -like "DigitalProductID*") { $key = "$basepath\90\ProductID\$findkey" } } } 10 { $sqlversion = "SQL Server 2008 $servicePack" $key = "$basepath\MSSQL10" if ($server.VersionMinor -eq 50) { $key += "_50"; $sqlversion = "SQL Server 2008 R2 $servicePack" } $key += ".$instancename\Setup\DigitalProductID" } 11 { $key = "$basepath\110\Tools\Setup\DigitalProductID"; $sqlversion = "SQL Server 2012 $servicePack" } 12 { $key = "$basepath\120\Tools\Setup\DigitalProductID"; $sqlversion = "SQL Server 2014 $servicePack" } 13 { $key = "$basepath\130\Tools\Setup\DigitalProductID"; $sqlversion = "SQL Server 2016 $servicePack" } 14 { $key = "$basepath\140\Tools\Setup\DigitalProductID"; $sqlversion = "SQL Server 2017 $servicePack" } default { Write-Warning "SQL version not currently supported."; continue } } if ($server.Edition -notlike "*Express*") { try { $subkey = Split-Path $key; $binaryvalue = Split-Path $key -leaf $binarykey = $($reg.OpenSubKey($subkey)).GetValue($binaryvalue) } catch { $sqlkey = "Could not connect." } try { $sqlkey = Unlock-SqlInstanceKey $binarykey $server.VersionMajor } catch { } } else { $sqlkey = "SQL Server Express Edition" } $server.ConnectionContext.Disconnect() $object = [pscustomobject]@{ "SQL Instance" = $instance "SQL Version" = $sqlversion "SQL Edition" = $server.Edition "Product Key" = $sqlkey } } $reg.Close() } } end { Test-DbaDeprecation -DeprecatedOn "1.0.0" -EnableException:$false -Alias Get-SqlServerKey } } |