Public/Get/Entities/Get-NinjaRMMDeviceCustomFields.ps1
|
#Requires -Version 7 function Get-NinjaRMMDeviceCustomFields { <# .SYNOPSIS Gets device custom fields from the NinjaRMM API. .DESCRIPTION Retrieves device custom fields from the NinjaRMM v2 API. .OUTPUTS A powershell object containing the response. #> [CmdletBinding()] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # Filter by device ID. [Int]$deviceID ) $CommandName = $MyInvocation.InvocationName $Parameters = (Get-Command -Name $CommandName).Parameters # Workaround to prevent the query string processor from adding an 'deviceid=' parameter by removing it from the set parameters. if ($deviceID) { $Parameters.Remove('deviceID') | Out-Null } try { $QSCollection = New-NinjaRMMQuery -CommandName $CommandName -Parameters $Parameters if ($deviceID) { Write-Verbose 'Getting device from NinjaRMM API.' $Device = Get-NinjaRMMDevices -deviceID $deviceID -ErrorAction SilentlyContinue if ($Device) { Write-Verbose "Retrieving custom fields for $($Device.SystemName)." $Resource = "v2/device/$($deviceID)/custom-fields" } else { $DeviceNotFoundError = [ErrorRecord]::New( [ItemNotFoundException]::new("Device with ID $($deviceID) was not found in NinjaRMM."), 'NinjaDeviceNotFound', 'ObjectNotFound', $deviceID ) $PSCmdlet.ThrowTerminatingError($DeviceNotFoundError) } } else { Write-Verbose 'Retrieving all device custom fields.' $Resource = 'v2/device-custom-fields' } $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } $DeviceCustomFieldResults = New-NinjaRMMGETRequest @RequestParams Return $DeviceCustomFieldResults } catch { $CommandFailedError = [ErrorRecord]::New( [System.Exception]::New( 'Failed to get device custom fields from NinjaRMM. You can use "Get-Error" for detailed error information.', $_.Exception ), 'NinjaCommandFailed', 'ReadError', $TargetObject ) $PSCmdlet.ThrowTerminatingError($CommandFailedError) } } |