Skip to content

Commit e73c82e

Browse files
tpcarmantpcarman
committed
Initial commit
0 parents  commit e73c82e

File tree

1 file changed

+111
-0
lines changed

1 file changed

+111
-0
lines changed

‎README.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<p align="center">
2+
<a href="https://www.asbuiltreport.com/" alt="AsBuiltReport"></a>
3+
<img src='https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png' width="8%" height="8%" /></a>
4+
</p>
5+
<p align="center">
6+
<a href="https://www.powershellgallery.com/packages/AsBuiltReport.NetApp.ONTAP/" alt="PowerShell Gallery Version">
7+
<img src="https://img.shields.io/powershellgallery/v/AsBuiltReport.NetApp.ONTAP.svg" /></a>
8+
<a href="https://www.powershellgallery.com/packages/AsBuiltReport.NetApp.ONTAP/" alt="PS Gallery Downloads">
9+
<img src="https://img.shields.io/powershellgallery/dt/AsBuiltReport.NetApp.ONTAP.svg" /></a>
10+
<a href="https://www.powershellgallery.com/packages/AsBuiltReport.NetApp.ONTAP/" alt="PS Platform">
11+
<img src="https://img.shields.io/powershellgallery/p/AsBuiltReport.NetApp.ONTAP.svg" /></a>
12+
</p>
13+
<p align="center">
14+
<a href="https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/graphs/commit-activity" alt="GitHub Last Commit">
15+
<img src="https://img.shields.io/github/last-commit/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master.svg" /></a>
16+
<a href="https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/master/LICENSE" alt="GitHub License">
17+
<img src="https://img.shields.io/github/license/AsBuiltReport/AsBuiltReport.NetApp.ONTAP.svg" /></a>
18+
<a href="https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/graphs/contributors" alt="GitHub Contributors">
19+
<img src="https://img.shields.io/github/contributors/AsBuiltReport/AsBuiltReport.NetApp.ONTAP.svg"/></a>
20+
</p>
21+
<p align="center">
22+
<a href="https://twitter.com/AsBuiltReport" alt="Twitter">
23+
<img src="https://img.shields.io/twitter/follow/AsBuiltReport.svg?style=social"/></a>
24+
</p>
25+
26+
# NetApp ONTAP As Built Report
27+
28+
# :beginner: Getting Started
29+
30+
## :floppy_disk: Supported Versions
31+
32+
33+
## :wrench: System Requirements
34+
35+
36+
### :closed_lock_with_key: Required Privileges
37+
38+
39+
## :package: Module Installation
40+
41+
### PowerShell
42+
43+
```powershell
44+
install-module AsBuiltReport.NetApp.ONTAP
45+
```
46+
47+
### GitHub
48+
If 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](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP#wrench-system-requirements) also.
49+
50+
1. Download the code package / [latest release](https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP/releases/latest) zip from GitHub
51+
2. Extract the zip file
52+
3. Copy the folder `AsBuiltReport.NetApp.ONTAP` to a path that is set in `$env:PSModulePath`.
53+
4. Open a PowerShell terminal window and unblock the downloaded files with
54+
```powershell
55+
$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
56+
```
57+
5. Close and reopen the PowerShell terminal window.
58+
59+
_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._
60+
61+
## :pencil2: Configuration
62+
63+
The NetApp ONTAP As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
64+
65+
A NetApp ONTAP report configuration file can be generated by executing the following command;
66+
```powershell
67+
New-AsBuiltReportConfig -Report AsBuiltReport.NetApp.ONTAP -FolderPath <User specified folder> -Filename <Optional>
68+
```
69+
70+
Executing this command will copy the default NetApp ONTAP report JSON configuration to a user specified folder.
71+
72+
All report settings can then be configured via the JSON file.
73+
74+
The following provides information of how to configure each schema within the report's JSON file.
75+
76+
### Report
77+
The **Report** schema provides configuration of the NetApp ONTAP report information.
78+
79+
| Sub-Schema | Setting | Default | Description |
80+
|---------------------|--------------|--------------------------------|--------------------------------------------------------------|
81+
| Name | User defined | NetApp ONTAP As Built Report | The name of the As Built Report |
82+
| Version | User defined | 1.0 | The report version |
83+
| Status | User defined | Released | The report release status |
84+
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
85+
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
86+
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
87+
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
88+
89+
### Options
90+
The **Options** schema allows certain options within the report to be toggled on or off.
91+
92+
### InfoLevel
93+
The **InfoLevel** schema allows configuration of each section of the report at a granular level. The following sections can be set.
94+
95+
There are 6 levels (0-5) of detail granularity for each section as follows;
96+
97+
| Setting | InfoLevel | Description |
98+
|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
99+
| 0 | Disabled | Does not collect or display any information |
100+
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
101+
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
102+
| 3 | Detailed | Provides detailed information for individual objects |
103+
| 4 | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects |
104+
| 5 | Comprehensive | Provides comprehensive information for individual objects, such as advanced configuration settings |
105+
106+
### Healthcheck
107+
The **Healthcheck** schema is used to toggle health checks on or off.
108+
109+
## :computer: Examples
110+
111+

0 commit comments

Comments
 (0)