AsBuiltReport.VMware.vSphere
Repository for AsBuiltReport VMware vSphere module
Install / Use
/learn @AsBuiltReport/AsBuiltReport.VMware.vSphereREADME
VMware vSphere As Built Report
VMware vSphere 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.
The VMware vSphere As Built Report module is used to generate as built documentation for VMware vSphere / vCenter Server environments.
[!TIP] Please refer to the VMware ESXi AsBuiltReport for reporting of standalone VMware ESXi servers.
Please refer to the AsBuiltReport website for more detailed information about this project.
<!-- ## :books: Sample Reports ### Sample Report 1 - Default Style Sample vSphere As Built report with health checks, using default report style. Sample VMware vSphere As Built report HTML file: [Sample VMware vSphere As Built Report.html](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/dev/Samples/Sample%20VMware%20vSphere%20As%20Built%20Report.html) -->:beginner: Getting Started
Below are the instructions on how to install, configure and generate a VMware vSphere As Built report.
:floppy_disk: Supported Versions
The VMware vSphere As Built Report supports the following vSphere versions;
- vSphere 8.0
[!IMPORTANT] Ongoing VMware product and licensing restrictions, combined with limited access to development environments and resources, prevent further development and support of this report module beyond VMware vSphere 8.0.
:no_entry_sign: Unsupported Versions
The following VMware vSphere versions are no longer being tested and/or supported;
- vSphere 5.5
- vSphere 6.0
- vSphere 6.5
- vSphere 6.7
- vSphere 7.0
PowerShell
This report is compatible with the following PowerShell versions;
<!-- ********** Update supported PowerShell versions ********** -->| Windows PowerShell 5.1 | PowerShell 7 | |:----------------------:|:--------------------:| | :x: | :white_check_mark: |
🌐 Language Support
<!-- ********** Update supported languages ********** -->The VMware vSphere As Built Report supports the following languages;
| Language | Culture Code | |----------|--------------| | English (US) | en-US (Default) | | English (GB) | en-GB | | French | fr-FR | | German | de-DE | | Spanish | es-ES |
:wrench: System Requirements
<!-- ********** Update system requirements ********** -->PowerShell 7.4 or higher, and the following PowerShell modules are required for generating a VMware vSphere As Built report.
[!NOTE] Windows PowerShell 5.1 is not supported. Please refer to the VMware PowerCLI Installation Guide for instructions on installing PowerShell 7 and PowerCLI.
Each of these modules can be easily downloaded and installed via the PowerShell Gallery
- VCF PowerCLI Module version 9.0 or higher
- AsBuiltReport.VMware.vSphere Module
:closed_lock_with_key: Required Privileges
<!-- ********** Define required privileges ********** --> <!-- ********** Try to follow best practices to define least privileges ********** -->A VMware vSphere As Built Report can be generated with read-only privileges, however the following sections will be skipped;
- vSphere licensing information
- VM Storage Policy information
- VMware Update Manager / Lifecycle Manager information
For a complete report, the following role assigned privileges are required;
- Global > Licenses
- Global > Settings
- Host > Configuration > Change Settings
- Profile-driven Storage > Profile-driven storage view
- VMware vSphere Update Manager > View Compliance Status
[!NOTE] The vSphere Lifecycle Manager (vLCM) image composition, compliance, and Software Depot sections use the vCenter REST API. The credentials supplied to
New-AsBuiltReportare used to authenticate automatically — no additional configuration is required.
:package: Module Installation
PowerShell
<!-- ********** Add installation for any additional PowerShell module(s) ********** -->Open a PowerShell terminal window and install each of the required modules.
[!NOTE] VCF PowerCLI 9.0 or higher is required. Please ensure older PowerCLI versions have been uninstalled.
# Install
install-module VCF.PowerCLI -MinimumVersion 9.0 -AllowClobber -SkipPublisherCheck
install-module AsBuiltReport.VMware.vSphere
GitHub
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 also.
- Download the code package / latest release zip from GitHub
- Extract the zip file
- Copy the folder
AsBuiltReport.VMware.vSphereto a path that is set in$env:PSModulePath. - Open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name AsBuiltReport.VMware.vSphere -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.
:pencil2: Configuration
The vSphere 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 VMware vSphere report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.vSphere -FolderPath <User specified folder> -Filename <Optional>
Executing this command will copy the default vSphere 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.
<!-- ********** DO NOT CHANGE THE REPORT SCHEMA SETTINGS ********** -->Report
The Report schema provides configuration of the vSphere report information.
| Sub-Schema | Setting | Default | Description | |---------------------|--------------|--------------------------------|--------------------------------------------------------------| | Name | User defined | VMware vSphere As Built Report | The name of the As Built Report | | Version | User defined | 1.0 | The report version | | Status
