Public/Get-OVGDGroup.ps1
|
function Get-OVGDGroup { <# .SYNOPSIS Retrieve Global Dashboard groups .DESCRIPTION This function will retrieve logical groups from the connected Global Dashboard instance .NOTES Info Author : Rudi Martinsen / Intility AS Date : 25/03-2019 Version : 0.4.0 Revised : 25/04-2019 Changelog: 0.4.0 -- Reworked output 0.3.0 -- Changed Entity parameter to Id 0.2.1 -- Added help text 0.2.0 -- Added count param .LINK https://github.com/rumart/GlobalDashboardPS .LINK https://developer.hpe.com/blog/accessing-the-hpe-oneview-global-dashboard-api .PARAMETER Server The Global Dashboard to work with, defaults to the Global variable OVGDPSServer .PARAMETER Entity The Id of the Group to retrieve .EXAMPLE PS C:\> Get-OVGDGroup Lists the groups on the connected Global Dashboard instance .EXAMPLE PS C:\> Get-OVGDGroup -Id xxxxxxxx-xxxx-xxxx-xxxx-54e195f27f36 Lists the groups on the connected Global Dashboard instance with the specified Id #> [CmdletBinding()] param ( $Server = $Global:OVGDPSServer, [alias("Entity")] $Id, $Count = 25 ) begin { $ResourceType = "groups" } process { $Resource = BuildPath -Resource $ResourceType -Entity $Id $result = Invoke-OVGDRequest -Resource $Resource if ($result.Count -lt $result.Total ) { Write-Verbose "The result has been paged. Total number of results is: $($result.total)" } Write-Verbose "Got $($result.count) number of results" if ($result.Count -lt $result.Total ) { Write-Warning "The result has been paged. Total number of results is: $($result.total)" } if($result.Count -ge 1){ Write-Verbose "Found $($result.total) number of results" $output = $result.items } elseif($result.Count -eq 0){ return $null } elseif($result.category -eq $ResourceType){ $output = $result } else{ return $result } if($Output){ $output = Add-OVGDTypeName -TypeName "GlobalDashboardPS.OVGDGroup" -Object $output return $output } } end { } } |