Skip to content

Commit c6d60db

Browse files
rebelinuxrebelinux
authored
Merge pull request #19 from rebelinux/dev
Migrate Sample Report URL to htmlpreview.github.io
2 parents 9293563 + 3b038a2 commit c6d60db

9 files changed

+29
-14
lines changed

‎AsBuiltReport.NetApp.ONTAP.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
"ShowTableCaptions": true
1010
},
1111
"Options": {
12-
12+
"Exclude": {
13+
"Vserver": []
14+
}
1315
},
1416
"InfoLevel": {
1517
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary",

‎AsBuiltReport.NetApp.ONTAP.psd1‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.6.3'
15+
ModuleVersion = '0.6.4'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -54,11 +54,11 @@ Description = 'A PowerShell module to generate an as built report on the configu
5454
RequiredModules = @(
5555
@{
5656
ModuleName = 'AsBuiltReport.Core';
57-
ModuleVersion = '1.1.0'
57+
ModuleVersion = '1.2.0'
5858
},
5959
@{
6060
ModuleName = 'NetApp.ONTAP';
61-
ModuleVersion = '9.9.1'
61+
ModuleVersion = '9.10.1.2111'
6262
}
6363
)
6464

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# :arrows_counterclockwise: NetApp ONTAP Storage As Built Report Changelog
22

3+
## [0.6.4] - 2022-05-xx
4+
5+
### Changed
6+
7+
- Implemented Vserver filtering.
8+
39
## [0.6.3] - 2022-01-31
410

511
### Changed

‎README.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for m
3535

3636
### Sample Report - Custom Style 1
3737

38-
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)
38+
Sample NetApp ONTAP As Built report HTML file: [Sample NetApp As-Built Report.html](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/dev/Samples/Sample%20NetApp%20As-Built%20Report.html)
3939

4040
# :beginner: Getting Started
4141

@@ -66,8 +66,8 @@ These modules may also be manually installed.
6666
| Module Name | Minimum Required Version | PS Gallery | GitHub |
6767
|--------------------|:------------------------:|:---------------------------------------------------------------------:|:---------------------------------------------------------------------------:|
6868
| PScribo | 0.9.1 | [Link](https://www.powershellgallery.com/packages/PScribo) | [Link](https://github.com/iainbrighton/PScribo/tree/master) |
69-
| AsBuiltReport.Core | 1.1.0 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Core) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Core/releases/latest) |
70-
| Netapp.ONTAP | 9.9.1 | [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP) | |
69+
| AsBuiltReport.Core | 1.2.0 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Core) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Core/releases/latest) |
70+
| Netapp.ONTAP | 9.10.1.2111 | [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP) | |
7171

7272
### Linux & macOS
7373

@@ -84,7 +84,7 @@ These modules may also be manually installed.
8484
Open a PowerShell terminal window and install each of the required modules as follows;
8585

8686
```powershell
87-
Install-Module AsBuiltReport.NetApp.ONTAP
87+
Install-Module -Name AsBuiltReport.NetApp.ONTAP
8888
```
8989

9090
### GitHub
@@ -141,6 +141,9 @@ The **Report** schema provides configuration of the NetApp ONTAP report informat
141141
### Options
142142

143143
The **Options** schema allows certain options within the report to be toggled on or off.
144+
| Sub-Schema | Setting | Default | Description |
145+
|-----------------|--------------|---------|-----------------------------------------------------------------|
146+
| Exclude: Vserver | Array List | Empty | Allow to filter on Vserver Name
144147

145148
### InfoLevel
146149

@@ -151,7 +154,7 @@ There are 3 levels (0-2) of detail granularity for each section as follows;
151154
| Setting | InfoLevel | Description |
152155
|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
153156
| 0 | Disabled | Does not collect or display any information |
154-
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
157+
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
155158
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
156159

157160
The table below outlines the default and maximum **InfoLevel** settings for each section.

‎Samples/Sample_NetApp_Report_1.png‎

-169 KB
Binary file not shown.

‎Samples/Sample_NetApp_Report_2.png‎

-173 KB
Binary file not shown.

‎Samples/Sample_NetApp_Report_3.png‎

-206 KB
Binary file not shown.

‎Samples/Sample_NetApp_Report_4.png‎

-248 KB
Binary file not shown.

‎Src/Public/Invoke-AsBuiltReport.NetApp.ONTAP.ps1‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
55
.DESCRIPTION
66
Documents the configuration of NetApp ONTAP in Word/HTML/Text formats using PScribo.
77
.NOTES
8-
Version: 0.6.3
8+
Version: 0.6.4
99
Author: Jonathan Colon Feliciano
1010
Twitter: @jcolonfzenpr
1111
Github: rebelinux
@@ -21,6 +21,10 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
2121
[PSCredential] $Credential
2222
)
2323

24+
Write-PScriboMessage -IsWarning "Please refer to the AsBuiltReport.NetApp.ONTAP github website for more detailed information about this project."
25+
Write-PScriboMessage -IsWarning "Documentation: https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP"
26+
Write-PScriboMessage -IsWarning "Issues or bug reporting: https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues"
27+
2428
# Import Report Configuration
2529
$Report = $ReportConfig.Report
2630
$InfoLevel = $ReportConfig.InfoLevel
@@ -230,7 +234,7 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
230234
Get-AbrOntapNetworkSubnet
231235
}
232236
}
233-
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -ne "node" -and $_.VserverType -ne "system" } | Select-Object -ExpandProperty Vserver
237+
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -ne "node" -and $_.VserverType -ne "system" -and $_.Vserver -notin $Options.Exclude.Vserver} | Select-Object -ExpandProperty Vserver
234238
foreach ($SVM in $Vservers) {
235239
if (Get-NcNetRoute -VserverContext $SVM -Controller $Array) {
236240
Section -Style Heading4 "$SVM Vserver Routes" {
@@ -263,7 +267,7 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
263267
Section -Style Heading2 'Vserver Information' {
264268
Paragraph "The following section provides a summary of the vserver information on $($ClusterInfo.ClusterName)."
265269
BlankLine
266-
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" } | Select-Object -ExpandProperty Vserver
270+
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" -and $_.Vserver -notin $Options.Exclude.Vserver} | Select-Object -ExpandProperty Vserver
267271
foreach ($SVM in $Vservers) {
268272
Section -Style Heading3 "$SVM Vserver Configuration" {
269273
Paragraph "The following section provides the configuration of the vserver $($SVM)."
@@ -519,7 +523,7 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
519523
#---------------------------------------------------------------------------------------------#
520524
Write-PScriboMessage "Efficiency InfoLevel set at $($InfoLevel.Efficiency)."
521525
if ($InfoLevel.Efficiency -gt 0) {
522-
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" } | Select-Object -ExpandProperty Vserver
526+
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" -and $_.Vserver -notin $Options.Exclude.Vserver} | Select-Object -ExpandProperty Vserver
523527
if (Get-NcAggrEfficiency -Controller $Array) {
524528
Section -Style Heading2 'Efficiency Information' {
525529
Paragraph "The following section provides the Storage Efficiency Saving information on $($ClusterInfo.ClusterName)."
@@ -555,7 +559,7 @@ function Invoke-AsBuiltReport.NetApp.ONTAP {
555559
#---------------------------------------------------------------------------------------------#
556560
Write-PScriboMessage "Security InfoLevel set at $($InfoLevel.Security)."
557561
if ($InfoLevel.Security -gt 0) {
558-
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" } | Select-Object -ExpandProperty Vserver
562+
$Vservers = Get-NcVserver -Controller $Array | Where-Object { $_.VserverType -eq "data" -and $_.Vserver -notin $Options.Exclude.Vserver} | Select-Object -ExpandProperty Vserver
559563
Section -Style Heading2 'Security Information' {
560564
Paragraph "The following section provides the Security related information on $($ClusterInfo.ClusterName)."
561565
BlankLine

0 commit comments

Comments
 (0)