System Resources 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.
Below are the instructions on how to install, configure and generate a System Resources As Built report.
The System Resources As Built Report supports the following Resources versions;
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
- English (US) (Default)
- English (GB)
- Arabic (SA)
- Czech (CZ)
- Danish (DK)
- Dutch (NL)
- Finnish (FI)
- French (FR)
- German (DE)
- Greek (GR)
- Hebrew (IL)
- Hindi (HI)
- Hungarian (HU)
- Italian (IT)
- Japanese (JP)
- Korean (KR)
- Norwegian (NO)
- Polish (PL)
- Portuguese (PT)
- Russian (RU)
- Simplified Chinese
- Spanish (ES)
- Swedish (SE)
- Thai (TH)
- Traditional Chinese
- Turkish (TR)
- Vietnamese (VN)
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a System Resources As Built Report.
Important
This report requires AsBuiltReport.Core version 1.5.0 or later to be installed. Multilingual-support
Local user privileges are required to run this report.
Important
The intention of this report is to demonstrate the multi-language capabilities of the AsBuiltReport project. Therefore, this report does not require any special privileges to run.
# Install AsBuiltReport.Core 1.5.0-RC1
Install-Module AsBuiltReport.Core -Repository PSGallery -AllowPrerelease
# Install
install-module AsBuiltReport.System.Resources -Force
# Update
update-module AsBuiltReport.System.Resources -ForceIf 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.System.Resourcesto a path that is set in$env:PSModulePath. - Open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name AsBuiltReport.System.Resources -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.
The System Resources As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
Important
Please remember to generate a new report JSON configuration file after each module update to ensure the report functions correctly.
A System Resources report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report System.Resources -FolderPath <User specified folder> -Filename <Optional>Executing this command will copy the default System Resources 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 System Resources report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | System Resources 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 |
| Language | User defined | en-US | The language / locale of the report |
| 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.
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 |
|---|---|---|
| Date | 1 | 2 |
| TimeZone | 2 | 2 |
| Uptime | 2 | 2 |
| PSHost | 2 | 2 |
| Process | 1 | 2 |
The Healthcheck schema is used to toggle health checks on or off.
No health checks are currently available for this report.
The following examples demonstrate how to generate a System Resources As Built Report.
Below are a few examples of running the AsBuiltReport script. Refer to the README.md file in the main AsBuiltReport project repository for more examples.
# Generate a System Resources As Built Report for 'localhost'. 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 System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -Timestamp
# Generate a System Resources As Built Report for 'localhost' 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 System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -ReportConfigFilePath 'C:\Users\Jon\AsBuiltReport\AsBuiltReport.System.Resources.json' -Verbose
# Generate a System Resources As Built Report for 'localhost' 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 System.Resources -Target localhost -Credential $Creds -Format Html,Text -OutputFolderPath 'C:\Users\Jon\Documents' -EnableHealthCheck
# Generate a System Resources As Built Report for Backup Server localhost 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 System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -SendEmail
# Generate a System Resources As Built Report for 'localhost'. Export report to HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\Jon\Documents' and set the report language to Spanish.
PS C:\> New-AsBuiltReport -Report System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -ReportLanguage es-ES