Nutanix Prism Central As Built Report
🔰 Getting Started
Below are the instructions on how to install, configure and generate a Nutanix Prism Central As Built report.
🍔 Supported Prism Central Versions
The Nutanix Prism Central As Built Report supports the following Prism Central versions;
- PC 5.x
🔧 Pre-requisites
🔐 Required Privileges
A user with Prism Central Admin privileges is required to generate a Nutanix Prism Central As Built Report.
📦 Module Installation
Open a PowerShell terminal window and install the required modules as follows;
install-module AsBuiltReport.Nutanix.PrismCentral✏️ Configuration
The Nutanix Prism Central As Built Report utilises a JSON file to allow configuration of the report.
A Nutanix Prism Central report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report Nutanix.PrismCentral -Path <User specified folder> -Name <Optional> Executing this command will copy the default Nutanix Prism Central 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 Nutanix Prism report information
| Sub-Schema | Description |
|---|---|
| Filename | The filename of the As Built Report (Optional) If not specified, the filename will be the same as the report name |
| Name | The name of the As Built Report |
| Version | The report version |
| Status | The report release status |
Options
The Options schema allows certain options within the report to be toggled on or off
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| 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 |
InfoLevel
The InfoLevel schema allows configuration of each section of the report at a granular level.
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 | Detailed | Provides detailed information for a collection of objects |
The table below outlines the default and maximum InfoLevel settings for each section.
| Sub-Schema | Sub-Schema | Default Setting | Maximum Setting |
|---|---|---|---|
| PrismCentral | |||
| SystemSettings | 1 | 1 | |
| SmtpServer | 1 | 1 | |
| SyslogServer | 1 | 1 | |
| IdentityProviders | 1 | 1 | |
| DirectoryServices | 1 | 1 | |
| VirtualInfrastructure | |||
| VM | 1 | 2 | |
| Images | 1 | 1 | |
| Categories | 1 | 1 | |
| Networks | 1 | 1 | |
| Policies | |||
| NGT | 1 | 1 | |
| ImagePlacement | 1 | 1 | |
| Hardware | |||
| Clusters | 1 | 2 | |
| Hosts | 1 | 2 | |
| Administration | |||
| Roles | 1 | 1 | |
| LocalUsers | 1 | 1 |
Healthcheck
The Healthcheck schema is used to toggle health checks on or off.
VM
The VM schema is used to configure health checks for virtual machines.
| Sub-Schema | Setting | Default | Description | Highlight |
|---|---|---|---|---|
| PowerState | true / false | true | Highlights VMs which are powered off |
💻 Examples
# Generate a Nutanix Prism Central As Built Report for Nutanix Prism Central instance '172.16.30.110' using specified credentials. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:\Users\Tim\Documents'
PS C:\> New-AsBuiltReport -Report Nutanix.PrismCentral -Target '172.16.30.110' -Username 'admin' -Password 'nutanix/4u' -Format Html,Word -OutputPath 'C:\Users\Tim\Documents' -Timestamp
# Generate a Nutanix Prism Central As Built Report for Nutanix Prism Central instance '172.16.30.110' using specified credentials and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\Tim\Documents'. Display verbose messages to the console.
PS C:\> New-AsBuiltReport -Report Nutanix.PrismCentral -Target '172.16.30.110' -Username 'admin' -Password 'nutanix/4u' -Format Text,Html,Word -OutputPath 'C:\Users\Tim\Documents' -Verbose
# Generate a Nutanix Prism Central As Built Report for Nutanix Prism Central instance '172.16.30.110' using stored credentials. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:\Users\Tim\Documents'.
PS C:\> $Creds = Get-Credential
PS C:\> New-AsBuiltReport -Report Nutanix.PrismCentral -Target '172.16.30.110' -Credential $Creds -Format Html,Text -OutputPath 'C:\Users\Tim\Documents' -EnableHealthCheck
# Generate a single Nutanix Prism Central As Built Report for Nutanix Prism Central instances '172.16.30.110' and '172.16.30.130' 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 Nutanix.PrismCentral -Target '172.16.30.110','172.16.30.130' -Username 'admin' -Password 'nutanix/4u' -StylePath 'C:\Scripts\Styles\MyCustomStyle.ps1'
# Generate a Nutanix Prism Central As Built Report for Nutanix Prism Central instance '172.16.30.110' 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.vSphere -Target '172.16.30.110' -Username 'admin' -Password 'nutanix/4u' -Format Html,Word -OutputPath 'C:\Users\Tim\Documents' -SendEmail