AsBuiltReport.VMware.ESXi
Repository for AsBuiltReport VMware ESXi module
Install / Use
/learn @AsBuiltReport/AsBuiltReport.VMware.ESXiREADME
VMware ESXi As Built Report
VMware ESXi 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 ESXi As Built Report module is used to generate as built documentation for standalone VMware ESXi servers.
Please refer to the VMware vSphere AsBuiltReport for reporting of VMware vSphere / vCenter Server environments.
Please refer to the AsBuiltReport website for more detailed information about this project.
:beginner: Getting Started
Below are the instructions on how to install, configure and generate a VMware ESXi As Built report.
:floppy_disk: Supported Versions
VMware ESXi
The VMware ESXi As Built Report supports the following ESXi versions;
- ESXi 7.0
- ESXi 8.0
End of Support
The following VMware ESXi versions are no longer being tested and/or supported;
- ESXi 5.5
- ESXi 6.0
- ESXi 6.5
- ESXi 6.7
PowerShell
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 | |:----------------------:|:--------------------:| | :white_check_mark: | :white_check_mark: |
:wrench: System Requirements
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a VMware ESXi As Built report.
:closed_lock_with_key: Required Privileges
A user with root privileges on the ESXi host is required to generate a VMware ESXi As Built Report.
:package: Module Installation
Open a PowerShell terminal window and install each of the required modules.
:warning: VCF PowerCLI 9.0 or higher is required. Please ensure older PowerCLI versions have been uninstalled.
install-module VCF.PowerCLI -MinimumVersion 9.0 -AllowClobber
install-module AsBuiltReport.VMware.ESXi
:pencil2:Configuration
The ESXi As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
An ESXi report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.ESXi -Path <User specified folder> -Name <Optional>
Executing this command will copy the default ESXi 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.
Report
The Report schema provides configuration of the ESXi report information
| Sub-Schema | Setting | Default | Description | |--------------------|------------- | --------------------------- | --------------------------------------------------------------| | Name | User defined | VMware ESXi 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 | | ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers | | ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
Options
The Options schema allows certain options within the report to be toggled on or off
| Sub-Schema | Setting | Default | Description | |--------------------|--------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ShowLicenseKeys | true / false | false | Toggle to mask/unmask ESXi license keys<br><br> Masked License Key<br>*****-*****-*****-56YDM-AS12K<br><br> Unmasked License Key<br>AKLU4-PFG8M-W2D8J-56YDM-AS12K | | ShowVMSnapshots | true / false | true | Toggle to enable/disable reporting of VM snapshots |
InfoLevel
The InfoLevel schema allows configuration of each section of the report at a granular level. The following sections can be set
There are 6 levels (0-5) 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 | | 3 | Detailed | Provides detailed information for individual objects | | 4 | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects (Hosts, Clusters, Datastores, VMs etc) | | 5 | Comprehensive | Provides comprehensive information for individual objects, such as advanced configuration settings |
The table below outlines the default and maximum InfoLevel settings for each section.
| Sub-Schema | Default Setting | Maximum Setting | |------------|:---------------:|:---------------:| | VMHost | 3 | 5 | | Network | 3 | 4 | | Storage | 3 | 4 | | VM | 3 | 4 |
Healthcheck
The Healthcheck schema is used to toggle health checks on or off.
VMHost
The VMHost schema is used to configure health checks for VMHosts.
| Sub-Schema | Setting | Default | Description | Highlight | |-----------------|--------------|---------|--------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------
