VMware UAG 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 VMware UAG As Built report PDF file: Sample VMware UAG As Built Report.pdf
Below are the instructions on how to install, configure and generate a VMware UAG As Built report.
The VMware UAG As Built Report supports the following UAG versions;
- Should work on version on all UAGs
- Has been tested on all 230# Builds
The Endpoint Compliance Check Provider Settings does not report. If you have it setup and want to share, please open a bug, and we can get this working.
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a VMware UAG As Built Report.
- To generate a VMware UAG report, a user account with the Admin role or higher on the UAG is required. (Required Admin rights to use the UAG APIs)
install-module AsBuiltReport.VMware.UAGIf 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.UAGto 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.UAG -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 VMware UAG As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A VMware UAG report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report VMware.UAG -FolderPath <User specified folder> -Filename <Optional>Executing this command will copy the default VMware UAG 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 VMware UAG report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | VMware UAG 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.
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 |
|---|---|---|
| EdgeServices | 1 | 1 |
| AuthenticationSettings | 1 | 1 |
| AdvancedSettings | 1 | 1 |
| IdentityBridgeingSettings | 1 | 1 |
| SupportSettings | 1 | 1 |
The Healthcheck schema is used to toggle health checks on or off.
Health checks are yet to be developed.
server# Generate a As Built Report for UAG Manager Server 'server-uag-01.corp.local' 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 VMware.UAG -Target 'server-uag-01.corp.local' -Username 'admin' -Password 'VMware1!' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -Timestamp
# Generate a As Built Report for UAG Manager Server 'server-uag-01.corp.local' 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 VMware.UAG -Target 'server-uag-01.corp.local' -Username 'admin' -Password 'VMware1!' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -ReportConfigFilePath 'C:\Users\Jon\AsBuiltReport\AsBuiltReport.VMware.UAG.json' -Verbose
# Generate a As Built Report for UAG Manager Server 'server-uag-01.corp.local' 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 VMware.UAG -Target 'server-uag-01.corp.local' -Credential $Creds -Format Html,Text -OutputFolderPath 'C:\Users\Jon\Documents' -EnableHealthCheck
# Generate a single As Built Report for UAG Manager Servers 'server-uag-01.corp.local' and 'server-uag-02.corp.local' using specified credentials. Report exports to WORD format by default. Apply custom style to the report. Reports are saved to the user profile folder by default.
PS C:\> New-AsBuiltReport -Report VMware.UAG -Target 'server-uag-01.corp.local','server-uag-02.corp.local' -Username 'admin' -Password 'VMware1!' -StyleFilePath 'C:\Scripts\Styles\MyCustomStyle.ps1'
# Generate a As Built Report for UAG Manager Server 'server-uag-01.corp.local' using specified 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 VMware.UAG -Target 'server-uag-01.corp.local' -Username 'admin' -Password 'VMware1!' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -SendEmail