Merge pull request #11 from AsBuiltReport/dev

v0.6.0 release

Author: tpcarman

AsBuiltReport.NetApp.ONTAP.json

@@ -12,7 +12,7 @@
 
     },
     "InfoLevel": {
-        "_comment_": "0 = Disabled, 1 = Enabled",
+        "_comment_": "0 = Disabled, 1 = Enabled / Summary, 2 = Adv Summary",
         "Cluster": 1,
         "Node": 1,
         "Storage": 1,

AsBuiltReport.NetApp.ONTAP.psd1

@@ -12,7 +12,7 @@
 RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.4.0'
+ModuleVersion = '0.6.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

CHANGELOG.md

@@ -1,9 +1,24 @@
 # :arrows_counterclockwise: NetApp ONTAP Storage As Built Report Changelog
 
-## [0.4.0] - 2021-09-22
+## [0.5.0] - 2021-10-11
 
-- Add aditional halthCheck section support
+### Added
+
+- Added function to convert from empty content to "-".
+
+### Changed
+
+- Changed main report to use per Node/Vserver filtering.
+- Changed Get-NetAppOntapAPI function to allow per Vserver Filtering.
+
+### Fixed
+
+- Fix to better detect unhealthy node.
+- Fix for ASUP Health Check.
+
+## [0.4.0] - 2021-09-22
 
+- Add additional health check section support
 - Added function to convert from True/False to Yes/No
 - Implement a function to convert from T/F to Y/N
 - Use HTTPS to connect to the Array (by Default)

README.md

@@ -33,7 +33,7 @@ For detailed documentation around the whole project, please refer to the `README
 
 ### Sample Report - Custom Style 1
 
-Sample NetApp ONTAP As Built report HTML file: [Sample NetApp As-Built Report.html](https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/Samples/Sample%20NetApp%20As-Built%20Report.html)
+Sample NetApp ONTAP As Built report HTML file: [Sample NetApp As-Built Report.html](https://technomyth.zenprsolutions.net/wp-content/uploads/2021/11/NetApp-ONTAP-As-Built-Report.html)
 
 Sample NetApp ONTAP As Built report with health checks, using custom report style.
 
@@ -105,6 +105,7 @@ Ensure you repeat the following steps for the [system requirements](https://gith
 5. Close and reopen the PowerShell terminal window.
 
 _Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path._
+
 ### :closed_lock_with_key: Required Privileges
 
 To generate a NetApp ONTAP Array report, a user account with the readonly role of higher on the AFF/FAS is required.
@@ -147,23 +148,34 @@ The **Options** schema allows certain options within the report to be toggled on
 
 The **InfoLevel** schema allows configuration of each section of the report at a granular level. The following sections can be set.
 
-There are 2 levels (0-1) of detail granularity for each section as follows;
+There are 3 levels (0-2) of detail granularity for each section as follows;
 
 | Setting | InfoLevel         | Description                                                                                                                                |
 |:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 |    0    | Disabled          | Does not collect or display any information                                                                                                |
-|    1    | Enabled | Provides condensed, detailed information for a collection of objects                                                                                 |
+|    1    | Enabled / Summary | Provides summarised information for a collection of objects                                                                                 |
+|    2    | Adv Summary       | Provides condensed, detailed information for a collection of objects                                                                       |
 
 ### Healthcheck
 
 The **Healthcheck** schema is used to toggle health checks on or off.
 
 ## :computer: Examples
 
-There is one example listed below on running the AsBuiltReport script against a NetApp ONTAP Array target. Refer to the `README.md` file in the main AsBuiltReport project repository for more examples.
-
-- The following creates a NetApp ONTAP Array As-Built report in HTML & Word formats in the folder C:\scripts\.
+There are a few examples listed below on running the AsBuiltReport script against a NetApp ONTAP Array target. Refer to the `README.md` file in the main AsBuiltReport project repository for more examples.
 
 ```powershell
-PS C:\>New-AsBuiltReport -Report NetApp.ONTAP -Target 10.10.30.20 -Credential (Get-Credential) -Format HTML,Word -OutputPath C:\scripts\
+# Generate a NetApp ONTAP As Built Report for Cluster array '192.168.7.60' using specified credentials. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:\Users\Jon\Documents'
+PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Username 'admin' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -Timestamp
+
+# Generate a NetApp ONTAP As Built Report for Cluster array 192.168.7.60 using specified credentials and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\Jon\Documents'. Display verbose messages to the console.
+PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Username 'admin' -Password 'P@ssw0rd' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -ReportConfigFilePath 'C:\Users\Jon\AsBuiltReport\AsBuiltReport.NetApp.ONTAP.json' -Verbose
+
+# Generate a NetApp ONTAP As Built Report for Cluster array 192.168.7.60 using stored credentials. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:\Users\Jon\Documents'.
+PS C:\> $Creds = Get-Credential
+PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Credential $Creds -Format Html,Text -OutputFolderPath 'C:\Users\Jon\Documents' -EnableHealthCheck
+
+# Generate a NetApp ONTAP As Built Report for Cluster array 192.168.7.60 using stored credentials. Export report to HTML & DOCX formats. Use default report style. Reports are saved to the user profile folder by default. Attach and send reports via e-mail.
+PS C:\> New-AsBuiltReport -Report NetApp.ONTAP -Target 192.168.7.60 -Username 'admin' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -SendEmail
+
 ```