Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified AsBuiltReport.PureStorage.FlashArray.psd1
Binary file not shown.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Pure Storage FlashArray As Built Report Changelog

## [0.4.0] - 2019-03-15
### Changed
- Refactored into PowerShell module
- Updated default Pure Storage style sheet to include page orientation
57 changes: 30 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,55 +4,58 @@ Pure Storage FlashArray AsBuiltReport is a module of the parent "AsBuiltReport"

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.

# Sample Reports

<Coming Soon>

# Getting Started

The following simple list of instructions will get you started with the AsBuiltReport module.
Below are the instructions on how to install, configure and generate a Pure Storage Flash Array As Built Report

## Pre-requisites
The following PowerShell modules are required for generating a Pure Storage Flash Array As Built report.

All CmdLets and Functions require the [PScribo](https://github.com/iainbrighton/PScribo) module version 0.7.24 or later.
PScribo can be installed from the PowerShell Gallery with the following command:
Each of these modules can be easily downloaded and installed via the PowerShell Gallery

```powershell
Install-Module PScribo
```
- [AsBuiltReport Module](https://www.powershellgallery.com/packages/AsBuiltReport/)
- [Pure Storage Powershell SDK Module](https://www.powershellgallery.com/packages/PureStoragePowerShellSDK/)

Installing the AsBuiltReport module from the Powershell Gallery will install the framework module, and all sub-product modules such as this PureStorage.FlashArray module.
AsBuiltReport can be installed from the PowerShell Gallery with the following command:
```powershell
Install-Module AsBuiltReport
```
### Module Installation

For the Pure Storage FlashArray report, you are required to install the Pure Storage Powershell SDK module.
The Pure Storage Powershell SDK Module can be installed with the following command:
Open a Windows PowerShell terminal window and install each of the required modules as follows;
```powershell
Install-Module AsBuiltReport
Install-Module PureStoragePowerShellSDK
```

## Using AsBuiltReport
### Required Privileges

To generate a Pure Storage FlashArray report, a user account with the readonly role of higher on the FlashArray is required.

Each report type utilises a common set of parameters. Additional parameters specific to each report will be detailed in the report's `README.md` file, along with any relevant examples.
## Configuration

For a full list of common parameters and examples you can view the `New-AsBuiltReport` CmdLet help with the following command.
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;
```powershell
Get-Help New-AsBuiltReport -Full
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>


## Examples
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 repository for more examples.
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.
```powershell
PS C:\>New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential (Get-Credential) -Format HTML,Word
```

# Samples


# Release Notes

## [0.1.0] - Unreleased
### What's New

- This version contains a complete refactor of the project so that it is now a PowerShell module.
## Knwon Issues
4 changes: 2 additions & 2 deletions Src/Public/Invoke-AsBuiltReport.Purestorage.FlashArray.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ function Invoke-AsBuiltReport.PureStorage.FlashArray {
.DESCRIPTION
Documents the configuration of Pure Storage FlashArray in Word/HTML/XML/Text formats using PScribo.
.NOTES
Version: 0.1
Version: 0.4/0
Author: Matt Allford
Twitter: @mattallford
Github: https://github.com/mattallford
Credits: Iain Brighton (@iainbrighton) - PScribo module
Tim Carman (@tpcarman) - Wrote original report for Pure Storage

.LINK
https://github.com/AsBuiltReport/
https://github.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray
#>

#region Script Parameters
Expand Down