scripts/collector/sqlserver/dmaSQLServerHWSpecs.ps1

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
<#
.SYNOPSIS
    .
.DESCRIPTION
    Collects HW Specs using Get-WmiObject to be uploaded to Google Database Migration Assistant for MS SQL Server.
.PARAMETER computerName
    The target computer name to collect the HW specs from (Optional).
.PARAMETER outputPath
    The output full path of the csv that this scripts creates (Required).
.PARAMETER pkey
    Final Output Directory (Required).
.PARAMETER dmaSourceId
    DMA derived unique id (Required).
.PARAMETER dmaManualId
    Customer Manual Unique ID or dma manual unique id (Optional).
.PARAMETER logLocation
    Location of log file to output the script (Optional).
.PARAMETER requestCreds
	Whether to request credentials if connecting via WMI using the current user fails.
.EXAMPLE
    C:\dmaSQLServerHWSpecs.ps1 -computerName localhost -outputPath a.out -pkey pkey1 -dmaSourceId src1
.NOTES
    https://googlecloudplatform.github.io/database-assessment/
#>
param (
	[Parameter(
		Mandatory = $False,
		HelpMessage = "The computer name"
	)][string]$computerName = $env:COMPUTERNAME,
	[Parameter(
		Mandatory = $True,
		HelpMessage = "The Output path"
	)][string]$outputPath,
	[Parameter(
		Mandatory = $True,
		HelpMessage = "The pkey value"
	)][string]$pkey,
	[Parameter(
		Mandatory = $True,
		HelpMessage = "The dma_source_id"
	)][string]$dmaSourceId,
	[Parameter(
		Mandatory = $False,
		HelpMessage = "The dma_manual_id"
	)][string]$dmaManualId = "NA",
	[Parameter(
		Mandatory = $False,
		HelpMessage = "The log file location"
	)][string]$logLocation = "dmaSqlServerHWSpecs.log",
	[Parameter(
		Mandatory = $False,
		HelpMessage = "Request credentials if connecting via WMI without credentials fails"
	)][switch]$requestCreds
)

$ErrorActionPreference = 'Stop'

Import-Module $PSScriptRoot\dmaCollectorCommonFunctions.psm1

$params = @{
	ComputerName = $computerName
}
if ($requestCreds) {
	try {
		Get-WmiObject Win32_Processor -ComputerName $computerName > $null
	}
	catch {
		if ($_.Exception.GetType().FullName -eq "System.UnauthorizedAccessException") {
			$params.Credential = $host.ui.PromptForCredential(
				"Credentials for $computerName",
				"Please provide Windows credentials (not SQL Server credentials) for ${computerName}:",
				"",
				"")
		}
	}
}

# CSV data.
$csvData = [PSCustomObject]@{
	"pkey"               = $pkey
	"dma_source_id"      = $dmaSourceId
	"dma_manual_id"      = $dmaManualId
	"MachineName"        = $computerName
	"PhysicalCpuCount"   = $null
	"LogicalCpuCount"    = $null
	"TotalOSMemoryBytes" = $null
	"TotalOSMemoryMB"    = $null
	"PrimaryMAC"         = $null
	"IPAddresses"        = $null
}

try {
	WriteLog -logLocation $logLocation -logMessage "Fetching machine HW specs from computer:$computerName and storing it in output:$outputPath" -logOperation "FILE"

	# Physical cores count.
	$csvData.PhysicalCpuCount = (Get-WmiObject Win32_Processor @params | Measure-Object -Property NumberOfCores -Sum).Sum

	# Logical cores count.
	$csvData.LogicalCpuCount = (Get-WmiObject Win32_Processor @params | Measure-Object -Property NumberOfLogicalProcessors -Sum).Sum

	# Total memory in bytes.
	$csvData.TotalOSMemoryBytes = (Get-WmiObject Win32_PhysicalMemory @params | Measure-Object -Property Capacity -Sum).Sum

	# Total memory in MB.
	$csvData.TotalOSMemoryMB = [Math]::Floor([decimal]($csvData.TotalOSMemoryBytes / 1048576))

	# Primary MAC Address
	$csvData.PrimaryMAC = (Get-WmiObject Win32_NetworkAdapter @params | Where-Object {$_.PhysicalAdapter -eq $true} | Sort-Object -Property Index | Select-Object -First 1).MACAddress

	# Comma seperated IP addresses
	$csvData.IPAddresses = (Get-WmiObject Win32_NetworkAdapterConfiguration @params | Where-Object {$_.IPEnabled -eq $true}  | Select-Object -ExpandProperty IPAddress) -join ','

	# Writing to csv.
	$csvData | Export-Csv -Path $outputPath -Delimiter "|" -NoTypeInformation -Encoding UTF8
	WriteLog -logLocation $logLocation -logMessage "Successfully fetched machine HW specs of $computerName to output:$outputPath" -logOperation "FILE"
}
catch {
	WriteLog -logLocation $logLocation -logMessage "ERROR - Failed fetching machine HW specs of ${computerName}: $_" -logOperation "BOTH"
	# Write at least MachineName to CSV.
	$csvData | Export-Csv -Path $outputPath -Delimiter "|" -NoTypeInformation -Encoding UTF8
}