Public/Set-MerakiDeviceSwitchRoutingInterfaceDHCP.ps1
|
function Set-MerakiDeviceSwitchRoutingInterfaceDHCP { <# .SYNOPSIS Updates a device switch routing interface DHCP. .DESCRIPTION The Set-MerakiDeviceSwitchRoutingInterfaceDHCP function allows you to update a device switch routing interface DHCP by providing the authentication token, device serial, interface ID, and a JSON formatted string of DHCP configuration. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER DeviceSerial The serial number of the device. .PARAMETER InterfaceId The ID of the interface to be updated. .PARAMETER DHCPConfig A JSON formatted string of DHCP configuration. .EXAMPLE $DHCPConfig = [PSCustomObject]@{ dhcpMode = "dhcpServer" dhcpLeaseTime = "1 day" dnsNameserversOption = "custom" dnsCustomNameservers = [ "8.8.8.8", "8.8.4.4" ] bootOptionsEnabled = $true bootNextServer = "1.2.3.4" bootFileName = "home_boot_file" dhcpOptions = @( [PSCustomObject]@{ code = "5" type = "text" value = "five" } ) reservedIpRanges = @( [PSCustomObject]@{ start = "192.168.1.1" end = "192.168.1.10" comment = "A reserved IP range" } ) fixedIpAssignments = @( [PSCustomObject]@{ mac = "22:33:44:55:66:77" name = "Cisco Meraki valued client" ip = "192.168.1.12" } ) } $DHCPConfig = $DHCPConfig | ConvertTo-Json Set-MerakiDeviceSwitchRoutingInterfaceDHCP -AuthToken "your-api-token" -DeviceSerial "Q2GV-ABCD-1234" -InterfaceId "123" -DHCPConfig $DHCPConfig This example updates a device switch routing interface DHCP with the specified configuration. .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the update is successful, otherwise, it displays an error message. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$true)] [string]$DeviceSerial, [parameter(Mandatory=$true)] [string]$InterfaceId, [parameter(Mandatory=$true)] [string]$DHCPConfig ) try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken "content-type" = "application/json; charset=utf-8" } $url = "https://api.meraki.com/api/v1/devices/$DeviceSerial/switch/routing/interfaces/$InterfaceId/dhcp" $body = $DHCPConfig $response = Invoke-RestMethod -Method Put -Uri $url -headers $header -UserAgent "MerakiPowerShellModule/1.0.8 DocNougat" -Body $body return $response } catch { Write-Debug $_ Throw $_ } } |