Added Files
This commit is contained in:
DistractADD
439
Powershell/PowerShell-collection/Misc/Hosts_helper.ps1
Normal file
439
Powershell/PowerShell-collection/Misc/Hosts_helper.ps1
Normal file
@@ -0,0 +1,439 @@
|
||||
function Add-HostsEntry
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Add a single Hosts Entry to the HOSTS File
|
||||
|
||||
.DESCRIPTION
|
||||
Add a single Hosts Entry to the HOSTS File, multiple are not supported yet!
|
||||
|
||||
.PARAMETER Path
|
||||
The path to the hosts file where the entry should be set. Defaults to the local computer's hosts file.
|
||||
|
||||
.PARAMETER Address
|
||||
The Address address for the hosts entry.
|
||||
|
||||
.PARAMETER HostName
|
||||
The hostname for the hosts entry.
|
||||
|
||||
.PARAMETER force
|
||||
Force (replace)
|
||||
|
||||
.EXAMPLE
|
||||
PS C:\> Add-HostsEntry -Address '0.0.0.0' -HostName 'badhost'
|
||||
|
||||
Add the host 'badhost' with the Adress '0.0.0.0' (blackhole) wo the Hosts.
|
||||
If an Entry for 'badhost' exists, the new one will be appended anyway (You end up with two entries)
|
||||
|
||||
.EXAMPLE
|
||||
PS C:\> Add-HostsEntry -Address '0.0.0.0' -HostName 'badhost' -force
|
||||
|
||||
Add the host 'badhost' with the Adress '0.0.0.0' (blackhole) wo the Hosts.
|
||||
If an Entry for 'badhost' exists, the new one will replace the existing one.
|
||||
|
||||
.NOTES
|
||||
Internal Helper, inspired by an old GIST I found
|
||||
|
||||
.LINK
|
||||
Get-HostsFile
|
||||
|
||||
.LINK
|
||||
Remove-HostsEntry
|
||||
|
||||
.LINK
|
||||
https://gist.github.com/markembling/173887/1824b370be3fe468faceaed5f39b12bad010a417
|
||||
#>
|
||||
[CmdletBinding(ConfirmImpact = 'Medium',
|
||||
SupportsShouldProcess)]
|
||||
param
|
||||
(
|
||||
[Parameter(Mandatory,
|
||||
Position = 0,
|
||||
HelpMessage = 'The IP address for the hosts entry.')]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('ipaddress', 'ip')]
|
||||
[string]
|
||||
$Address,
|
||||
[Parameter(Mandatory,
|
||||
ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 1,
|
||||
HelpMessage = 'The hostname for the hosts entry.')]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('Host', 'Name')]
|
||||
[string]
|
||||
$HostName,
|
||||
[Parameter(ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 3)]
|
||||
[switch]
|
||||
$force = $false,
|
||||
[Parameter(ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 2)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('filename', 'Hosts', 'hostsfile', 'file')]
|
||||
[string]
|
||||
$Path = "$env:windir\System32\drivers\etc\hosts"
|
||||
)
|
||||
begin
|
||||
{
|
||||
Write-Verbose -Message 'Start'
|
||||
}
|
||||
|
||||
process
|
||||
{
|
||||
if ($force)
|
||||
{
|
||||
try
|
||||
{
|
||||
$null = (Remove-HostsEntry -HostName $HostName -Path $Path -ErrorAction SilentlyContinue -WarningAction SilentlyContinue)
|
||||
}
|
||||
catch
|
||||
{
|
||||
Write-Verbose -Message 'Looks like the entry was not there before'
|
||||
}
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
if ($pscmdlet.ShouldProcess('Target', 'Operation'))
|
||||
{
|
||||
# Get a clean (end of) file
|
||||
$paramGetContent = @{
|
||||
Path = $Path
|
||||
Raw = $true
|
||||
Force = $true
|
||||
ErrorAction = 'Stop'
|
||||
WarningAction = 'SilentlyContinue'
|
||||
}
|
||||
$HostsFileContent = (((Get-Content @paramGetContent ).TrimEnd()).ToString())
|
||||
|
||||
$NewValue = "`n" + $Address + "`t`t" + $HostName
|
||||
$NewHostsFileContent = $HostsFileContent + $NewValue
|
||||
|
||||
$paramSetContent = @{
|
||||
Path = $Path
|
||||
Value = $NewHostsFileContent
|
||||
Force = $true
|
||||
Confirm = $false
|
||||
Encoding = 'UTF8'
|
||||
ErrorAction = 'Stop'
|
||||
WarningAction = 'SilentlyContinue'
|
||||
}
|
||||
$null = (Set-Content @paramSetContent)
|
||||
}
|
||||
}
|
||||
catch
|
||||
{
|
||||
# get error record
|
||||
[Management.Automation.ErrorRecord]$e = $_
|
||||
|
||||
# retrieve information about runtime error
|
||||
$info = [PSCustomObject]@{
|
||||
Exception = $e.Exception.Message
|
||||
Reason = $e.CategoryInfo.Reason
|
||||
Target = $e.CategoryInfo.TargetName
|
||||
Script = $e.InvocationInfo.ScriptName
|
||||
Line = $e.InvocationInfo.ScriptLineNumber
|
||||
Column = $e.InvocationInfo.OffsetInLine
|
||||
}
|
||||
|
||||
$info | Out-String | Write-Verbose
|
||||
|
||||
Write-Error -Message ($info.Exception) -ErrorAction Stop
|
||||
|
||||
# Only here to catch a global ErrorAction overwrite
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
end
|
||||
{
|
||||
Write-Verbose -Message 'Done'
|
||||
}
|
||||
}
|
||||
|
||||
function Remove-HostsEntry
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Removes a single Hosts Entry from the HOSTS File
|
||||
|
||||
.DESCRIPTION
|
||||
Removes a single Hosts Entry from the HOSTS File, multiple are not supported yet!
|
||||
|
||||
.PARAMETER Path
|
||||
The path to the hosts file where the entry should be set. Defaults to the local computer's hosts file.
|
||||
|
||||
.PARAMETER HostName
|
||||
The hostname for the hosts entry.
|
||||
|
||||
.EXAMPLE
|
||||
PS C:\> Remove-HostsEntry -HostName 'Dummy'
|
||||
|
||||
Remove the entry for the host 'Dummy' from the HOSTS File
|
||||
|
||||
.NOTES
|
||||
Internal Helper, inspired by an old GIST I found
|
||||
|
||||
.LINK
|
||||
Get-HostsFile
|
||||
|
||||
.LINK
|
||||
Add-HostsEntry
|
||||
|
||||
.LINK
|
||||
https://gist.github.com/markembling/173887/1824b370be3fe468faceaed5f39b12bad010a417
|
||||
#>
|
||||
[CmdletBinding(ConfirmImpact = 'Medium',
|
||||
SupportsShouldProcess)]
|
||||
param
|
||||
(
|
||||
[Parameter(Mandatory,
|
||||
ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 0,
|
||||
HelpMessage = 'The hostname for the hosts entry.')]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('Host', 'Name')]
|
||||
[string]
|
||||
$HostName,
|
||||
[Parameter(ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 1)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('Hosts', 'hostsfile', 'file', 'Filename')]
|
||||
[string]
|
||||
$Path = "$env:windir\System32\drivers\etc\hosts"
|
||||
)
|
||||
|
||||
begin
|
||||
{
|
||||
Write-Verbose -Message 'Start'
|
||||
|
||||
try
|
||||
{
|
||||
$paramGetContent = @{
|
||||
Path = $Path
|
||||
Raw = $true
|
||||
Force = $true
|
||||
ErrorAction = 'Stop'
|
||||
WarningAction = 'SilentlyContinue'
|
||||
}
|
||||
$HostsFileContent = (((Get-Content @paramGetContent ).TrimEnd()).ToString())
|
||||
}
|
||||
catch
|
||||
{
|
||||
# get error record
|
||||
[Management.Automation.ErrorRecord]$e = $_
|
||||
|
||||
# retrieve information about runtime error
|
||||
$info = [PSCustomObject]@{
|
||||
Exception = $e.Exception.Message
|
||||
Reason = $e.CategoryInfo.Reason
|
||||
Target = $e.CategoryInfo.TargetName
|
||||
Script = $e.InvocationInfo.ScriptName
|
||||
Line = $e.InvocationInfo.ScriptLineNumber
|
||||
Column = $e.InvocationInfo.OffsetInLine
|
||||
}
|
||||
|
||||
$info | Out-String | Write-Verbose
|
||||
|
||||
Write-Error -Message ($info.Exception) -ErrorAction Stop
|
||||
|
||||
# Only here to catch a global ErrorAction overwrite
|
||||
break
|
||||
}
|
||||
|
||||
$newLines = @()
|
||||
}
|
||||
|
||||
process
|
||||
{
|
||||
foreach ($line in $HostsFileContent)
|
||||
{
|
||||
$bits = [regex]::Split($line, '\t+')
|
||||
if ($bits.count -eq 2)
|
||||
{
|
||||
if ($bits[1] -ne $HostName)
|
||||
{
|
||||
$newLines += $line
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$newLines += $line
|
||||
}
|
||||
}
|
||||
|
||||
# Write file
|
||||
try
|
||||
{
|
||||
if ($pscmdlet.ShouldProcess('Target', 'Operation'))
|
||||
{
|
||||
$paramClearContent = @{
|
||||
Path = $Path
|
||||
Force = $true
|
||||
Confirm = $false
|
||||
ErrorAction = 'Stop'
|
||||
WarningAction = 'SilentlyContinue'
|
||||
}
|
||||
$null = (Clear-Content @paramClearContent)
|
||||
|
||||
$paramSetContent = @{
|
||||
Path = $Path
|
||||
Value = $newLines
|
||||
Force = $true
|
||||
Confirm = $false
|
||||
Encoding = 'UTF8'
|
||||
ErrorAction = 'Stop'
|
||||
WarningAction = 'SilentlyContinue'
|
||||
}
|
||||
$null = (Set-Content @paramSetContent)
|
||||
}
|
||||
}
|
||||
catch
|
||||
{
|
||||
# get error record
|
||||
[Management.Automation.ErrorRecord]$e = $_
|
||||
|
||||
# retrieve information about runtime error
|
||||
$info = [PSCustomObject]@{
|
||||
Exception = $e.Exception.Message
|
||||
Reason = $e.CategoryInfo.Reason
|
||||
Target = $e.CategoryInfo.TargetName
|
||||
Script = $e.InvocationInfo.ScriptName
|
||||
Line = $e.InvocationInfo.ScriptLineNumber
|
||||
Column = $e.InvocationInfo.OffsetInLine
|
||||
}
|
||||
|
||||
$info | Out-String | Write-Verbose
|
||||
|
||||
Write-Error -Message ($info.Exception) -ErrorAction Stop
|
||||
|
||||
# Only here to catch a global ErrorAction overwrite
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
end
|
||||
{
|
||||
Write-Verbose -Message 'Done'
|
||||
}
|
||||
}
|
||||
|
||||
function Get-HostsFile
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Print the HOSTS File in a more clean format
|
||||
|
||||
.DESCRIPTION
|
||||
Print the HOSTS File in a more clean format
|
||||
|
||||
.PARAMETER Path
|
||||
The path to the hosts file where the entry should be set. Defaults to the local computer's hosts file.
|
||||
|
||||
.PARAMETER raw
|
||||
Print raw Hosts File
|
||||
|
||||
.EXAMPLE
|
||||
PS C:\> Get-HostsFile
|
||||
|
||||
Print the HOSTS File in a more clean format
|
||||
|
||||
.EXAMPLE
|
||||
PS C:\> Get-HostsFile -raw
|
||||
|
||||
Print the HOSTS File in the regular format
|
||||
|
||||
.NOTES
|
||||
Internal Helper, inspired by an old GIST I found
|
||||
|
||||
.LINK
|
||||
Add-HostsEntry
|
||||
|
||||
.LINK
|
||||
Remove-HostsEntry
|
||||
|
||||
.LINK
|
||||
https://gist.github.com/markembling/173887/1824b370be3fe468faceaed5f39b12bad010a417
|
||||
#>
|
||||
[CmdletBinding(ConfirmImpact = 'None')]
|
||||
param
|
||||
(
|
||||
[Parameter(ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 0)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[Alias('Hosts', 'hostsfile', 'file', 'filename')]
|
||||
[string]
|
||||
$Path = "$env:windir\System32\drivers\etc\hosts",
|
||||
[Parameter(ValueFromPipeline,
|
||||
ValueFromPipelineByPropertyName,
|
||||
Position = 1)]
|
||||
[Alias('plain')]
|
||||
[switch]
|
||||
$raw = $false
|
||||
)
|
||||
|
||||
begin
|
||||
{
|
||||
$HostsFileContent = Get-Content -Path $Path
|
||||
}
|
||||
|
||||
process
|
||||
{
|
||||
foreach ($line in $HostsFileContent)
|
||||
{
|
||||
if ($raw)
|
||||
{
|
||||
Write-Output -InputObject $line
|
||||
}
|
||||
else
|
||||
{
|
||||
$bits = [regex]::Split($line, '\t+')
|
||||
if ($bits.count -eq 2)
|
||||
{
|
||||
[string]$HostsFileLine = $bits
|
||||
|
||||
if (-not ($HostsFileLine.StartsWith('#')))
|
||||
{
|
||||
Write-Output -InputObject $HostsFileLine
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#region LICENSE
|
||||
<#
|
||||
BSD 3-Clause License
|
||||
|
||||
Copyright (c) 2021, enabling Technology
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
#>
|
||||
#endregion LICENSE
|
||||
|
||||
#region DISCLAIMER
|
||||
<#
|
||||
DISCLAIMER:
|
||||
- Use at your own risk, etc.
|
||||
- This is open-source software, if you find an issue try to fix it yourself. There is no support and/or warranty in any kind
|
||||
- This is a third-party Software
|
||||
- The developer of this Software is NOT sponsored by or affiliated with Microsoft Corp (MSFT) or any of its subsidiaries in any way
|
||||
- The Software is not supported by Microsoft Corp (MSFT)
|
||||
- By using the Software, you agree to the License, Terms, and any Conditions declared and described above
|
||||
- If you disagree with any of the terms, and any conditions declared: Just delete it and build your own solution
|
||||
#>
|
||||
#endregion DISCLAIMER
|
||||
Reference in New Issue
Block a user