Test-WebSiteUp.ps1


Description

@GitHub Copilot - Welcome @BanterBoy, I’m your Copilot and I’m here to help you get things done faster. I can identify issues, explain and even improve code.

You can ask generic questions, but what I’m really good at is helping you with your code. For example:

Generate unit tests for my code Explain the selected code Propose a fix for the bugs in my code If you want to learn more about my capabilities and limitations, check out the Copilot documentation.

I’m powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

@BanterBoy: - Explain what the script does and why it is useful.

@GitHub Copilot -


Script

Function Test-WebsiteUp {
<#
	.SYNOPSIS
		Test-Website can be used to test if a website is responding.

	.DESCRIPTION
		Test-Website can be used to test if a website is responding.

	.PARAMETER webAddress
		Enter the website address (URL) of the site that you want to test.

	.EXAMPLE
				PS C:\> Test-WebsiteUp -webAddress 'Value1'

	.OUTPUTS
		object

	.NOTES
		Additional information about the function.
#>

	[CmdletBinding(DefaultParameterSetName = 'Default',
				   PositionalBinding = $true,
				   SupportsShouldProcess = $true)]
	[OutputType([object], ParameterSetName = 'Default')]
	Param
	(
		[Parameter(ParameterSetName = 'Default',
				   Mandatory = $true,
				   ValueFromPipeline = $true,
				   ValueFromPipelineByPropertyName = $true,
				   Position = 1,
				   HelpMessage = 'Please enter the URL to test.')]
		[Alias('url')]
		[string]$webAddress
	)

	Begin {
		$Protocol = [System.Net.SecurityProtocolType]'Tls12,Tls13'
		[System.Net.ServicePointManager]::SecurityProtocol = $Protocol
	}

	Process {
		If ($PSCmdlet.ShouldProcess("$webAddress", "Getting the website status")) {
			Try {
				If ($Test.StatusCode -eq '200') {
					$Test = Invoke-WebRequest -Uri $webAddress -ErrorAction Stop -TimeoutSec 10
					$properties = @{
						Code = [int]$Test.StatusCode
						Status = [string]$Test.StatusDescription
						Website = [string]$webAddress
						Message = "Website Status"
					}
				}
				ElseIf ($Test.StatusCode -ne '200') {
					$Test = Invoke-WebRequest -Uri $webAddress -ErrorAction Stop -TimeoutSec 30
					$properties = @{
						Code = [int]$Test.StatusCode
						Status = [string]$Test.StatusDescription
						Website = [string]$webAddress
						Message = "Website Status"
					}
				}
			}
			Catch [System.Net.Http.HttpRequestException] {
				Write-Warning -Message "Website Unavailable"
			}
			Finally {
				$obj = New-Object -TypeName PSObject -Property $properties
				Write-Output $obj
			}

		}
	}
	End {
		Write-Verbose -Message "The WebSite '$webAddress' has been tested."
	}
}

Back to Top


Download

Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.


Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue


Back to Top