NetApp ONTAP As Built Report is a PowerShell module which works in conjunction with AsBuiltReport.Core.
AsBuiltReport is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
Please refer to the AsBuiltReport website for more detailed information about this project.
Sample NetApp ONTAP As Built report HTML file: Sample NetApp As-Built Report.html
Below are the instructions on how to install, configure and generate a NetApp ONTAP As Built Report
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
This report is compatible with the following PowerShell versions;
| PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
Each of the following modules will be automatically installed by following the module installation procedure.
These modules may also be manually installed.
| Module Name | Minimum Required Version | PS Gallery | GitHub |
|---|---|---|---|
| PScribo | 0.10.0 | Link | Link |
| AsBuiltReport.Core | 1.4.0 | Link | Link |
| Netapp.ONTAP | 9.15.1.2407 | Link |
Open a PowerShell terminal window and install each of the required modules as follows;
Install-Module -Name AsBuiltReport.NetApp.ONTAPIf you are unable to use the PowerShell Gallery, you can still install the module manually. Ensure you repeat the following steps for the system requirements also.
-
Download the code package / latest release zip from GitHub
-
Extract the zip file
-
Copy the folder
AsBuiltReport.NetApp.ONTAPto a path that is set in$env:PSModulePath. -
Open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name AsBuiltReport.NetApp.ONTAP -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1
-
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.
To generate a NetApp ONTAP Array report, a user account with the readonly role of higher on the AFF/FAS is required.
The NetApp ONTAP Array As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A NetApp ONTAP Array report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report NetApp.ONTAP -FolderPath <User specified folder> -FileName <Optional>Executing this command will copy the default ONTAP report JSON configuration to a user specified folder.
All report settings can then be configured via the JSON file.
The following provides information of how to configure each schema within the report's JSON file.
The Report schema provides configuration of the NetApp ONTAP report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | NetApp ONTAP As Built Report | The name of the As Built Report |
| Version | User defined | 1.0 | The report version |
| Status | User defined | Released | The report release status |
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
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 |
The InfoLevel schema allows configuration of each section of the report at a granular level. The following sections can be set.
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 / Summary | Provides summarised information for a collection of objects |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
The table below outlines the default and maximum InfoLevel settings for each section.
| Sub-Schema | Default Setting | Maximum Setting |
|---|---|---|
| Cluster | 1 | 2 |
| Node | 1 | 2 |
| Storage | 1 | 2 |
| Network | 1 | 2 |
| License | 1 | 2 |
| Vserver | 1 | 2 |
| Efficiency | 1 | 2 |
| Security | 1 | 2 |
| System | 1 | 2 |
| Replication | 1 | 2 |
The Healthcheck schema is used to toggle health checks on or off.
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.
# 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