<!-- ********** DO NOT EDIT THESE LINKS ********** --> <p align="center"> <a href="https://www.asbuiltreport.com/" alt="AsBuiltReport"></a> <img src='https://github.com/AsBuiltReport.png' width="8%" height="8%" /></a> </p> <p align="center"> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.VMware.Horizon/" alt="PowerShell Gallery Version"> <img src="https://img.shields.io/powershellgallery/v/AsBuiltReport.VMware.Horizon.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.VMware.Horizon/" alt="PS Gallery Downloads"> <img src="https://img.shields.io/powershellgallery/dt/AsBuiltReport.VMware.Horizon.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.VMware.Horizon/" alt="PS Platform"> <img src="https://img.shields.io/powershellgallery/p/AsBuiltReport.VMware.Horizon.svg" /></a> </p> <p align="center"> <a href="https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon/graphs/commit-activity" alt="GitHub Last Commit"> <img src="https://img.shields.io/github/last-commit/AsBuiltReport/AsBuiltReport.VMware.Horizon/master.svg" /></a> <a href="https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.VMware.Horizon/master/LICENSE" alt="GitHub License"> <img src="https://img.shields.io/github/license/AsBuiltReport/AsBuiltReport.VMware.Horizon.svg" /></a> <a href="https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon/graphs/contributors" alt="GitHub Contributors"> <img src="https://img.shields.io/github/contributors/AsBuiltReport/AsBuiltReport.VMware.Horizon.svg"/></a> </p> <p align="center"> <a href="https://twitter.com/AsBuiltReport" alt="Twitter"> <img src="https://img.shields.io/twitter/follow/AsBuiltReport.svg?style=social"/></a> </p> <!-- ********** DO NOT EDIT THESE LINKS ********** -->

Omnissa Horizon As Built Report

Omnissa Horizon 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.

:books: Sample Reports

Sample Report - Custom Style

Sample Omnissa Horizon As Built report HTML file: Sample VMware Horizon As-Built Report.html

:beginner: Getting Started

Below are the instructions on how to install, configure and generate a Onmissa Horizon As Built report.

:floppy_disk: Supported Versions

The Omnissa Horizon As Built Report supports the following Horizon versions;

• Horizon 8+, 2+**

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 Horizon As Built Report.

• VMware PowerCLI Module version 13.2.0.22643736 or older (VMware removed the "VMware.VimAutomation.HorizonView" in latest versions.)
• AsBuiltReport.VMware.Horizon Module

:closed_lock_with_key: Required Privileges

• A Omnissa Horizon As Built Report can be generated with Administrators(Read only) privileges.

:package: Module Installation

Open a PowerShell terminal window and install each of the required modules.

:warning: VMware PowerCLI 13.2 is required. Please ensure older PowerCLI versions have been uninstalled.

install-module VMware.PowerCLI -MaximumVersion 13.2.0.22643736 -AllowClobber
install-module AsBuiltReport.VMware.Horizon

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.

1. Download the code package / latest release zip from GitHub
2. Extract the zip file
3. Copy the folder AsBuiltReport.VMware.Horizon to a path that is set in $env:PSModulePath.
4. Open a PowerShell terminal window and unblock the downloaded files with

   $path = (Get-Module -Name AsBuiltReport.VMware.Horizon -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1
   

5. 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 Omnissa Horizon As Built Report utilizes a JSON file to allow configuration of report information, options, detail and healthchecks.

A Omnissa Horizon report configuration file can be generated by executing the following command;

New-AsBuiltReportConfig -Report VMware.Horizon -FolderPath <User specified folder> -Filename <Optional>

Executing this command will copy the default Omnissa Horizon 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 Omnissa Horizon report information.

| Sub-Schema | Setting | Default | Description | | ------------------- | ------------ | ------------------------------ | ------------------------------------------------------------ | | Name | User defined | VMware Horizon 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 |

Options

The Options schema allows certain options within the report to be toggled on or off.

<!-- ********** Add/Remove the number of InfoLevels as required ********** -->

InfoLevel

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-3) of detail granularity for each section as follows;

| Setting | InfoLevel | Description | | :-----: | ----------------- | -------------------------------------------------------------------- | | 0 | Disabled | Does not collect or display any information | | 1 | Enabled / Summary | Provides summarized 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 UsersandGroups section.

| Sub-Schema | Default Setting | Maximum Setting | | --------------------- | :-------------: | :-------------: | | Entitlements | 1 | 2 | | HomeSiteAssignments | 1 | 1 | | UnauthenticatedAccess | 1 | 1 |

The table below outlines the default and maximum InfoLevel settings for each Inventory section.

| Sub-Schema | Default Setting | Maximum Setting | | ------------------ | :-------------: | :-------------: | | Desktop | 1 | 3 | | Applications | 1 | 2 | | Farms | 1 | 2 | | Machines | 1 | 1 | | GlobalEntitlements | 1 | 1 |

The table below outlines the default and maximum InfoLevel settings for each Settings section.

| Sub-Schema | Default Setting | Maximum Setting | | -------------------------- | :-------------: | :-------------: | | vCenter | 1 | 2 | | ESXiHosts | 1 | 2 | | DataStores | 1 | 2 | | ADDomains | 1 | 1 | | UAGServers | 1 | 1 | | ConnectionServers |