Merge pull request #54 from AsBuiltReport/dev

v0.6.8 public release

Author: rebelinux

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -4,6 +4,16 @@ labels: ["bug"]
 assignees:
   - rebelinux
 body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report :)
+        - Kindly **DO NOT** ask for instructions.
+        - Use [Discussions](https://github.com/orgs/AsBuiltReport/discussions) section if you have a query or doubts or any other relevant question.
+        - You may join [Slack community](https://the-code-community.slack.com#asbuiltreport) to interact with fellow contributors and users
+        - Read project's [Web Site](https://www.asbuiltreport.com/user-guide/installation/) for detailed documentation.
+        - Read project's [FAQs](https://www.asbuiltreport.com/support/faq/) section for Frequently asked questions.
+        - Search for previous [Issues](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues)/[Pull Requests](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/pulls) if this issue is already reported or fix has been created.
   - type: textarea
     id: bug-description
     attributes:
@@ -89,10 +99,3 @@ body:
         - label: >-
             I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
           required: true
-        - label: >-
-            I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
-            and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
-          required: true
-        - label: >-
-            I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues) before submitting this bug report.
-          required: true

.github/workflows/PSScriptAnalyzer.yml

@@ -5,7 +5,7 @@ jobs:
     name: Run PSScriptAnalyzer
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: lint
       uses: devblackops/github-action-psscriptanalyzer@master
       with:

.github/workflows/Release.yml

@@ -8,7 +8,7 @@ jobs:
   publish-to-gallery:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |
@@ -45,3 +45,13 @@ jobs:
           TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
           TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
           TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
+  bsky-post:
+    needs: publish-to-gallery
+    runs-on: ubuntu-latest
+    steps:
+      - uses: zentered/[email protected]
+        with:
+          post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Netapp #AsBuiltReport #PowerShell #Ontap #NetAppATeam"
+        env:
+          BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }}
+          BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }}

.github/workflows/codeql.yml

@@ -29,7 +29,7 @@ jobs:
     name: PSScriptAnalyzer
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Run PSScriptAnalyzer
         uses: microsoft/[email protected]

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "PowerShell: Interactive Session",
+            "type": "PowerShell",
+            "request": "launch"
+        }
+    ]
+}

AsBuiltReport.NetApp.ONTAP.json

@@ -12,7 +12,19 @@
         "Exclude": {
             "Vserver": [],
             "MetroCluster": false
-        }
+        },
+        "EnableDiagrams": true,
+        "EnableDiagramDebug": false,
+        "DiagramTheme": "White",
+        "DiagramWaterMark": "",
+        "ExportDiagrams": false,
+        "ExportDiagramsFormat": [
+            "png"
+        ],
+        "EnableDiagramSignature": false,
+        "DiagramColumnSize": 4,
+        "SignatureAuthorName": "",
+        "SignatureCompanyName": ""
     },
     "InfoLevel": {
         "_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary",

AsBuiltReport.NetApp.ONTAP.psd1

@@ -12,7 +12,7 @@
     RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.6.7'
+    ModuleVersion = '0.6.8'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -54,11 +54,15 @@
     RequiredModules = @(
         @{
             ModuleName = 'AsBuiltReport.Core';
-            ModuleVersion = '1.4.0'
+            ModuleVersion = '1.4.3'
         },
         @{
             ModuleName = 'NetApp.ONTAP';
-            ModuleVersion = '9.15.1.2407'
+            ModuleVersion = '9.16.1.2501'
+        },
+        @{
+            ModuleName = 'Diagrammer.Core';
+            ModuleVersion = '0.2.29'
         }
     )
 
@@ -128,4 +132,4 @@
     # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
     # DefaultCommandPrefix = ''
 
-}
+}

CHANGELOG.md

@@ -5,12 +5,36 @@ 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.8] - 2025-08-18
+
+### Added
+
+- Add Infrastructure diagram support
+  - Cluster
+  - Storage Aggretates (Tiers)
+  - Replication
+- Added various icon files for report generation.
+
+### Changed
+
+- Improved Invoke-AsBuiltReport.NetApp.ONTAP.ps1 to provide better user feedback and check for module versions.
+- Refactor and enhance ONTAP report generation scripts
+- Updated Get-AbrOntapClusterHA.ps1 to remove unnecessary string conversion to uppercase for HA Mode and HA State.
+- Modified Get-AbrOntapNetworkRoute.ps1 and Get-AbrOntapNetworkRouteLifs.ps1 to remove uppercase conversion for Address Family.
+- Enhanced Get-AbrOntapRepRelations.ps1 to handle empty Schedule and Status fields more gracefully.
+- Updated Get-AbrOntapVserverCIFSSummary.ps1 to remove uppercase conversion for Status.
+- Improved Invoke-AsBuiltReport.NetApp.ONTAP.ps1 to provide better user feedback and check for module versions.
+
+### Fixed
+
+- Fix [#51](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/51)
+
 ## [0.6.7] - 2024-08-09
 
 ### Added
 
 - Initial Vserver NVME support
-- Added option for MetroCluster volume exclusions (*.mc) @MicKBfr
+- Added option for MetroCluster vserver exclusions (*.mc) @MicKBfr
 
 ### Changed
 

README.md

@@ -51,7 +51,7 @@ Below are the instructions on how to install, configure and generate a NetApp ON
 The ONTAP Storage As Built Report supports the following ONTAP versions;
 
 - ONTAP 9.x
-  - Tested on v9.5, 9.7, 9.8, 9.9.1, 9.10.1, 9.11.1, 9.12.1, 9.13.1, 9.14.1, 9.15.1
+  - Tested on v9.5, 9.7, 9.8, 9.9.1, 9.10.1, 9.11.1, 9.12.1, 9.13.1, 9.14.1, 9.15.1, 9.16.1
 
 ### **PowerShell**
 
@@ -141,6 +141,17 @@ The **Options** schema allows certain options within the report to be toggled on
 | --------------------- | ------------ | ------- | -------------------------------------------------- |
 | Exclude: Vserver      | Array List   | Empty   | Allow to filter on Vserver Name                    |
 | Exclude: MetroCluster | true / false | false   | Allow to filter automatically all Vserver with -mc |
+| DiagramColumnSize       | int                        | 3       | Set the diagram node table size                                               |
+| 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            |
+| 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)              |
+| ExportDiagrams          | true / false               | true    | Toggle to enable/disable diagram export option                                |
+| ExportDiagramsFormat    | string array               | png     | Set the format used to export the infrastructure diagram (dot, png, pdf, svg) |
+| SignatureAuthorName     | string                     | empty   | Set the signature author name                                                 |
+| SignatureCompanyName    | string                     | empty   | Set the signature company name                                                |
 
 ### InfoLevel
 
@@ -193,5 +204,3 @@ PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Username 'a
 
 ```
 ## :x: Known Issues
-
-- There are known issues with the NetApp.ONTAP module v9.11.1.2208. Therefore, v9.10.1.2111 is the recommended module version.

Src/Private/Export-AbrOntapDiagram.ps1

@@ -0,0 +1,136 @@
+function Export-AbrOntapDiagram {
+    <#
+    .SYNOPSIS
+    Used by As Built Report to export NetApp Ontap infrastructure diagram
+    .DESCRIPTION
+        Documents the configuration of NetApp Ontap in Word/HTML/Text formats using PScribo.
+    .NOTES
+        Version:        0.6.8
+        Author:         Jonathan Colon
+        Twitter:        @jcolonfzenpr
+        Github:         rebelinux
+        Credits:        Iain Brighton (@iainbrighton) - PScribo module
+
+    .LINK
+        https://github.com/AsBuiltReport/AsBuiltReport.NetApp.Ontap
+    #>
+
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingCmdletAliases", "", Scope = "Function")]
+
+    [CmdletBinding()]
+    param (
+        $DiagramObject,
+        [string] $MainDiagramLabel = 'Change Me',
+        [Parameter(Mandatory = $true)]
+        [string] $FileName
+    )
+
+    begin {
+        Write-PScriboMessage -Message "EnableDiagrams set to $($Options.EnableDiagrams)."
+    }
+
+    process {
+        if ($Options.EnableDiagrams) {
+            Write-PScriboMessage -Message "Collecting NetApp Ontap Infrastructure diagram"
+
+            $RootPath = Split-Path (Split-Path $PSScriptRoot -Parent) -Parent
+            [System.IO.FileInfo]$IconPath = Join-Path $RootPath 'icons'
+
+            $DiagramParams = @{
+                'FileName' = $FileName
+                'OutputFolderPath' = $OutputFolderPath
+                'MainDiagramLabel' = $MainDiagramLabel
+                'MainDiagramLabelFontsize' = 28
+                'MainDiagramLabelFontcolor' = '#565656'
+                'MainDiagramLabelFontname' = 'Segoe UI Black'
+                'IconPath' = $IconPath
+                'ImagesObj' = $Images
+                'LogoName' = 'AsBuiltReport_LOGO'
+                'SignatureLogoName' = 'Abr_LOGO_Footer'
+                'WaterMarkText' = $Options.DiagramWaterMark
+                'Direction' = &{
+                    if ($MainDiagramLabel -eq 'Cluster Replication Diagram') {
+                        'left-to-right'
+                    } else {
+                        'top-to-bottom'
+                    }
+                }
+            }
+
+            if ($Options.DiagramTheme -eq 'Black') {
+                $DiagramParams.add('MainGraphBGColor', 'Black')
+                $DiagramParams.add('Edgecolor', 'White')
+                $DiagramParams.add('Fontcolor', 'White')
+                $DiagramParams.add('NodeFontcolor', 'White')
+                $DiagramParams.add('WaterMarkColor', 'White')
+            } elseif ($Options.DiagramTheme -eq 'Neon') {
+                $DiagramParams.add('MainGraphBGColor', 'grey14')
+                $DiagramParams.add('Edgecolor', 'gold2')
+                $DiagramParams.add('Fontcolor', 'gold2')
+                $DiagramParams.add('NodeFontcolor', 'gold2')
+                $DiagramParams.add('WaterMarkColor', '#FFD700')
+            } else {
+                $DiagramParams.add('WaterMarkColor', '#333333')
+            }
+
+            if ($Options.ExportDiagrams) {
+                if (-not $Options.ExportDiagramsFormat) {
+                    $DiagramFormat = 'png'
+                } else {
+                    $DiagramFormat = $Options.ExportDiagramsFormat
+                }
+                $DiagramParams.Add('Format', $DiagramFormat)
+            } else {
+                $DiagramParams.Add('Format', "base64")
+            }
+
+            if ($Options.EnableDiagramDebug) {
+
+                $DiagramParams.Add('DraftMode', $True)
+
+            }
+
+            if ($Options.EnableDiagramSignature) {
+                $DiagramParams.Add('Signature', $True)
+                $DiagramParams.Add('AuthorName', $Options.SignatureAuthorName)
+                $DiagramParams.Add('CompanyName', $Options.SignatureCompanyName)
+            }
+
+            if ($Options.ExportDiagrams) {
+                try {
+                    Write-PScriboMessage -Message "Generating NetApp Ontap diagram"
+                    $Graph = $DiagramObject
+                    if ($Graph) {
+                        Write-PScriboMessage -Message "Saving NetApp Ontap diagram"
+                        $Diagram = New-Diagrammer @DiagramParams -InputObject $Graph
+                        if ($Diagram) {
+                            foreach ($OutputFormat in $DiagramFormat) {
+                                Write-Information -MessageData "Saved '$($FileName).$($OutputFormat)' diagram to '$($OutputFolderPath)'." -InformationAction Continue
+                            }
+                        }
+                    }
+                } catch {
+                    Write-PScriboMessage -IsWarning -Message "Unable to export the NetApp Diagram: $($_.Exception.Message)"
+                }
+            }
+            try {
+                $DiagramParams.Remove('Format')
+                $DiagramParams.Add('Format', "base64")
+
+                $Graph = $DiagramObject
+                $Diagram = New-Diagrammer @DiagramParams -InputObject $Graph
+                if ($Diagram) {
+                    if ((Get-DiaImagePercent -GraphObj $Diagram).Width -gt 600) { $ImagePrty = 40 } else { $ImagePrty = 30 }
+                    Section -Style Heading2 $MainDiagramLabel {
+                        Image -Base64 $Diagram -Text "NetApp Ontap Diagram" -Percent $ImagePrty -Align Center
+                        Paragraph "Image preview: Opens the image in a new tab to view it at full resolution." -Tabs 2
+                    }
+                }
+            } catch {
+                Write-PScriboMessage -IsWarning -Message "Unable to generate the Ontap Diagram: $($_.Exception.Message)"
+            }
+        }
+    }
+
+    end {}
+}