Merge pull request #60 from AsBuiltReport/dev

v0.6.9 public release

Author: rebelinux

.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+#patreon: # Replace with a single Patreon username
+#open_collective: # Replace with a single Open Collective username
+ko_fi: F1F8DEV80
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+#issuehunt: # Replace with a single IssueHunt username
+#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+#polar: # Replace with a single Polar username
+#buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+#thanks_dev: # Replace with a single thanks.dev username
+#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/Release.yml

@@ -49,3 +49,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 }}

AsBuiltReport.NetApp.ONTAP.psd1

@@ -12,7 +12,7 @@
     RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.6.8'
+    ModuleVersion = '0.6.9'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -54,15 +54,15 @@
     RequiredModules = @(
         @{
             ModuleName = 'AsBuiltReport.Core';
-            ModuleVersion = '1.4.3'
+            ModuleVersion = '1.5.0'
         },
         @{
             ModuleName = 'NetApp.ONTAP';
-            ModuleVersion = '9.16.1.2501'
+            ModuleVersion = '9.17.1.2509'
         },
         @{
             ModuleName = 'Diagrammer.Core';
-            ModuleVersion = '0.2.29'
+            ModuleVersion = '0.2.32'
         }
     )
 

CHANGELOG.md

@@ -5,6 +5,24 @@ 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.9] - 2025-10-21
+
+### Changed
+
+- General code cleanup/improvements
+- Add Bluesky post action to release workflow
+- Increased Required Modules version:
+  - Diagrammer.Core v0.2.32
+  - NetApp.Ontap v9.17.1.2509
+  - AsBuiltReport.Core v1.5.0
+- Refactor Get-NetAppOntapAPI to handle Unix platform and improve error handling in Invoke-AsBuiltReport.NetApp.ONTAP
+
+### Fixed
+
+- Fix issue where cluster replication diagram generation fails if no replication relationships are found.
+- Fix issue where certain sections of the report may not render correctly on Unix-based systems.
+- Close [#58](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/58)
+
 ## [0.6.8] - 2025-08-18
 
 ### Added

README.md

@@ -22,9 +22,6 @@
     <a href="https://twitter.com/AsBuiltReport" alt="Twitter">
             <img src="https://img.shields.io/twitter/follow/AsBuiltReport.svg?style=social"/></a>
 </p>
-<p align="center">
-    <a href='https://ko-fi.com/F1F8DEV80' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'            border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
-</p>
 
 # NetApp ONTAP Arrays AsBuiltReport
 
@@ -51,7 +48,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, 9.16.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, 9.17.1
 
 ### **PowerShell**
 
@@ -68,10 +65,10 @@ Each of the following modules will be automatically installed by following the [
 These modules may also be manually installed.
 
 | Module Name        | Minimum Required Version |                              PS Gallery                               |                                   GitHub                                    |
-|--------------------|:------------------------:|:---------------------------------------------------------------------:|:---------------------------------------------------------------------------:|
-| PScribo            |          0.10.0           |      [Link](https://www.powershellgallery.com/packages/PScribo)       |         [Link](https://github.com/iainbrighton/PScribo/tree/master)         |
+| ------------------ | :----------------------: | :-------------------------------------------------------------------: | :-------------------------------------------------------------------------: |
+| PScribo            |          0.10.0          |      [Link](https://www.powershellgallery.com/packages/PScribo)       |         [Link](https://github.com/iainbrighton/PScribo/tree/master)         |
 | AsBuiltReport.Core |          1.4.0           | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Core) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Core/releases/latest) |
-| Netapp.ONTAP |          9.15.1.2407           | [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP) |  |
+| Netapp.ONTAP       |       9.17.1.2509        |    [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP)    |                                                                             |
 
 ## :package: Module Installation
 
@@ -137,21 +134,21 @@ The **Report** schema provides configuration of the NetApp ONTAP report informat
 ### Options
 
 The **Options** schema allows certain options within the report to be toggled on or off.
-| Sub-Schema            | Setting      | Default | Description                                        |
-| --------------------- | ------------ | ------- | -------------------------------------------------- |
-| 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                                                |
+| Sub-Schema             | Setting      | Default | Description                                                                   |
+| ---------------------- | ------------ | ------- | ----------------------------------------------------------------------------- |
+| 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
 
@@ -204,3 +201,5 @@ PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Username 'a
 
 ```
 ## :x: Known Issues
+
+- Issues with ASA v1/v2 hardware model. [#56](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/56)

Samples/Sample NetApp As-Built Report.html

@@ -48,7 +48,7 @@ function Export-AbrOntapDiagram {
                 'LogoName' = 'AsBuiltReport_LOGO'
                 'SignatureLogoName' = 'Abr_LOGO_Footer'
                 'WaterMarkText' = $Options.DiagramWaterMark
-                'Direction' = &{
+                'Direction' = & {
                     if ($MainDiagramLabel -eq 'Cluster Replication Diagram') {
                         'left-to-right'
                     } else {
@@ -114,17 +114,22 @@ function Export-AbrOntapDiagram {
                 }
             }
             try {
-                $DiagramParams.Remove('Format')
-                $DiagramParams.Add('Format', "base64")
+                if ($PSVersionTable.Platform -ne 'Unix') {
+                    $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
+                    $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
+                        }
                     }
+                } else {
+                    Write-PScriboMessage -IsWarning -Message "PSCribo Images embedding is not supported on PowerShell Core running on Linux or MacOS."
+
                 }
             } catch {
                 Write-PScriboMessage -IsWarning -Message "Unable to generate the Ontap Diagram: $($_.Exception.Message)"

Src/Private/Export-AbrOntapDiagram.ps1

@@ -5,7 +5,7 @@ function Get-AbrOntapClusterReplicationDiagram {
     .DESCRIPTION
 
     .NOTES
-        Version:        0.6.8
+        Version:        0.6.9
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -199,12 +199,14 @@ function Get-AbrOntapClusterReplicationDiagram {
                     $Num++
                 }
 
-                if ($ClusterReplicaInfo) {
+                if ($ClusterReplicaInfo -and $NodeReplicaSum) {
                     try {
                         $ClusterReplicaNodeObj = Add-DiaHTMLNodeTable -ImagesObj $Images -inputObject $NodeReplicaSum -Align "Center" -iconType "Ontap_Node" -columnSize $NodeSumColumnSize -IconDebug $IconDebug -MultiIcon -AditionalInfo $NodeAdditionalInfo -Subgraph -SubgraphIconType "Ontap_Node_Icon" -SubgraphLabel $ClusterReplicaInfo.ClusterName -SubgraphLabelPos "top" -SubgraphTableStyle "dashed,rounded" -TableBorderColor "#71797E" -TableBorder "1" -SubgraphLabelFontsize 22 -fontSize 18
                     } catch {
                         Write-PScriboMessage -IsWarning $_.Exception.Message
                     }
+                } else {
+                    Write-PScriboMessage -IsWarning "Unable to create Cluster Replication Node. No Cluster Management Object found."
                 }
 
                 if ($ClusterReplicaNodeObj) {
@@ -238,9 +240,11 @@ function Get-AbrOntapClusterReplicationDiagram {
 
                     $PeerVserverPeerSubGraphObj = Add-DiaHTMLSubGraph -ImagesObj $Images -TableArray $PeerVserverPeerObj -Align 'Center' -IconDebug $IconDebug -Label "Peer Storage VMs" -LabelPos 'top' -TableStyle "dashed,rounded" -TableBorderColor $Edgecolor -TableBorder "1" -columnSize $PeerVserverPeerObjColumnSize -fontSize 18 -IconType "Ontap_SVM_Icon"
 
-                    if ($PeerVserverPeerSubGraphObj) {
+                    if ($PeerVserverPeerSubGraphObj -and $RemoteClusterName) {
                         Node "$($RemoteClusterName)PeerVservers" @{Label = $PeerVserverPeerSubGraphObj; shape = 'plain'; fillColor = 'transparent'; fontsize = 14 }
                         Edge -From $RemoteClusterName -To "$($RemoteClusterName)PeerVservers" @{minlen = 2; color = '#71797E'; style = 'filled'; arrowhead = 'box'; arrowtail = 'box' }
+                    } else {
+                        Write-PScriboMessage -IsWarning "Unable to create Peer Vserver Node. No Peer Vserver Object found."
                     }
                 } catch {
                     Write-PScriboMessage -IsWarning $_.Exception.Message

Src/Private/Get-AbrOntapClusterReplicationDiagram.ps1

@@ -26,9 +26,10 @@ function Get-NetAppOntapAPI {
     )
 
     begin {
-        #region Workaround for SelfSigned Cert an force TLS 1.2
-        if (-not ([System.Management.Automation.PSTypeName]'ServerCertificateValidationCallback').Type) {
-            $certCallback = @"
+        if ($PSVersionTable.Platform -ne 'Unix') {
+            #region Workaround for SelfSigned Cert an force TLS 1.2
+            if (-not ([System.Management.Automation.PSTypeName]'ServerCertificateValidationCallback').Type) {
+                $certCallback = @"
         using System;
         using System.Net;
         using System.Net.Security;
@@ -54,11 +55,12 @@ function Get-NetAppOntapAPI {
             }
         }
 "@
-            Add-Type $certCallback
+                Add-Type $certCallback
+            }
+            [ServerCertificateValidationCallback]::Ignore()
+            [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls"
+            #endregion Workaround for SelfSigned Cert an force TLS 1.2
         }
-        [ServerCertificateValidationCallback]::Ignore()
-        [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls"
-        #endregion Workaround for SelfSigned Cert an force TLS 1.2
 
         $username = $Credential.UserName
         $password = $Credential.GetNetworkCredential().Password
@@ -73,19 +75,19 @@ function Get-NetAppOntapAPI {
         }
     }
 
-    Process {
-        Try {
+    process {
+        try {
             if ($PSVersionTable.PSEdition -eq 'Core') {
                 $response = Invoke-RestMethod -Method Get -Uri ($api + $uri) -Headers $headers -SkipCertificateCheck
 
             } else {
                 $response = Invoke-RestMethod -Method Get -Uri ($api + $uri) -Headers $headers
             }
             $response.records
-        } Catch {
+        } catch {
             Write-Verbose -Message $_
         }
     }
 
-    End {}
+    end {}
 }

Src/Private/Get-NetAppOntapAPI.ps1

@@ -21,15 +21,14 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Scope = "Function")]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", "", Scope = "Function")]
 
+    #Requires -RunAsAdministrator
 
     # Do not remove or add to these parameters
     param (
         [String[]] $Target,
         [PSCredential] $Credential
     )
 
-    #Requires -Version 5.1
-    #Requires -PSEdition Desktop
     #Requires -RunAsAdministrator
 
     if ($psISE) {