Public/Get/Entities/Get-NinjaRMMGroups.ps1
|
#Requires -Version 7 function Get-NinjaRMMGroups { <# .SYNOPSIS Gets groups from the NinjaRMM API. .DESCRIPTION Retrieves groups 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 language tag. [Parameter()] [Alias('lang')] [String]$languageTag ) $CommandName = $MyInvocation.InvocationName $Parameters = (Get-Command -Name $CommandName).Parameters try { $QSCollection = New-NinjaRMMQuery -CommandName $CommandName -Parameters $Parameters Write-Verbose 'Retrieving all groups.' $Resource = 'v2/groups' $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } $GroupResults = New-NinjaRMMGETRequest @RequestParams Return $GroupResults } catch { $CommandFailedError = [ErrorRecord]::New( [System.Exception]::New( 'Failed to get groups from NinjaRMM. You can use "Get-Error" for detailed error information.', $_.Exception ), 'NinjaCommandFailed', 'ReadError', $TargetObject ) $PSCmdlet.ThrowTerminatingError($CommandFailedError) } } |