Pure Storage FlashArray AsBuiltReport is a module of the parent "AsBuiltReport" project. AsBuiltReport is a PowerShell module which generates As-Built documentation for many common datacentre infrastructure systems. Reports can be generated in Text, XML, HTML and MS Word formats and can be presented with custom styling to align with your company/customer's brand.
For detailed documentation around the whole project, please refer to the README.md file in the parent AsBuiltReport repository (linked to above). This README is specific only to the PureStorage Flasharray repository.
Below are the instructions on how to install, configure and generate a Pure Storage Flash Array As Built Report
The following PowerShell modules are required for generating a Pure Storage Flash Array As Built report.
Each of these modules can be easily downloaded and installed via the PowerShell Gallery
Open a Windows PowerShell terminal window and install each of the required modules as follows;
Install-Module PureStoragePowerShellSDK
Install-Module AsBuiltReportTo generate a Pure Storage FlashArray report, a user account with the readonly role of higher on the FlashArray is required.
The Pure Storage Flash Array As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A Pure Storage Flash Array report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report PureStorage.FlashArray -Path <User specified folder> -Name <Optional>Executing this command will copy the default FlashArray 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.
<Placeholder for future - there are currently no configurable options for the Pure Storage FlashArray Report>
There is one example listed below on running the AsBuiltReport script against a Pure Storage FlashArray target. Refer to the README.md file in the main AsBuiltReport project repository for more examples.
- The following creates a Pure Storage FlashArray As-Built report in HTML & Word formats in the folder C:\scripts.
PS C:\>New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential (Get-Credential) -Format HTML,Word -OutputPath C:\scripts\