FlashArray: Config Exporter PowerShell Script - fast config cloning or backup
Updated: May 8, 2021
[ NOTE: machine translation with the help of DeepL translator without additional proofreading and spell checking ]
How can I get a snapshot of my FlashArray system configuration? Very simple: use the following PowerShell script. Backgrounds of an export can be for example:
Config backup
Documentation purposes
Mass rollout (config cloning) of several nearly identical FlashArrays
There are native features and ways to track system changes of Pure systems e.g. the FA/FB audit trail, Pure1 and Syslog ... . If you still want the possibility of exporting the complete system configuration, you can do this quickly with the help of the script.
The "FlashArray Config Exporter" PowerShell script creates an export of your FlashArray system configuration to a .txt file. By executing the script, a secure connection to the specified FlashArray is established and the system configuration is exported. With the help of the provided output (see Export) it is possible for you to perform a complete system restore at any time - exception:
System data (volume contents)
System/user passwords (will be requested during recovery)
Requirements
To use the PowerShell script smoothly, the following system requirements must be met.
On Client/Server:
Windows 64-bit operating system
Windows PowerShell version 5.0 or later
FlashArray Purity with REST API version 2.0 or newer
Connection via port 443/HTTPS between client/server and FlashArray
You can easily check available FlashArray API versions of your systems via the browser:
https://<Virtual IP FlashArray>/api/api_version
The following system requirements must be created in advance:
Pure Storage PowerShell SDK v2 (included in download)
How To: Use FlashArray Config Exporter script
The script can be downloaded free of charge in the PUREFLASH.blog member area. The registration is done quickly, it is non-binding and revocable at any time. Beside the script there are already several other contents available for download. So it is worth to register: protected area.
I have packed the script together with the release notes into a ZIP file, this is 2.7 MB in size due to the Pure Storage PowerShell SDK v2 MSI. The SDK is mandatory to use the corresponding cmdlets included in the script.
HINT: Please read the release notes included in the ZIP!
Script usage
The script can be executed without administrator privileges. The Pure Storage PowerShell SDK v2 is required as the interface module. If not available, the MSI for installing the SDK is included in the download folder.
Now that you have the prerequisites in place, you can proceed to the actual. Run the PowerShell script. Immediately after that, you are asked to enter the corresponding FlashArray VirtualIP (VIP) of the system you want to export. The credentials used for export/login must have "readonly" privileges only.
The script creates a new file in the folder (execution path) with the name "FlashArrayEndPoint_pureconfig_list". A new execution of the script always overwrites the export completely with the FlashArray configuration available at the time of execution.
In case of unexpected problems, please refer to the "FlashArray_Config_Exporter-Log.txt" for any errors that may occur after execution.
In addition to the FlashArray system configuration, the file also contains a timestamp of the export.
The export is divided into:
Object configuration = hosts, host groups, volumes, volume groups, pods, connections, ...
System configuration = array, network, alarms, support, ...
With the commands included in the export, corresponding re-configurations can be copy-pasted. An absolute added value! I personally use this in large ActiveCluster environments, when setting up host objects, groups and connections. So I save double work - configure one of the FlashArrays and copy its objects via an export and the CLI into the second system.
Feedback on the script is welcome via the comment function.
In case of problems it is also worth to have a look at the release notes.
Otherwise I wish you a lot of fun using the script.
More info - Links
All officially published setting options in the GUI but also CLI can be read via the "on-board" user guides of the Pure Storage systems.
Click on "Help" in the Purity main menu.
The User Guide is structured like the main menu and can be opened downwards. A search function is also integrated - within here you can also search for keywords.
WEB: Pure Storage (Pure1) support portal - Ticket system and support *(requires registered FlashSystems)
PHONE: Pure Storage phone support: GER - (+49) (0)800 7239467; INTERNATIONAL - (+1) 650 7294088
WEB: Pure Storage OFFICIAL blog