Merge pull request #48 from AsBuiltReport/dev

v0.6.7 public release
AsBuiltReport · Aug 9, 2024 · 153662c · 153662c
2 parents a542f76 + 69baf0f
commit 153662c
Show file tree

Hide file tree

Showing 122 changed files with 3,594 additions and 3,177 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -70,7 +70,7 @@ body:
     attributes:
       label: PowerShell Modules
       description: Please provide information about the PowerShell modules are you using. Please provide the output from the following PowerShell command `Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.NetApp.ONTAP";"PSPKI";"PScriboCharts";"PScribo") | Select Name, Version`
-      placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.NetApp.ONTAP";"PSPKI";"PScriboCharts";"PScribo") | Select Name, Version
+      placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.NetApp.ONTAP";"PScribo") | Select Name, Version
     validations:
       required: true
   - type: textarea

diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -8,7 +8,7 @@ jobs:
   publish-to-gallery:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |
@@ -33,7 +33,7 @@ jobs:
     needs: publish-to-gallery
     runs-on: ubuntu-latest
     steps:
-      - uses: Eomm/why-don-t-you-tweet@v1
+      - uses: Eomm/why-don-t-you-tweet@v2
         # We don't want to tweet if the repository is not a public one
         if: ${{ !github.event.repository.private }}
         with:

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,49 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+#
+# https://github.com/microsoft/action-psscriptanalyzer
+# For more information on PSScriptAnalyzer in general, see
+# https://github.com/PowerShell/PSScriptAnalyzer
+
+name: CodeQL
+
+on:
+  push:
+    branches: [ "dev" ]
+  pull_request:
+    branches: [ "dev" ]
+  schedule:
+    - cron: '20 14 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: PSScriptAnalyzer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run PSScriptAnalyzer
+        uses: microsoft/[email protected]
+        with:
+          # Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
+          # The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
+          path: .\
+          recurse: true
+          # Include your own basic security rules. Removing this option will run all the rules
+          excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
+          output: results.sarif
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif
diff --git a/AsBuiltReport.NetApp.ONTAP.Style.ps1 b/AsBuiltReport.NetApp.ONTAP.Style.ps1
@@ -79,6 +79,7 @@ if ($ReportConfig.Report.ShowCoverPageImage) {
         BlankLine -Count 1
     } Catch {
         Write-PScriboMessage -IsWarning "Unable to display cover page image. Please set 'ShowCoverPageImage' to 'false' in the report JSON configuration file to avoid this error."
+        Write-PScriboMessage -IsWarning $_.Exception.Message
     }
 }
 

diff --git a/AsBuiltReport.NetApp.ONTAP.json b/AsBuiltReport.NetApp.ONTAP.json
@@ -10,7 +10,8 @@
     },
     "Options": {
         "Exclude": {
-            "Vserver": []
+            "Vserver": [],
+            "MetroCluster": false
         }
     },
     "InfoLevel": {
@@ -54,6 +55,7 @@
         "Vserver": {
             "Status": true,
             "Iscsi": true,
+            "Nvme": true,
             "FCP": true,
             "CG": true,
             "NFS": true,
@@ -78,6 +80,6 @@
         "Security": {
             "Users": true,
             "KMS": true
+        }
     }
-    }
-}
+}
diff --git a/AsBuiltReport.NetApp.ONTAP.psd1 b/AsBuiltReport.NetApp.ONTAP.psd1
@@ -8,126 +8,124 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
+    # Script module or binary module file associated with this manifest.
+    RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
 
-# Version number of this module.
-ModuleVersion = '0.6.6'
+    # Version number of this module.
+    ModuleVersion = '0.6.7'
 
-# Supported PSEditions
-# CompatiblePSEditions = @()
+    # Supported PSEditions
+    # CompatiblePSEditions = @()
 
-# ID used to uniquely identify this module
-GUID = '0ca28a0b-504a-4754-af90-199b59da68f0'
+    # ID used to uniquely identify this module
+    GUID = '0ca28a0b-504a-4754-af90-199b59da68f0'
 
-# Author of this module
-Author = 'Jonathan Colon Feliciano'
+    # Author of this module
+    Author = 'Jonathan Colon Feliciano'
 
-# Company or vendor of this module
-#CompanyName = 'Unknown'
+    # Company or vendor of this module
+    #CompanyName = 'Unknown'
 
-# Copyright statement for this module
-Copyright = '(c) 2023 Jonathan Colon Feliciano. All rights reserved.'
+    # Copyright statement for this module
+    Copyright = '(c) 2024 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.'
+    # Description of the functionality provided by this module
+    Description = 'A PowerShell module to generate an as built report on the configuration of NetApp ONTAP.'
 
-# Minimum version of the Windows PowerShell engine required by this module
-#PowerShellVersion = '5.1'
+    # Minimum version of the Windows PowerShell engine required by this module
+    #PowerShellVersion = '5.1'
 
-# Name of the Windows PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the Windows PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the Windows PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the Windows PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# CLRVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # CLRVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @(
-    @{
-        ModuleName = 'AsBuiltReport.Core';
-        ModuleVersion = '1.3.0'
-    },
-    @{
-        ModuleName = 'NetApp.ONTAP';
-        ModuleVersion = '9.10.1.2111'
-    }
-)
+    # Modules that must be imported into the global environment prior to importing this module
+    RequiredModules = @(
+        @{
+            ModuleName = 'AsBuiltReport.Core';
+            ModuleVersion = '1.4.0'
+        },
+        @{
+            ModuleName = 'NetApp.ONTAP';
+            ModuleVersion = '9.15.1.2407'
+        }
+    )
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-# NestedModules = @()
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    # NestedModules = @()
 
-# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = @('Invoke-AsBuiltReport.NetApp.ONTAP')
+    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+    FunctionsToExport = @('Invoke-AsBuiltReport.NetApp.ONTAP')
 
-# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-#CmdletsToExport = '*'
+    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+    #CmdletsToExport = '*'
 
-# Variables to export from this module
-#VariablesToExport = '*'
+    # Variables to export from this module
+    #VariablesToExport = '*'
 
-# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-#AliasesToExport = '*'
+    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+    #AliasesToExport = '*'
 
-# DSC resources to export from this module
-# DscResourcesToExport = @()
+    # DSC resources to export from this module
+    # DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-# ModuleList = @()
+    # List of all modules packaged with this module
+    # ModuleList = @()
 
-# List of all files packaged with this module
-# FileList = @()
+    # List of all files packaged with this module
+    # FileList = @()
 
-# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-PrivateData = @{
+    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+    PrivateData = @{
 
-    PSData = @{
+        PSData = @{
 
-        # Tags applied to this module. These help with module discovery in online galleries.
-        Tags = 'AsBuiltReport', 'Report', 'NetApp', 'ONTAP', 'Documentation', 'PScribo', 'Windows', 'Linux', 'MacOS', 'PSEdition_Desktop', 'PSEdition_Core'
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags = 'AsBuiltReport', 'Report', 'NetApp', 'ONTAP', 'Documentation', 'PScribo', 'Windows', 'Linux', 'MacOS', 'PSEdition_Desktop', 'PSEdition_Core'
 
-        # A URL to the license for this module.
-        LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/LICENSE'
+            # A URL to the license for this module.
+            LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/LICENSE'
 
-        # A URL to the main website for this project.
-        ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP'
+            # A URL to the main website for this project.
+            ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP'
 
-        # A URL to an icon representing this module.
-        IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
+            # A URL to an icon representing this module.
+            IconUri = 'https://github.com/AsBuiltReport.png'
 
-        # ReleaseNotes of this module
-        ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/CHANGELOG.md'
+            # ReleaseNotes of this module
+            ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/CHANGELOG.md'
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
-} # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfo URI of this module
-# HelpInfoURI = ''
-
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
-
-}
+    # HelpInfo URI of this module
+    # HelpInfoURI = ''
 
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,32 @@
 # :arrows_counterclockwise: NetApp ONTAP Storage As Built Report Changelog
 
+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.7] - 2024-08-09
+
+### Added
+
+- Initial Vserver NVME support
+- Added option for MetroCluster volume exclusions (*.mc) @MicKBfr
+
+### Changed
+
+- Update the Eomm/why-don-t-you-tweet action to v2.0.0
+- General code cleanup/improvements
+- Increased Required Modules version:
+  - AsBuiltReport.Core v1.4.0
+  - NetApp.Ontap v9.15.1.2407
+
+### Fixed
+
+- Fix [#40](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/40)
+- Fix [#41](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/41)
+- Fix [#42](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/42)
+- Fix [#43](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/43)
+
 ## [0.6.6] - 2023-08-07
 
 ### Changed

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 AsBuiltReport
+Copyright (c) 2024 AsBuiltReport
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal