<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.Nutanix.PrismElement/" alt="PowerShell Gallery Version"> <img src="https://img.shields.io/powershellgallery/v/AsBuiltReport.Nutanix.PrismElement.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.Nutanix.PrismElement/" alt="PS Gallery Downloads"> <img src="https://img.shields.io/powershellgallery/dt/AsBuiltReport.Nutanix.PrismElement.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.Nutanix.PrismElement/" alt="PS Platform"> <img src="https://img.shields.io/powershellgallery/p/AsBuiltReport.Nutanix.PrismElement.svg" /></a> </p> <p align="center"> <a href="https://github.com/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement/graphs/commit-activity" alt="GitHub Last Commit"> <img src="https://img.shields.io/github/last-commit/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement/master.svg" /></a> <a href="https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement/master/LICENSE" alt="GitHub License"> <img src="https://img.shields.io/github/license/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement.svg" /></a> <a href="https://github.com/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement/graphs/contributors" alt="GitHub Contributors"> <img src="https://img.shields.io/github/contributors/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement.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> <p align="center"> <a href='https://ko-fi.com/B0B7DDGZ7' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> </p>

Nutanix Prism Element As Built Report

:books: Sample Reports

Sample Report - Default Style

Sample Nutanix Prism Element As Built Report with health checks, using default report style.

Sample Nutanix Prism Element As Built Report HTML file: Sample Nutanix Prism Element As Built Report.html

:beginner: Getting Started

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

:floppy_disk: Supported Versions

Prism / AOS

The Nutanix Prism Element As Built Report supports the following AOS versions;

• AOS 5.x
• AOS 6.x

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

Each of the following modules will be automatically installed by following the module installation procedure.

These modules may also be manually installed.

| Module Name | Minimum Required Version | PS Gallery | GitHub | | ------------------ | :----------------------: | :-------------------------------------------------------------------: | :-------------------------------------------------------------------------: | | PScribo | 0.11.1 | Link | Link | | AsBuiltReport.Core | 1.4.3 | Link | Link |

:closed_lock_with_key: Required Privileges

A user with Prism Cluster Admin privileges is required to generate a Nutanix Prism Element As Built Report.

:package: Module Installation

PowerShell

Open a PowerShell terminal window and install the required modules as follows;

install-module -Name AsBuiltReport.Nutanix.PrismElement

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 latest release zip from GitHub
2. Extract the zip file
3. Copy the folder AsBuiltReport.Nutanix.PrismElement to a path that is set in $env:PSModulePath. By default this could be C:\Program Files\WindowsPowerShell\Modules or C:\Users\<user>\Documents\WindowsPowerShell\Modules
4. Open a PowerShell terminal window and unblock the downloaded files with

   $path = (Get-Module -Name AsBuiltReport.Nutanix.PrismElement -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 Nutanix Prism As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.

A Nutanix Prism report configuration file can be generated by executing the following command;

New-AsBuiltReportConfig -Report Nutanix.PrismElement -FolderPath <User specified folder> -Filename <Optional>

Executing this command will copy the default Nutanix Prism report configuration file to a user specified folder.

All report settings can then be configured via the report configuration file.

The following provides information of how to configure each schema within the report's configuration file.

Report

The Report schema provides configuration of the Nutanix Prism report information

| Sub-Schema | Setting | Default | Description | | ------------------ | ------------ | ------------------------------------- | ------------------------------------------------------------ | | Name | User defined | Nutanix Prism Element 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.

There are currently no options defined for this report.

InfoLevel

The InfoLevel schema allows configuration of each section of the report at a granular level.

There are 4 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 summarised information for a collection of objects | | 2 | Detailed | Provides detailed information for a collection of objects | | 3 | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects (Disks, VM Disks, VM NICs etc) | | 4 | Comprehensive | Provides comprehensive information for individual objects |

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

| Sub-Schema | Default Setting | Maximum Setting | | -------------- | :-------------: | :-------------: | | Cluster | 1 | 1 | | System | 2 | 4 | | Hosts | 2 | 3 | | Storage | 2 | 3 | | VM | 2 | 3 | | DataProtection | 2 | 3