Public/Get-MerakiDeviceApplianceUplinksSettings.ps1
|
function Get-MerakiDeviceApplianceUplinksSettings { <# .SYNOPSIS Gets the uplink settings for a specific Cisco Meraki appliance by serial number. .DESCRIPTION This function makes a REST API call to the Meraki dashboard API to retrieve information about the uplink settings for a specific Cisco Meraki appliance, based on its serial number. The function returns detailed information about each uplink, including its name, active status, and configuration. .PARAMETER AuthToken The authentication token to use for the API call. This should be a valid API key for the Meraki dashboard. .PARAMETER deviceSerial The serial number of the Cisco Meraki appliance to retrieve uplink settings information for. .EXAMPLE PS C:\> Get-MerakiDeviceApplianceUplinksSettings -AuthToken "myapikey" -deviceSerial "Q2XX-XXXX-XXXX" Returns information about the uplink settings for the Cisco Meraki appliance with the specified serial number. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$true)] [string]$DeviceSerial ) try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken } $response = Invoke-RestMethod -Method Get -Uri "https://api.meraki.com/api/v1/devices/$DeviceSerial/appliance/uplinks/settings" -Header $header -UserAgent "MerakiPowerShellModule/1.0.2 DocNougat" return $response } catch { Write-Error "Failed to retrieve Meraki appliance uplink settings: $_" } } |