PoshCode Archive  Artifact [4de971897b]

Artifact 4de971897bcce3dc4b297e838d93620e3288c664c27c0d86848d504080644d80:

• File AddTo-HostsFile.ps1 — part of check-in [b0f93363a1] at 2018-06-10 13:16:07 on branch trunk — Add entries to the Windows hosts file. The function checks first to see if the entry exists in the file. If the entry does not exist, the function adds the entry and verifies it was added. Please feel free to add improvements. The function Utility.Time-Stamp is another helper function I use to denote the current Time. It can be found here: http://poshcode.org/2795. (user: Will Steele size: 2209)

# encoding: ascii
# api: powershell
# title: AddTo-HostsFile
# description: Add entries to the Windows hosts file.  The function checks first to see if the entry exists in the file.  If the entry does not exist, the function adds the entry and verifies it was added.  Please feel free to add improvements.  The function Utility.Time-Stamp is another helper function I use to denote the current Time.  It can be found here: http://poshcode.org/2795.
# version: 0.1
# type: function
# author: Will Steele
# license: CC0
# function: AddTo-HostsFile
# x-poshcode-id: 2817
# x-derived-from-id: 3819
# x-archived: 2016-04-25T04:14:48
# x-published: 2012-07-24T07:41:00
#
#
function AddTo-HostsFile{

	<#
		.DESCRIPTION
			This function checks to see if an entry exists in the hosts file.
			If it does not, it attempts to add it and verifies the entry.

		.EXAMPLE
			Networkign.AddTo-Hosts -IPAddress 192.168.0.1 -HostName MyMachine

		.EXTERNALHELP
			None.

		.FORWARDHELPTARGETNAME
			None.

		.INPUTS
			System.String.

		.LINK
			None.

		.NOTES
			None.

		.OUTPUTS
			System.String.

		.PARAMETER IPAddress
			A string representing an IP address.

		.PARAMETER HostName
			A string representing a host name.

		.SYNOPSIS
			Add entries to the hosts file.
	#>

  param(
    [parameter(Mandatory=$true,position=0)]
	[string]
	$IPAddress,
	[parameter(Mandatory=$true,position=1)]
	[string]
	$HostName
  )

	$HostsLocation = "$env:windir\System32\drivers\etc\hosts";
	$NewHostEntry = "`t$IPAddress`t$HostName";

	if((gc $HostsLocation) -contains $NewHostEntry)
	{
	  Write-Host "$(Time-Stamp): The hosts file already contains the entry: $NewHostEntry.  File not updated.";
	}
	else
	{
    Write-Host "$(Time-Stamp): The hosts file does not contain the entry: $NewHostEntry.  Attempting to update.";
		Add-Content -Path $HostsLocation -Value $NewHostEntry;
	}

	# Validate entry
	if((gc $HostsLocation) -contains $NewHostEntry)
	{
	  Write-Host "$(Time-Stamp): New entry, $NewHostEntry, added to $HostsLocation.";
	}
	else
	{
    Write-Host "$(Time-Stamp): The new entry, $NewHostEntry, was not added to $HostsLocation.";
	}
}