Merge pull request #64 from rebelinux/dev

v0.6.11

Author: rebelinux

.github/Dependabot.yml

@@ -0,0 +1,36 @@
+# Dependabot configuration for AsBuiltReport.Core
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  # Monitor GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "ci"
+      include: "scope"
+    open-pull-requests-limit: 5
+
+  # Monitor PowerShell modules (via manifest)
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    labels:
+      - "dependencies"
+      - "powershell"
+    commit-message:
+      prefix: "deps"
+      include: "scope"
+    open-pull-requests-limit: 5
+    ignore:
+      # PScribo updates should be reviewed manually
+      - dependency-name: "PScribo"
+        update-types: ["version-update:semver-major"]

AsBuiltReport.NetApp.ONTAP.json

@@ -15,6 +15,7 @@
         },
         "EnableDiagrams": true,
         "EnableDiagramDebug": false,
+        "DisableDiagramMainLogo": false,
         "DiagramTheme": "White",
         "DiagramWaterMark": "",
         "ExportDiagrams": false,
@@ -87,7 +88,8 @@
             "NTP": true,
             "DNS": true,
             "EMS": true,
-            "Backup": true
+            "Backup": true,
+            "Web": true
         },
         "Security": {
             "Users": true,

AsBuiltReport.NetApp.ONTAP.psd1

@@ -12,7 +12,7 @@
     RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.6.10'
+    ModuleVersion = '0.6.11'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -27,7 +27,7 @@
     #CompanyName = 'Unknown'
 
     # Copyright statement for this module
-    Copyright = '(c) 2024 Jonathan Colon Feliciano. All rights reserved.'
+    Copyright = '(c) 2025 Jonathan Colon Feliciano. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description = 'A PowerShell module to generate an as built report on the configuration of NetApp ONTAP.'

CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.11] - 2025-11-07
+
+### Added
+
+- Add Health Check best practices for general Ontap configurations
+- Add sponsorship information
+- Add Dependabot configuration for module dependencies
+
+### Changed
+
+- Update health check messages to use "in" instead of "on" for consistency in reporting
+- Refactor Get-AbrOntapNodeAggrDiagram to handle aggregate state correctly
+- Refactor Get-AbrOntapNodeAggrDiagram to handle used space calculation correctly
+
 ## [0.6.10] - 2025-10-27
 
 ### Added

README.md

@@ -142,6 +142,7 @@ The **Options** schema allows certain options within the report to be toggled on
 | DiagramTheme           | string       | White   | Set the diagram theme (Black/White/Neon)                                      |
 | DiagramWaterMark       | string       | empty   | Set the diagram watermark                                                     |
 | DiagramType            | true / false | true    | Toggle to enable/disable the export of individual diagram diagrams            |
+| DisableDiagramMainLogo | true / false | false   | Toggle to enable/disable the main logo in diagrams                            |
 | EnableDiagrams         | true / false | false   | Toggle to enable/disable infrastructure diagrams                              |
 | EnableDiagramsDebug    | true / false | false   | Toggle to enable/disable diagram debug option                                 |
 | EnableDiagramSignature | true / false | false   | Toggle to enable/disable diagram signature (bottom right corner)              |

Src/Private/Export-AbrOntapDiagram.ps1

@@ -56,6 +56,7 @@ function Export-AbrOntapDiagram {
                         'top-to-bottom'
                     }
                 }
+                'DisableMainDiagramLogo' = $Options.DisableDiagramMainLogo
             }
 
             if ($Options.DiagramTheme -eq 'Black') {

Src/Private/Get-AbrOntapCluster.ps1

@@ -43,7 +43,7 @@ function Get-AbrOntapCluster {
                     'Overall System Health' = switch ([string]::IsNullOrEmpty($ClusterDiag.Status)) {
                         $true { '--' }
                         $false { $ClusterDiag.Status.ToUpper() }
-                        Default { 'Unknown' }
+                        default { 'Unknown' }
                     }
                 }
                 if ($Healthcheck.Cluster.Summary) {
@@ -60,6 +60,15 @@ function Get-AbrOntapCluster {
                     $TableParams['Caption'] = "- $($TableParams.Name)"
                 }
                 $ClusterSummary | Table @TableParams
+                if ($Healthcheck.Cluster.Summary -and ($ClusterSummary | Where-Object { $_.'Overall System Health' -notlike 'OK' })) {
+                    Paragraph "Health Check:" -Bold -Underline
+                    BlankLine
+                    Paragraph {
+                        Text "Best Practice:" -Bold
+                        Text "The overall system health is not OK. It is recommended to investigate the issue further to ensure the cluster is functioning properly."
+                    }
+                    BlankLine
+                }
             }
         } catch {
             Write-PScriboMessage -IsWarning $_.Exception.Message

Src/Private/Get-AbrOntapClusterASUP.ps1

@@ -24,7 +24,7 @@ function Get-AbrOntapClusterASUP {
 
     process {
         try {
-            $AutoSupport = Get-NcAutoSupportConfig -Controller $Array
+            $AutoSupport = Get-NcAutoSupportConfig -Controller $Array -ErrorAction Continue
             if ($AutoSupport) {
                 $Outobj = @()
                 foreach ($NodesAUTO in $AutoSupport) {
@@ -51,6 +51,15 @@ function Get-AbrOntapClusterASUP {
                             $TableParams['Caption'] = "- $($TableParams.Name)"
                         }
                         $Outobj | Table @TableParams
+                        if ($Healthcheck.Cluster.AutoSupport -and ($Outobj | Where-Object { $_.'Enabled' -like 'No' })) {
+                            Paragraph "Health Check:" -Bold -Underline
+                            BlankLine
+                            Paragraph {
+                                Text "Best Practice:" -Bold
+                                Text "AutoSupport is disabled on one or more nodes. It is recommended to enable AutoSupport to ensure proactive monitoring and issue resolution."
+                            }
+                            BlankLine
+                        }
                     } catch {
                         Write-PScriboMessage -IsWarning $_.Exception.Message
                     }

Src/Private/Get-AbrOntapClusterDiagram.ps1

@@ -119,7 +119,7 @@ function Get-AbrOntapClusterDiagram {
 
                         foreach ($Node in $NodeSum) {
                             # $ClusterHa = $ClusterHaObj | Where-Object { $_.Name -eq $Node.Node }
-                            $ClusterHa = Get-NcClusterHa -Node $Node.Node -Controller $Array
+                            $ClusterHa = try { Get-NcClusterHa -Node $Node.Node -Controller $Array } catch { Write-PScriboMessage -IsWarning $_.Exception.Message }
 
                             $NodeMgmtAddress = Get-NcNetInterface -Controller $Array | Where-Object { $_.Role -eq 'node_mgmt' -and $_.HomeNode -eq $Node.Node } | Select-Object -ExpandProperty Address
                             $NodeInterClusterAddress = Get-NcNetInterface -Controller $Array | Where-Object { $_.Role -eq 'intercluster' -and $_.HomeNode -eq $Node.Node } | Select-Object -ExpandProperty Address
@@ -141,7 +141,7 @@ function Get-AbrOntapClusterDiagram {
                                     "Mgmt" = switch ([string]::IsNullOrEmpty($NodeMgmtAddress)) {
                                         $true { "Unknown" }
                                         $false { $NodeMgmtAddress }
-                                        Default { "Unknown" }
+                                        default { "Unknown" }
                                     }
                                 }
                             }

Src/Private/Get-AbrOntapClusterHA.ps1

@@ -31,13 +31,13 @@ function Get-AbrOntapClusterHA {
                         $ClusterHa = Get-NcClusterHa -Node $Nodes.Node -Controller $Array
                         [PSCustomObject] @{
                             'Name' = $Nodes.Node
-                            'Partner' = Switch ([string]::IsNullOrEmpty($ClusterHa.Partner)) {
+                            'Partner' = switch ([string]::IsNullOrEmpty($ClusterHa.Partner)) {
                                 'True' { '-' }
                                 'False' { $ClusterHa.Partner }
                                 default { 'Unknwon' }
                             }
                             'TakeOver Possible' = ConvertTo-TextYN $ClusterHa.TakeoverPossible
-                            'TakeOver State' = Switch ([string]::IsNullOrEmpty($ClusterHa.TakeoverState)) {
+                            'TakeOver State' = switch ([string]::IsNullOrEmpty($ClusterHa.TakeoverState)) {
                                 'True' { '-' }
                                 'False' { $ClusterHa.TakeoverState }
                                 default { 'Unknwon' }
@@ -51,7 +51,8 @@ function Get-AbrOntapClusterHA {
                 }
                 if ($Healthcheck.Cluster.HA) {
                     $NodeSummary | Where-Object { $_.'TakeOver State' -like 'in_takeover' } | Set-Style -Style Warning -Property 'TakeOver State'
-                    $NodeSummary | Where-Object { $_.'HA State' -notlike 'connected' } | Set-Style -Style Warning -Property 'HA State'
+                    $NodeSummary | Where-Object { $_.'HA Mode' -eq 'non_ha' -and $_.'HA State' -notlike 'connected' } | Set-Style -Style Warning -Property 'HA State'
+                    $NodeSummary | Where-Object { $_.'TakeOver Possible' -eq 'No' } | Set-Style -Style Warning -Property 'TakeOver Possible'
                 }
 
                 $TableParams = @{
@@ -63,6 +64,31 @@ function Get-AbrOntapClusterHA {
                     $TableParams['Caption'] = "- $($TableParams.Name)"
                 }
                 $NodeSummary | Table @TableParams
+                if ($Healthcheck.Cluster.HA -and (($NodeSummary | Where-Object { $_.'TakeOver State' -like 'in_takeover' } ) -or ($NodeSummary | Where-Object { $_.'HA Mode' -ne 'non_ha' -and $_.'HA State' -notlike 'connected' }) -or ($NodeSummary | Where-Object { $_.'TakeOver Possible' -eq 'No' }))) {
+                    Paragraph "Health Check:" -Bold -Underline
+                    BlankLine
+                    if ($NodeSummary | Where-Object { $_.'TakeOver State' -like 'in_takeover' }) {
+                        Paragraph {
+                            Text "Best Practice:" -Bold
+                            Text "One or more nodes are currently in takeover state. It is recommended to investigate the cause of the takeover and ensure that the affected node is restored to normal operation as soon as possible."
+                        }
+                        BlankLine
+                    }
+                    if ($NodeSummary | Where-Object { $_.'TakeOver Possible' -eq 'No' }) {
+                        Paragraph {
+                            Text "Best Practice:" -Bold
+                            Text "One or more nodes have takeover capability disabled. It is recommended to enable storage failover capability to ensure high availability in case of node failures."
+                        }
+                        BlankLine
+                    }
+                    if ($NodeSummary | Where-Object { $_.'HA Mode' -ne 'non_ha' -and $_.'HA State' -notlike 'connected' }) {
+                        Paragraph {
+                            Text "Best Practice:" -Bold
+                            Text "One or more nodes are operating in HA mode and are not connected. It is recommended to verify the HA configuration and connectivity to ensure high availability is properly set up."
+                        }
+                        BlankLine
+                    }
+                }
             }
         } catch {
             Write-PScriboMessage -IsWarning $_.Exception.Message