v0.4.1 release

.vscode/settings.json

@@ -10,7 +10,7 @@
     "powershell.codeFormatting.openBraceOnSameLine": true,
     "powershell.codeFolding.enable": true,
     "powershell.codeFormatting.alignPropertyValuePairs": false,
-    "powershell.bugReporting.project": "https://github.com/tpcarman/As-Built-Report/",
+    "powershell.bugReporting.project": "https://github.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray/",
     "editor.tabSize": 4,
     "editor.insertSpaces": true,
     "editor.detectIndentation": false,

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Pure Storage FlashArray As Built Report Changelog
 
+## [0.4.1] - 2019-04-03
+### Changed
+- Modified the logic used when connecting to a Pure Flasharray target
+- Added PSEdition_Desktop tag to the module manifest
+- Updated the copyright information in the module manifest
+- Add statistic links to readme.md
+
 ## [0.4.0] - 2019-03-15
 ### Changed
 - Refactored into PowerShell module

License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 AsBuiltReport
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,27 @@
+<p align="center">
+    <a href="https://www.powershellgallery.com/packages/AsBuiltReport.PureStorage.FlashArray/" alt="PowerShell Gallery Version">
+        <img src="https://img.shields.io/powershellgallery/v/AsBuiltReport.PureStorage.FlashArray.svg" /></a>
+    <a href="https://www.powershellgallery.com/packages/AsBuiltReport.PureStorage.FlashArray/" alt="PS Gallery Downloads">
+        <img src="https://img.shields.io/powershellgallery/dt/AsBuiltReport.PureStorage.FlashArray.svg" /></a>
+    <a href="https://www.powershellgallery.com/packages/AsBuiltReport.PureStorage.FlashArray/" alt="PS Platform">
+        <img src="https://img.shields.io/powershellgallery/p/AsBuiltReport.PureStorage.FlashArray.svg" /></a>
+</p>
+<p align="center">
+    <a href="https://github.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray/graphs/commit-activity" alt="GitHub Last Commit">
+        <img src="https://img.shields.io/github/last-commit/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray/master.svg" /></a>
+    <a href="https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray/master/LICENSE" alt="GitHub License">
+        <img src="https://img.shields.io/github/license/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray.svg" /></a>
+    <a href="https://github.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray/graphs/contributors" alt="GitHub Contributors">
+        <img src="https://img.shields.io/github/contributors/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray.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>
+
 # Pure Storage FlashArray AsBuiltReport
 
-Pure Storage FlashArray AsBuiltReport is a module of the parent "AsBuiltReport" project (https://github.com/AsBuiltReport/AsBuiltReport). 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.
+Pure Storage FlashArray AsBuiltReport is a module of the parent "AsBuiltReport" [project](https://github.com/AsBuiltReport/AsBuiltReport). 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.
 
@@ -17,15 +38,15 @@ The following PowerShell modules are required for generating a Pure Storage Flas
 
 Each of these modules can be easily downloaded and installed via the PowerShell Gallery 
 
-- [AsBuiltReport Module](https://www.powershellgallery.com/packages/AsBuiltReport/)
 - [Pure Storage Powershell SDK Module](https://www.powershellgallery.com/packages/PureStoragePowerShellSDK/)
+- [AsBuiltReport Module](https://www.powershellgallery.com/packages/AsBuiltReport/)
 
 ### Module Installation
 
 Open a Windows PowerShell terminal window and install each of the required modules as follows;
 ```powershell
-Install-Module AsBuiltReport
 Install-Module PureStoragePowerShellSDK
+Install-Module AsBuiltReport
 ```
 
 ### Required Privileges
@@ -53,9 +74,9 @@ The following provides information of how to configure each schema within the re
 ## 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.
+- The following creates a Pure Storage FlashArray As-Built report in HTML & Word formats in the folder C:\scripts\.
 ```powershell
-PS C:\>New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential (Get-Credential) -Format HTML,Word
+PS C:\>New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential (Get-Credential) -Format HTML,Word -OutputPath C:\scripts\
 ```
 
-## Knwon Issues
+## Known Issues

Src/Public/Invoke-AsBuiltReport.Purestorage.FlashArray.ps1

@@ -5,7 +5,7 @@ function Invoke-AsBuiltReport.PureStorage.FlashArray {
     .DESCRIPTION
         Documents the configuration of Pure Storage FlashArray in Word/HTML/XML/Text formats using PScribo.
     .NOTES
-        Version:        0.4/0
+        Version:        0.4.1
         Author:         Matt Allford
         Twitter:        @mattallford
         Github:         https://github.com/mattallford
@@ -30,11 +30,12 @@ function Invoke-AsBuiltReport.PureStorage.FlashArray {
     }
 
     $Script:Array = $Null
+    #Connect to Pure Storage Array using supplied credentials
     foreach ($FlashArray in $Target) {
         Try {
-            $Array = New-PfaArray -EndPoint $FlashArray -Credentials $Credential -IgnoreCertificateError
+            $Array = New-PfaArray -EndPoint $FlashArray -Credentials $Credential -IgnoreCertificateError -ErrorAction Stop
         } Catch {
-            Write-Verbose "Unable to connect to the Pure Storage FlashArray $FlashArray"
+            Write-Error $_
         }
 
         if ($Array) {
@@ -438,5 +439,7 @@ function Invoke-AsBuiltReport.PureStorage.FlashArray {
                 }#End Section Heading2 Users
             }#End Section Heading1 $ArrayAttributes.array_name
         }#End if $Array
+        #Clear the $Array variable ready for reuse for a connection attempt on the next foreach loop
+        Clear-Variable -Name Array
     }#End foreach $FlashArray in $Target
 }#End Function Invoke-AsBuiltReport.PureStorage.FlashArray