Scripts/StorageDomain/get-cohesitystoragedomain.ps1
|
function Get-CohesityStorageDomain { <# .SYNOPSIS Gets a list of storage domains (view boxes) filtered by the specified parameters. .DESCRIPTION The Get-CohesityStorageDomain function is used to fetch list of all storage domain (view box) information using REST API or specific storage domain information based on specified parameters. If no parameters are specified, all storage domains (view boxes) on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned. .EXAMPLE Get-CohesityStorageDomain List all storage domain (view box). .EXAMPLE Get-CohesityStorageDomain -Names storage1 Returns the storage domain (view box) that are filtered out by specified name. .EXAMPLE Get-CohesityStorageDomain -Ids 111,222 Returns the storage domain (view box) that are filtered out by specified ids. .EXAMPLE Get-CohesityStorageDomain -ClusterPartitionIds 333,444 Returns the storage domain (view box) that are filtered out by specified cluster partition ids. .EXAMPLE Get-CohesityStorageDomain -FetchStats Specifies whether to include usage and performance statistics information along with the list of storage domain (view box). If parameter is not mentioned, statistics information won't be fetched. #> [CmdletBinding()] Param( [Parameter(Mandatory = $false)] # Filter by a list of cluster partition Ids. [long[]]$ClusterPartitionIds = $null, [Parameter(Mandatory = $false)] # Specifies whether to include usage and performance statistics. [switch]$FetchStats, [Parameter(Mandatory = $false)] # Filter by a list of storage domain (view box) ids. [long[]]$Ids = $null, [Parameter(Mandatory = $false)] # Filter by a list of storage domain (view box) names. # If empty, storage domains(view boxes) are not filtered by name. [string[]]$Names = $null ) Begin { } Process { # Form query parameters $Parameters = [ordered]@{} $Parameters.Add('allUnderHierarchy', $true) if ($null -ne $ClusterPartitionIds) { $Parameters.Add('clusterPartitionIds', $ClusterPartitionIds -join ',') } if ($null -ne $Ids) { $Parameters.Add('ids', $Ids -join ',') } if ($null -ne $Names) { $Parameters.Add('names', $Names -join ',') } if ($FetchStats.IsPresent) { $Parameters.Add('fetchStats', $true) } $queryString = $null if ($null -ne $Parameters.Keys) { $queryString = '?' + ($Parameters.Keys.ForEach({"$_=$($Parameters.$_)"}) -join '&') } # Construct URL & header $url = '/irisservices/api/v1/public/viewBoxes' $url = $url + $queryString $StorageDomainList = Invoke-RestApi -Method 'Get' -Uri $url $StorageDomainList if ($null -eq $StorageDomainList) { if ($Global:CohesityAPIError) { if ($Global:CohesityAPIError.StatusCode -eq 'NotFound') { $errorMsg = "Storage domain (View Box) doesn't exist." Write-Warning $errorMsg } else { $errorMsg = "Failed to fetch Storage Domain (View Box) information with an error : " + $Global:CohesityAPIError } } else { $errorMsg = "Storage domain (View Box) doesn't exist." Write-Warning $errorMsg } CSLog -Message $errorMsg } } # End of process } # End of function |