Chapters/comment-based-help/snippets.ps1
|
Return "This is a snippets file not a script to run." # completed... Function Get-TMComputerStatus { <# .SYNOPSIS Get computer status information. .DESCRIPTION This command retrieves system information from one or more remote computers using Get-CimInstance. It will write a summary object to the pipeline for each computer. You also have the option to log errors to a text file. .PARAMETER Computername The name of the computer to query. .PARAMETER ErrorLog The path to the error text file. This is not implemented yet. .PARAMETER ErrorAppend Append errors to the error file. This is not implemented yet. .EXAMPLE PS C:\> Get-TMComputerstatus -computername SRV1 #> [cmdletbinding()] Param( [Parameter(ValueFromPipeline, Mandatory)] [ValidateNotNullorEmpty()] [ValidatePattern("^\w+$")] [Alias("CN", "Machine", "Name")] [string[]]$Computername, [string]$ErrorLog, [switch]$ErrorAppend ) BEGIN { Write-Information "Command = $($myinvocation.mycommand)" -Tags Meta Write-Information "PSVersion = $($PSVersionTable.PSVersion)" -Tags Meta Write-Information "User = $env:userdomain\$env:username" -tags Meta Write-Information "Computer = $env:computername" -tags Meta Write-Information "PSHost = $($host.name)" -Tags Meta Write-Information "Test Date = $(Get-Date)" -tags Meta Write-Verbose "Starting $($myinvocation.mycommand)" } PROCESS { foreach ($computer in $Computername) { Write-Verbose "Querying $($computer.toUpper())" $params = @{ Classname = "Win32_OperatingSystem" Computername = $computer } $OS = Get-CimInstance @params $params.ClassName = "Win32_Processor" $cpu = Get-CimInstance @params $params.className = "Win32_logicalDisk" $vol = Get-CimInstance @params -filter "DeviceID='c:'" [pscustomobject]@{ Computername = $os.CSName TotalMem = $os.TotalVisibleMemorySize FreeMem = $os.FreePhysicalMemory Processes = $os.NumberOfProcesses PctFreeMem = ($os.FreePhysicalMemory/$os.TotalVisibleMemorySize)*100 Uptime = (Get-Date) - $os.lastBootUpTime CPULoad = $cpu.LoadPercentage PctFreeC = ($vol.FreeSpace/$vol.size)*100 } } #foreach $computer } END { Write-Verbose "Starting $($myinvocation.mycommand)" } } #Get-TMComputerStatus # prettier version <# .SYNOPSIS Get computer status information. .DESCRIPTION This command retrieves system information from one or more remote computers using Get-CimInstance. It will write a summary object to the pipeline for each computer. You also have the option to log errors to a text file. .PARAMETER Computername The name of the computer to query. This parameter has aliases of CN, Machine and Name. .PARAMETER ErrorLog The path to the error text file. This is not implemented yet. .PARAMETER ErrorAppend Append errors to the error file. This is not implemented yet. .EXAMPLE PS C:\> Get-TMComputerStatus -computername SRV1 Computername : SRV1 TotalMem : 33080040 FreeMem : 27384236 Processes : 218 PctFreeMem : 82.7817499616083 Uptime : 11.06:23:52.7176115 CPULoad : 2 PctFreeC : 54.8730920184876 Get the status of a single computer .EXAMPLE PS C:\> Get-Content c:\work\computers.txt | Get-TMComputerStatus | Export-CliXML c:\work\data.xml Pipe each computer name from the computers.txt text file to this command. Results are immediately exported to an XML file using Export-CliXML. #> # more sections... <# .INPUTS System.String .NOTES version : 1.0.0 last updated: 1 June, 2020 .LINK https://powershell.org/forums/ .LINK Get-CimInstance #> |