Scripts/Groups/Get-CohesityUserGroup.ps1
|
function Get-CohesityUserGroup { <# .SYNOPSIS List the user groups that match the filter criteria specified using parameters .DESCRIPTION The Get-CohesityUserGroup function is used to fetch list of all user groups. .EXAMPLE Get-CohesityUserGroup List all user groups .EXAMPLE Get-CohesityUserGroup -Name user_group1 -Domain "LOCAL" #> [OutputType('System.Array')] [CmdletBinding()] Param( [Parameter(Mandatory = $false)] # Optionally specify a group name to filter by. All groups containing name will be returned. [string]$Name, [Parameter(Mandatory = $false)] # Specifies the domain of the group. [string]$Domain = $null ) Begin { $cohesitySession = CohesityUserProfile $cohesityCluster = $cohesitySession.ClusterUri $cohesityToken = $cohesitySession.Accesstoken.Accesstoken } Process { # Construct URL & header $cohesityClusterURL = $cohesityCluster + '/irisservices/api/v1/public/groups' $arguments = @() if($Name) { $arguments += "name=$Name" } if($Domain) { $arguments += "domain=$Domain" } if($arguments.Count -gt 0) { $cohesityClusterURL = $cohesityClusterURL + '?' + ($arguments -join "&") } $cohesityHeaders = @{'Authorization' = 'Bearer ' + $cohesityToken } $userGroupList = Invoke-RestApi -Method 'Get' -Uri $cohesityClusterURL -Headers $cohesityHeaders if($Name) { $userGroupList = $userGroupList | Where-Object {$_.Name -eq $Name} } # tagging reponse for display format ( configured in Cohesity.format.ps1xml ) @($userGroupList | Add-Member -TypeName 'System.Object#UserGroup' -PassThru) } } |