Function Reference¶

Complete API reference for SystemChecks functions.

Available Functions¶

SystemChecks provides the following functions for building health checks:

Get-SystemHealth - Orchestrates comprehensive health checks using JSON configuration files
Test-ProcessHealth - Check if a process is running and responding
Test-ServiceHealth - Verify the status of Windows services
Test-FileExists - Check if a file path exists
Test-ShareExists - Verify if a network share path is accessible
Test-ScheduledTask - Get the status of scheduled tasks
Test-URIHealth - Check the health of web endpoints
Test-TimeSync - Compare time synchronization between systems
Get-FileCount - Get a count of files in a directory
Get-Win32Error - Look up detailed Windows error information

Run comprehensive health checks using a JSON configuration file.

Syntax:

Get-SystemHealth -ConfigFileName <String[]>

Example:

Get-SystemHealth -ConfigFileName ".\config_files\system1.json", ".\config_files\system2.json"

Check if a process is running and responding.

Syntax:

Test-ProcessHealth -ProcessName <String> [-SystemName <String>] [-SystemDescription <String>]

Example:

Test-ProcessHealth -ProcessName "explorer"

Verify the status of a Windows service.

Syntax:

Test-ServiceHealth -ServiceName <String> [-SystemName <String>] [-SystemDescription <String>]

Example:

Test-ServiceHealth -ServiceName 'w3svc'

Check if a file path exists.

Syntax:

Test-FileExists -FilePath <String> [-SystemName <String>] [-SystemDescription <String>]

Example:

Test-FileExists -FilePath "c:\my\file"

Verify if a network share path is accessible.

Syntax:

Test-ShareExists -SharePath <String> [-SystemName <String>] [-SystemDescription <String>]

Example:

Test-ShareExists -SharePath "\\server\e$"

Get the status of a scheduled task.

Syntax:

Test-ScheduledTask -TaskPath <String> [-SystemName <String>] [-SystemDescription <String>]

Example:

Test-ScheduledTask -TaskPath "\Tasks\Send Email"

Check the health of a web endpoint.

Syntax:

Test-URIHealth -URI <String> [-SystemName <String>] [-SystemDescription <String>] [-UseBasicParsing <Boolean>] [-UseDefaultCredentials <Boolean>]

Example:

Test-URIHealth -URI "http://server/health"

Compare time synchronization between two systems.

Syntax:

Test-TimeSync -System1Name <String> -System2Name <String>

Example:

Test-TimeSync -System1Name "server1" -System2Name "server2" -Verbose

Get a count of files in a directory.

Syntax:

Get-FileCount -FilePath <String> [-SystemName <String>] [-SystemDescription <String>] [-AppendLeaf <String>] [-LeafFormat <String>]

Example:

Get-FileCount -FilePath "c:\my\folder"

Look up detailed Windows error information.

Syntax:

Get-Win32Error -ErrorCode <Int32>

Example:

Get-Win32Error 0x80070005  # Access Denied error

For detailed help on any function:

Get-Help <FunctionName> -Detailed
Get-Help <FunctionName> -Examples
Get-Help <FunctionName> -Full

Get-Command -Module systemchecks