<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.DellEMC.VxRail/" alt="PowerShell Gallery Version"> <img src="https://img.shields.io/powershellgallery/v/AsBuiltReport.DellEMC.VxRail.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.DellEMC.VxRail/" alt="PS Gallery Downloads"> <img src="https://img.shields.io/powershellgallery/dt/AsBuiltReport.DellEMC.VxRail.svg" /></a> <a href="https://www.powershellgallery.com/packages/AsBuiltReport.DellEMC.VxRail/" alt="PS Platform"> <img src="https://img.shields.io/powershellgallery/p/AsBuiltReport.DellEMC.VxRail.svg" /></a> </p> <p align="center"> <a href="https://github.com/AsBuiltReport/AsBuiltReport.DellEMC.VxRail/graphs/commit-activity" alt="GitHub Last Commit"> <img src="https://img.shields.io/github/last-commit/AsBuiltReport/AsBuiltReport.DellEMC.VxRail/master.svg" /></a> <a href="https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.DellEMC.VxRail/master/LICENSE" alt="GitHub License"> <img src="https://img.shields.io/github/license/AsBuiltReport/AsBuiltReport.DellEMC.VxRail.svg" /></a> <a href="https://github.com/AsBuiltReport/AsBuiltReport.DellEMC.VxRail/graphs/contributors" alt="GitHub Contributors"> <img src="https://img.shields.io/github/contributors/AsBuiltReport/AsBuiltReport.DellEMC.VxRail.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>

Dell EMC VxRail As Built Report

Dell EMC VxRail 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 Dell EMC VxRail As Built Report module is used to generate as built documentation for Dell EMC VxRail hyperconverged infrastructure.

<!-- ## :books: Sample Reports ### Sample Report - Default Style Sample Dell EMC VxRail As Built Report with health checks, using default report style.  -->

:beginner: Getting Started

Below are the instructions on how to install, configure and generate a Dell EMC VxRail As Built Report.

:floppy_disk: Supported Versions

• VxRail 7.x
• VxRail 8.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

PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a Dell EMC VxRail As Built report.

Install the following modules by following the module installation procedure.

• VMware PowerCLI Module
• AsBuiltReport.DellEMC.VxRail Module

:closed_lock_with_key: Required Privileges

• A VMware vSphere user account with administrator privileges is required to generate a Dell EMC VxRail As Built Report.

:package: Module Installation

PowerShell

Open a PowerShell terminal window and install the required module.

:warning: VMware PowerCLI 13.0 or higher is required. Please ensure older PowerCLI versions have been uninstalled.

install-module VMware.PowerCLI -MinimumVersion 13.0 -AllowClobber
install-module AsBuiltReport.DellEMC.VxRail

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.DellEMC.VxRail 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.DellEMC.VxRail -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 Dell EMC VxRail As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.

A Dell EMC VxRail report configuration file can be generated by executing the following command;

New-AsBuiltReportConfig -Report DellEMC.VxRail -FolderPath <User specified folder> -Filename <Optional>

Executing this command will copy the default Dell EMC VxRail 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 VxRail Manager report information

| Sub-Schema | Setting | Default | Description | |---------------------|--------------|-----------------------------|--------------------------------------------------------------| | Name | User defined | Dell VxRail 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.

Filter

The Filter schema allows report content to be filtered to specific VxRail cluster within a tenant.

| Sub-Schema | Setting | Default | Description | |--------------|--------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | VxRailCluster | User defined | * | Filters report content to specific VxRail cluster names. <br>Specifying an asterisk (*) will generate a report for all VxRail clusters managed by the VxRail Manager. |

Example 1: Generate a report for all VxRail clusters managed by VxRail Manager.

"Filter": {
    "VxRailCluster": ["*"]
},

Example 2: Filter report content to specific VxRail cluster(s) managed by VxRail Manager.

"Filter": {
    "VxRailCluster": ["VxRail-Virtual-SAN-Cluster-b3d39ba7-1905-44c0-8cf3-117683856659","VxRail-Virtual-SAN-Cluster-7d894d1f-44a7-47eb-b939-3abb90cad88b"]
},

InfoLevel

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

There are 2 levels (0-1) 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 individual objects |

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

| Sub-Schema | Default Setting | Maximum Setting | |------------|:---------------:|:---------------:| | Cluster | 1 | 2 | | Appliance | 1 | 2 | | Support | 1 | 1 | | Network | 1 | 1 |

Healthcheck

The Healthcheck schema is used to toggle health checks on or off.

Cluster

The Cluster schema is used to configure health checks for VxRail clusters.

| Sub-Schema