templatePage.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 Set-StaticIPAddress
{
<#
.SYNOPSIS
A brief description of the Set-StaticIPAddress function.
.DESCRIPTION
A detailed description of the Set-StaticIPAddress function.
.PARAMETER CurrentIPAddress
A description of the CurrentIPAddress parameter.
.PARAMETER NewIPAddress
A description of the NewIPAddress parameter.
.PARAMETER subnetPrefix
A description of the subnetPrefix parameter.
.PARAMETER Gateway
A description of the Gateway parameter.
.PARAMETER DNSServers
A description of the DNSServers parameter.
.EXAMPLE
Set-StaticIPAddress -CurrentIPAddress '172.26.155.85' -NewIPAddress '172.26.155.86' -subnetPrefix '20' -Gateway '172.26.144.1' -DNSServers '10.11.8.5','10.11.8.6'
.EXAMPLE
$NewNicDetails = @{
CurrentIPAddress = '192.168.1.15'
NewIPAddress = '192.168.1.20'
subnetPrefix = '24'
Gateway = '192.168.1.1'
DNSServers = '192.168.1.3'
}
Set-StaticIPAddress @NewNicDetails
.EXAMPLE
Set-StaticIPAddress -CurrentIPAddress '192.168.1.15' -NewIPAddress '192.168.1.20' -subnetPrefix '24' -Gateway '192.168.1.1' -DNSServers '192.168.1.3'
.OUTPUTS
System.String
.NOTES
Additional information about the function.
#>
[CmdletBinding(DefaultParameterSetName = 'Default',
HelpUri = 'https://github.com/BanterBoy')]
[OutputType([string])]
param
(
[Parameter(ParameterSetName = 'Default',
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = 'Enter Current IPAddress or pipe input')]
[Alias('ci')]
[string]$CurrentIPAddress,
[Parameter(ParameterSetName = 'Default',
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = 'Enter New IPAddress or pipe input')]
[Alias('na')]
[string]$NewIPAddress,
[Parameter(ParameterSetName = 'Default',
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = 'Enter subnet prefix or pipe input')]
[Alias('sp')]
[int]$subnetPrefix,
[Parameter(ParameterSetName = 'Default',
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = 'Enter Gateway or pipe input')]
[Alias('gw')]
[string]$Gateway,
[Parameter(ParameterSetName = 'Default',
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = 'Enter DNS Server/s or pipe input')]
[Alias('ds')]
[string]$DNSServers
)
BEGIN
{
}
PROCESS
{
foreach ($IPAddress in $CurrentIPAddress)
{
$NetworkCard = Get-NetIPAddress -IPAddress $IPAddress
Get-NetIPInterface -InterfaceIndex $NetworkCard.InterfaceIndex | Set-NetIPInterface -Dhcp Disabled
Start-Sleep -Seconds 1
Remove-NetIPAddress -IPAddress $IPAddress -ErrorAction SilentlyContinue
Remove-NetRoute -InterfaceIndex $NetworkCard.InterfaceIndex -NextHop $Gateway -ErrorAction SilentlyContinue
New-NetIPAddress -InterfaceIndex $NetworkCard.InterfaceIndex -AddressFamily IPv4 -IPAddress $NewIPAddress -PrefixLength $subnetPrefix -ErrorAction SilentlyContinue
New-NetRoute -InterfaceIndex $NetworkCard.InterfaceIndex -DestinationPrefix '0.0.0.0/0' -AddressFamily IPv4 -NextHop $Gateway -RouteMetric 0 -ErrorAction SilentlyContinue
Set-DnsClientServerAddress -InterfaceIndex $NetworkCard.InterfaceIndex -ServerAddresses $DNSServers -ErrorAction SilentlyContinue
Clear-DnsClientCache
Register-DnsClient
}
}
END
{
}
}
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.