Public/Update/Update-NinjaOneDevice.ps1
|
function Update-NinjaOneDevice { <# .SYNOPSIS Updates device information, like friendly name, user data etc. .DESCRIPTION Updates device information using the NinjaOne v2 API. .OUTPUTS A powershell object containing the response. #> [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = 'Medium' )] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # The device to set the information for. [Parameter(Mandatory = $true)] [int]$deviceId, # The device information body object. [Parameter(Mandatory = $true)] [object]$deviceInformation ) try { $Resource = "v2/device/$deviceId" $RequestParams = @{ Resource = $Resource Body = $deviceInformation } $DeviceExists = (Get-NinjaOneDevices -deviceId $deviceId).Count -gt 0 if ($DeviceExists) { if ($PSCmdlet.ShouldProcess('Device information', 'Update')) { $DeviceUpdate = New-NinjaOnePATCHRequest @RequestParams if ($DeviceUpdate -eq 204) { Write-Information "Device information for device $($deviceId) updated successfully." } } } else { throw "Device $($deviceId) does not exist." } } catch { New-NinjaOneError -ErrorRecord $_ } } |