Public/Get/Entities/Get-NinjaRMMDeviceWindowsServices.ps1
|
#Requires -Version 7 function Get-NinjaRMMDeviceWindowsServices { <# .SYNOPSIS Gets device windows services from the NinjaRMM API. .DESCRIPTION Retrieves device windows services 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( # Device ID [Parameter(Mandatory = $True)] [Int]$deviceID, # Filter by service name. [String]$name, # Filter by service state. [ValidateSet( 'UNKNOWN', 'STOPPED', 'START_PENDING', 'RUNNING', 'STOP_PENDING', 'PAUSE_PENDING', 'PAUSED', 'CONTINUE_PENDING' )] [String]$state ) $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 windows services for $($Device.SystemName)." $Resource = "v2/device/$($deviceID)/windows-services" } else { $GroupNotFoundError = [ErrorRecord]::New( [ItemNotFoundException]::new("Device with ID $($deviceID) was not found in NinjaRMM."), 'NinjaDeviceNotFound', 'ObjectNotFound', $deviceID ) $PSCmdlet.ThrowTerminatingError($GroupNotFoundError) } } $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } $DeviceWindowsServiceResults = New-NinjaRMMGETRequest @RequestParams Return $DeviceWindowsServiceResults } catch { $CommandFailedError = [ErrorRecord]::New( [System.Exception]::New( 'Failed to get device windows services from NinjaRMM. You can use "Get-Error" for detailed error information.', $_.Exception ), 'NinjaCommandFailed', 'ReadError', $TargetObject ) $PSCmdlet.ThrowTerminatingError($CommandFailedError) } } |