Skip to content

Commit 153662c

Browse files
authored
Merge pull request #48 from AsBuiltReport/dev
v0.6.7 public release
2 parents a542f76 + 69baf0f commit 153662c

File tree

122 files changed

+3594
-3177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+3594
-3177
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ body:
7070
attributes:
7171
label: PowerShell Modules
7272
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`
73-
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.NetApp.ONTAP";"PSPKI";"PScriboCharts";"PScribo") | Select Name, Version
73+
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.NetApp.ONTAP";"PScribo") | Select Name, Version
7474
validations:
7575
required: true
7676
- type: textarea

.github/workflows/Release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
publish-to-gallery:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/checkout@v3
11+
- uses: actions/checkout@v4
1212
- name: Set PSRepository to Trusted for PowerShell Gallery
1313
shell: pwsh
1414
run: |
@@ -33,7 +33,7 @@ jobs:
3333
needs: publish-to-gallery
3434
runs-on: ubuntu-latest
3535
steps:
36-
- uses: Eomm/why-don-t-you-tweet@v1
36+
- uses: Eomm/why-don-t-you-tweet@v2
3737
# We don't want to tweet if the repository is not a public one
3838
if: ${{ !github.event.repository.private }}
3939
with:

.github/workflows/codeql.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
#
6+
# https://github.com/microsoft/action-psscriptanalyzer
7+
# For more information on PSScriptAnalyzer in general, see
8+
# https://github.com/PowerShell/PSScriptAnalyzer
9+
10+
name: CodeQL
11+
12+
on:
13+
push:
14+
branches: [ "dev" ]
15+
pull_request:
16+
branches: [ "dev" ]
17+
schedule:
18+
- cron: '20 14 * * 1'
19+
20+
permissions:
21+
contents: read
22+
23+
jobs:
24+
build:
25+
permissions:
26+
contents: read # for actions/checkout to fetch code
27+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
28+
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
29+
name: PSScriptAnalyzer
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
34+
- name: Run PSScriptAnalyzer
35+
uses: microsoft/[email protected]
36+
with:
37+
# Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
38+
# The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
39+
path: .\
40+
recurse: true
41+
# Include your own basic security rules. Removing this option will run all the rules
42+
excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
43+
output: results.sarif
44+
45+
# Upload the SARIF file generated in the previous step
46+
- name: Upload SARIF results file
47+
uses: github/codeql-action/upload-sarif@v3
48+
with:
49+
sarif_file: results.sarif

AsBuiltReport.NetApp.ONTAP.Style.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ if ($ReportConfig.Report.ShowCoverPageImage) {
7979
BlankLine -Count 1
8080
} Catch {
8181
Write-PScriboMessage -IsWarning "Unable to display cover page image. Please set 'ShowCoverPageImage' to 'false' in the report JSON configuration file to avoid this error."
82+
Write-PScriboMessage -IsWarning $_.Exception.Message
8283
}
8384
}
8485

AsBuiltReport.NetApp.ONTAP.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
},
1111
"Options": {
1212
"Exclude": {
13-
"Vserver": []
13+
"Vserver": [],
14+
"MetroCluster": false
1415
}
1516
},
1617
"InfoLevel": {
@@ -54,6 +55,7 @@
5455
"Vserver": {
5556
"Status": true,
5657
"Iscsi": true,
58+
"Nvme": true,
5759
"FCP": true,
5860
"CG": true,
5961
"NFS": true,
@@ -78,6 +80,6 @@
7880
"Security": {
7981
"Users": true,
8082
"KMS": true
83+
}
8184
}
82-
}
83-
}
85+
}

AsBuiltReport.NetApp.ONTAP.psd1

Lines changed: 83 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -8,126 +8,124 @@
88

99
@{
1010

11-
# Script module or binary module file associated with this manifest.
12-
RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
11+
# Script module or binary module file associated with this manifest.
12+
RootModule = 'AsBuiltReport.NetApp.ONTAP.psm1'
1313

14-
# Version number of this module.
15-
ModuleVersion = '0.6.6'
14+
# Version number of this module.
15+
ModuleVersion = '0.6.7'
1616

17-
# Supported PSEditions
18-
# CompatiblePSEditions = @()
17+
# Supported PSEditions
18+
# CompatiblePSEditions = @()
1919

20-
# ID used to uniquely identify this module
21-
GUID = '0ca28a0b-504a-4754-af90-199b59da68f0'
20+
# ID used to uniquely identify this module
21+
GUID = '0ca28a0b-504a-4754-af90-199b59da68f0'
2222

23-
# Author of this module
24-
Author = 'Jonathan Colon Feliciano'
23+
# Author of this module
24+
Author = 'Jonathan Colon Feliciano'
2525

26-
# Company or vendor of this module
27-
#CompanyName = 'Unknown'
26+
# Company or vendor of this module
27+
#CompanyName = 'Unknown'
2828

29-
# Copyright statement for this module
30-
Copyright = '(c) 2023 Jonathan Colon Feliciano. All rights reserved.'
29+
# Copyright statement for this module
30+
Copyright = '(c) 2024 Jonathan Colon Feliciano. All rights reserved.'
3131

32-
# Description of the functionality provided by this module
33-
Description = 'A PowerShell module to generate an as built report on the configuration of NetApp ONTAP.'
32+
# Description of the functionality provided by this module
33+
Description = 'A PowerShell module to generate an as built report on the configuration of NetApp ONTAP.'
3434

35-
# Minimum version of the Windows PowerShell engine required by this module
36-
#PowerShellVersion = '5.1'
35+
# Minimum version of the Windows PowerShell engine required by this module
36+
#PowerShellVersion = '5.1'
3737

38-
# Name of the Windows PowerShell host required by this module
39-
# PowerShellHostName = ''
38+
# Name of the Windows PowerShell host required by this module
39+
# PowerShellHostName = ''
4040

41-
# Minimum version of the Windows PowerShell host required by this module
42-
# PowerShellHostVersion = ''
41+
# Minimum version of the Windows PowerShell host required by this module
42+
# PowerShellHostVersion = ''
4343

44-
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
45-
# DotNetFrameworkVersion = ''
44+
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
45+
# DotNetFrameworkVersion = ''
4646

47-
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
48-
# CLRVersion = ''
47+
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
48+
# CLRVersion = ''
4949

50-
# Processor architecture (None, X86, Amd64) required by this module
51-
# ProcessorArchitecture = ''
50+
# Processor architecture (None, X86, Amd64) required by this module
51+
# ProcessorArchitecture = ''
5252

53-
# Modules that must be imported into the global environment prior to importing this module
54-
RequiredModules = @(
55-
@{
56-
ModuleName = 'AsBuiltReport.Core';
57-
ModuleVersion = '1.3.0'
58-
},
59-
@{
60-
ModuleName = 'NetApp.ONTAP';
61-
ModuleVersion = '9.10.1.2111'
62-
}
63-
)
53+
# Modules that must be imported into the global environment prior to importing this module
54+
RequiredModules = @(
55+
@{
56+
ModuleName = 'AsBuiltReport.Core';
57+
ModuleVersion = '1.4.0'
58+
},
59+
@{
60+
ModuleName = 'NetApp.ONTAP';
61+
ModuleVersion = '9.15.1.2407'
62+
}
63+
)
6464

65-
# Assemblies that must be loaded prior to importing this module
66-
# RequiredAssemblies = @()
65+
# Assemblies that must be loaded prior to importing this module
66+
# RequiredAssemblies = @()
6767

68-
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
69-
# ScriptsToProcess = @()
68+
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
69+
# ScriptsToProcess = @()
7070

71-
# Type files (.ps1xml) to be loaded when importing this module
72-
# TypesToProcess = @()
71+
# Type files (.ps1xml) to be loaded when importing this module
72+
# TypesToProcess = @()
7373

74-
# Format files (.ps1xml) to be loaded when importing this module
75-
# FormatsToProcess = @()
74+
# Format files (.ps1xml) to be loaded when importing this module
75+
# FormatsToProcess = @()
7676

77-
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
78-
# NestedModules = @()
77+
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
78+
# NestedModules = @()
7979

80-
# 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.
81-
FunctionsToExport = @('Invoke-AsBuiltReport.NetApp.ONTAP')
80+
# 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.
81+
FunctionsToExport = @('Invoke-AsBuiltReport.NetApp.ONTAP')
8282

83-
# 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.
84-
#CmdletsToExport = '*'
83+
# 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.
84+
#CmdletsToExport = '*'
8585

86-
# Variables to export from this module
87-
#VariablesToExport = '*'
86+
# Variables to export from this module
87+
#VariablesToExport = '*'
8888

89-
# 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.
90-
#AliasesToExport = '*'
89+
# 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.
90+
#AliasesToExport = '*'
9191

92-
# DSC resources to export from this module
93-
# DscResourcesToExport = @()
92+
# DSC resources to export from this module
93+
# DscResourcesToExport = @()
9494

95-
# List of all modules packaged with this module
96-
# ModuleList = @()
95+
# List of all modules packaged with this module
96+
# ModuleList = @()
9797

98-
# List of all files packaged with this module
99-
# FileList = @()
98+
# List of all files packaged with this module
99+
# FileList = @()
100100

101-
# 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.
102-
PrivateData = @{
101+
# 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.
102+
PrivateData = @{
103103

104-
PSData = @{
104+
PSData = @{
105105

106-
# Tags applied to this module. These help with module discovery in online galleries.
107-
Tags = 'AsBuiltReport', 'Report', 'NetApp', 'ONTAP', 'Documentation', 'PScribo', 'Windows', 'Linux', 'MacOS', 'PSEdition_Desktop', 'PSEdition_Core'
106+
# Tags applied to this module. These help with module discovery in online galleries.
107+
Tags = 'AsBuiltReport', 'Report', 'NetApp', 'ONTAP', 'Documentation', 'PScribo', 'Windows', 'Linux', 'MacOS', 'PSEdition_Desktop', 'PSEdition_Core'
108108

109-
# A URL to the license for this module.
110-
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/LICENSE'
109+
# A URL to the license for this module.
110+
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/LICENSE'
111111

112-
# A URL to the main website for this project.
113-
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP'
112+
# A URL to the main website for this project.
113+
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP'
114114

115-
# A URL to an icon representing this module.
116-
IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
115+
# A URL to an icon representing this module.
116+
IconUri = 'https://github.com/AsBuiltReport.png'
117117

118-
# ReleaseNotes of this module
119-
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/CHANGELOG.md'
118+
# ReleaseNotes of this module
119+
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/CHANGELOG.md'
120120

121-
} # End of PSData hashtable
121+
} # End of PSData hashtable
122122

123-
} # End of PrivateData hashtable
123+
} # End of PrivateData hashtable
124124

125-
# HelpInfo URI of this module
126-
# HelpInfoURI = ''
127-
128-
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
129-
# DefaultCommandPrefix = ''
130-
131-
}
125+
# HelpInfo URI of this module
126+
# HelpInfoURI = ''
132127

128+
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
129+
# DefaultCommandPrefix = ''
133130

131+
}

CHANGELOG.md

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

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.6.7] - 2024-08-09
9+
10+
### Added
11+
12+
- Initial Vserver NVME support
13+
- Added option for MetroCluster volume exclusions (*.mc) @MicKBfr
14+
15+
### Changed
16+
17+
- Update the Eomm/why-don-t-you-tweet action to v2.0.0
18+
- General code cleanup/improvements
19+
- Increased Required Modules version:
20+
- AsBuiltReport.Core v1.4.0
21+
- NetApp.Ontap v9.15.1.2407
22+
23+
### Fixed
24+
25+
- Fix [#40](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/40)
26+
- Fix [#41](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/41)
27+
- Fix [#42](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/42)
28+
- Fix [#43](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/issues/43)
29+
330
## [0.6.6] - 2023-08-07
431

532
### Changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 AsBuiltReport
3+
Copyright (c) 2024 AsBuiltReport
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)