AsBuiltReport.NetApp.ONTAP

0.6.12

Src/Private/Get-AbrOntapVserverVolumesQuota.ps1

function Get-AbrOntapVserverVolumesQuota {
    <#
    .SYNOPSIS
        Used by As Built Report to retrieve NetApp ONTAP vserver volumes quota information from the Cluster Management Network
    .DESCRIPTION

    .NOTES
        Version: 0.6.12
        Author: Jonathan Colon
        Twitter: @jcolonfzenpr
        Github: rebelinux
    .EXAMPLE

    .LINK

    #>
    param (
        [Parameter (
            Position = 0,
            Mandatory)]
        [string]
        $Vserver
    )

    begin {
        Write-PScriboMessage 'Collecting ONTAP Vserver volumes quota information.'
    }

    process {
        try {
            Section -ExcludeFromTOC -Style Heading6 "$Vserver Vserver Volume Quota Status" {
                Paragraph "The following section provides the $Vserver Volumes Quota Status Information in $($ClusterInfo.ClusterName)."
                BlankLine
                $VserverQuotaStatus = Get-NcQuotaStatus -VserverContext $Vserver -Controller $Array
                $VserverObj = @()
                if ($VserverQuotaStatus) {
                    foreach ($Item in $VserverQuotaStatus) {
                        try {
                            $inObj = [ordered] @{
                                'Volume' = $Item.Volume
                                'Status' = $Item.Status
                                'Substatus' = $Item.Substatus
                            }
                            $VserverObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                            if ($null -ne $Item.QuotaErrorMsgs) {
                                $VserverObj.Add('Quota Error', $Item.QuotaErrorMsgs)
                            }
                        } catch {
                            Write-PScriboMessage -IsWarning $_.Exception.Message
                        }
                    }
                    if ($Healthcheck.Vserver.Quota) {
                        $VserverObj | Where-Object { $null -ne $_.'Quota Error' } | Set-Style -Style Warning -Property 'Quota Error'
                    }

                    $TableParams = @{
                        Name = "Volume Quota Status - $($Vserver)"
                        List = $false
                        ColumnWidths = 50, 25, 25
                    }
                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }
                    $VserverObj | Table @TableParams
                    if ($Healthcheck.Vserver.Status -and ($VserverObj | Where-Object { $null -ne $_.'Quota Error' })) {
                        Paragraph 'Health Check:' -Bold -Underline
                        BlankLine
                        Paragraph {
                            Text 'Best Practice:' -Bold
                            Text 'Review and resolve any quota errors to ensure proper quota enforcement and avoid potential data management issues.'
                        }
                        BlankLine
                    }
                }
            }
        } catch {
            Write-PScriboMessage -IsWarning $_.Exception.Message
        }
        try {
            if ($InfoLevel.Vserver -ge 2) {
                try {
                    Section -ExcludeFromTOC -Style Heading6 "$Vserver Vserver Volume Quota Information" {
                        Paragraph "The following section provides the $Vserver Volumes Quota Information in $($ClusterInfo.ClusterName)."
                        BlankLine
                        $VserverQuota = Get-NcQuota -VserverContext $Vserver -Controller $Array
                        $VserverObj = @()
                        if ($VserverQuota) {
                            foreach ($Item in $VserverQuota) {
                                try {
                                    $inObj = [ordered] @{
                                        'Volume' = $Item.Volume
                                        'Type' = $Item.QuotaType
                                        'Target' = $Item.QuotaTarget
                                        'Disk Limit' = ($Item.DiskLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -NumberFormatString 0.0 -Type DataSize) ?? '--'
                                        'File Limit' = ($Item.FileLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -Type Count) ?? '--'
                                        'Soft Disk Limit' = ($Item.SoftDiskLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -NumberFormatString 0.0 -Type DataSize) ?? '--'
                                        'Soft File Limit' = ($Item.SoftFileLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -Type Count) ?? '--'
                                    }
                                    $VserverObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                                    if ($null -ne $Item.QuotaError) {
                                        $VserverObj.Add('Quota Error', $Item.QuotaError)
                                    }
                                } catch {
                                    Write-PScriboMessage -IsWarning $_.Exception.Message
                                }
                            }

                            if ($Healthcheck.Vserver.Quota) {
                                $VserverObj | Where-Object { $null -ne $_.'Quota Error' } | Set-Style -Style Warning -Property 'Quota Error'
                            }

                            $TableParams = @{
                                Name = "Volume Quota - $($Vserver)"
                                List = $false
                                ColumnWidths = 15, 13, 20, 13, 13, 13, 13
                            }
                            if ($Report.ShowTableCaptions) {
                                $TableParams['Caption'] = "- $($TableParams.Name)"
                            }
                            $VserverObj | Table @TableParams
                        }
                    }
                } catch {
                    Write-PScriboMessage -IsWarning $_.Exception.Message
                }
                try {
                    Section -ExcludeFromTOC -Style Heading6 "$Vserver Vserver Volume Quota Report (Disk)" {
                        Paragraph "The following section provides the $Vserver Volumes Quota Report (Disk) Information in $($ClusterInfo.ClusterName)."
                        BlankLine
                        $VserverQuotaReport = Get-NcQuotaReport -VserverContext $Vserver -Controller $Array
                        $VserverObj = @()
                        if ($VserverQuotaReport) {
                            foreach ($Item in $VserverQuotaReport) {
                                try {
                                    $inObj = [ordered] @{
                                        'Volume' = $Item.Volume
                                        'Quota Target' = $Item.QuotaTarget
                                        'Qtree' = $Item.Qtree
                                        'Disk Limit' = ($Item.DiskLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -NumberFormatString 0.0 -Type DataSize) ?? '--'
                                        'Soft Disk Limit' = ($Item.SoftDiskLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -NumberFormatString 0.0 -Type DataSize) ?? '--'
                                        'Disk Used' = ($Item.DiskUsed | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -NumberFormatString 0.0 -Type DataSize) ?? '--'
                                    }
                                    $VserverObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                                } catch {
                                    Write-PScriboMessage -IsWarning $_.Exception.Message
                                }
                            }
                            if ($null -ne $Item.QuotaError) {
                                $VserverObj.Add('Quota Error', $Item.QuotaError)
                            }
                            if ($Healthcheck.Vserver.Quota) {
                                $VserverObj | Where-Object { $null -ne $_.'Quota Error' } | Set-Style -Style Warning -Property 'Quota Error'
                            }

                            $TableParams = @{
                                Name = "Volume Quota Report (Disk) - $($Vserver)"
                                List = $false
                                ColumnWidths = 20, 20, 15, 15, 15, 15
                            }
                            if ($Report.ShowTableCaptions) {
                                $TableParams['Caption'] = "- $($TableParams.Name)"
                            }
                            $VserverObj | Table @TableParams
                        }
                    }
                } catch {
                    Write-PScriboMessage -IsWarning $_.Exception.Message
                }
                try {
                    Section -ExcludeFromTOC -Style Heading6 "$Vserver Vserver Volume Quota Report (File)" {
                        Paragraph "The following section provides the $Vserver Volumes Quota Report (File) Information in $($ClusterInfo.ClusterName)."
                        BlankLine
                        $VserverQuotaReport = Get-NcQuotaReport -VserverContext $Vserver -Controller $Array
                        $VserverObj = @()
                        if ($VserverQuotaReport) {
                            foreach ($Item in $VserverQuotaReport) {
                                try {
                                    $inObj = [ordered] @{
                                        'Volume' = $Item.Volume
                                        'Quota Target' = $Item.QuotaTarget
                                        'Qtree' = $Item.Qtree
                                        'File Limit' = ($Item.FileLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -Type Count) ?? '--'
                                        'Soft File Limit' = ($Item.SoftFileLimit | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -Type Count) ?? '--'
                                        'Files Used' = ($Item.FilesUsed | ConvertTo-FormattedNumber -ErrorAction SilentlyContinue -Type Count) ?? '--'
                                    }
                                    $VserverObj += [pscustomobject](ConvertTo-HashToYN $inObj)
                                } catch {
                                    Write-PScriboMessage -IsWarning $_.Exception.Message
                                }
                            }

                            $TableParams = @{
                                Name = "Volume Quota Report (File) - $($Vserver)"
                                List = $false
                                ColumnWidths = 20, 20, 15, 15, 15, 15
                            }
                            if ($Report.ShowTableCaptions) {
                                $TableParams['Caption'] = "- $($TableParams.Name)"
                            }
                            $VserverObj | Table @TableParams
                        }
                    }
                } catch {
                    Write-PScriboMessage -IsWarning $_.Exception.Message
                }
            }
        } catch {
            Write-PScriboMessage -IsWarning $_.Exception.Message
        }
    }

    end {}

}