Set-DHCPIPAddress.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-DHCPIPAddress {
	<#
	.SYNOPSIS
		Configure a network adapter to use DHCP settings.

	.DESCRIPTION
		Configure a network adapter to use DHCP settings using the current IP address of the Network Card that you would like to configure to receive a DHCP IP Address assignment.

	.PARAMETER CurrentIPAddress
		Enter the current IP address of the Network Card that you would like to configure to receive a DHCP IP Address assignment.

	.EXAMPLE
		Set-DHCPIPAddress -CurrentIPAddress $value1

	.EXAMPLE
		Set-DHCPIPAddress -CurrentIPAddress '192.168.1.20'
		Clear-DnsClientCache
		Register-DnsClient
		ipconfig /release
		ipconfig /renew

	.OUTPUTS
		string

	.NOTES
		Additional information about the function.

	.LINK
		https://github.com/BanterBoy
	#>

	[CmdletBinding(DefaultParameterSetName = 'Default',
		HelpUri = 'https://github.com/BanterBoy',
		SupportsPaging = $true,
		SupportsShouldProcess = $true)]
	param
	(
		[Parameter(ParameterSetName = 'Default',
			Mandatory = $true,
			ValueFromPipeline = $true,
			ValueFromPipelineByPropertyName = $true,
			Position = 0,
			HelpMessage = 'Enter Current IPAddress or pipe input')]
		[Alias('ci')]
		[string]$CurrentIPAddress
	)

	BEGIN {
	}
	PROCESS {
		if ($PSCmdlet.ShouldProcess("$($CurrentIPAddress)", "Setting Network card to DHCP")) {
			try {
				foreach ($IPAddress in $CurrentIPAddress) {
						$NetworkCard = Get-NetIPAddress -IPAddress $IPAddress
						$Interface = Get-NetIPInterface -InterfaceIndex $NetworkCard.InterfaceIndex
						$Interface | Set-NetIPInterface -Dhcp Enabled -ErrorAction SilentlyContinue
						$Interface | Set-DnsClientServerAddress -ResetServerAddresses -ErrorAction SilentlyContinue
						$Interface | Remove-NetRoute -Confirm:$false -ErrorAction SilentlyContinue
						Clear-DnsClientCache
						Register-DnsClient
						ipconfig /release
						ipconfig /renew
				}
			}
			catch {
				Write-Error "Unable to find interface with IP Address $($IPAddress)"
			}
		}
	}
	END {
	}
}

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