This PowerShell script documents all settings from a Parallels RAS installation and exports them to a Word document.
- Export-RASSettings.ps1 - Original version that requires Microsoft Word installed (uses COM automation)
- Export-RASSettings-PSWriteWord.ps1 - Recommended version that does NOT require Word (uses PSWriteWord module)
-
Parallels RAS PowerShell Module
- The Parallels RAS PowerShell module must be installed
- Typically installed with Parallels RAS or available from Parallels
-
Output Format Requirements (choose one):
- For Export-RASSettings.ps1: Microsoft Word must be installed (uses COM automation)
- For Export-RASSettings-PSWriteWord.ps1: PSWriteWord module (Install-Module PSWriteWord) - Recommended, no Word required
-
Permissions
- Appropriate permissions to access Parallels RAS configuration
- Typically requires administrator or RAS administrator privileges
-
Ensure the Parallels RAS PowerShell module is installed:
Get-Module -ListAvailable -Name rasadmin
-
If not installed, install it according to Parallels RAS documentation
-
For PSWriteWord version (recommended), install the PSWriteWord module:
Install-Module -Name PSWriteWord -Scope CurrentUser
The script will attempt to install it automatically if not found.
Recommended (no Word required):
.\Export-RASSettings-PSWriteWord.ps1Original version (requires Word):
.\Export-RASSettings.ps1This will create a Word document in the current directory with a timestamped filename.
Specify a custom output path and document name:
.\Export-RASSettings.ps1 -OutputPath "C:\Reports" -DocumentName "RAS-Configuration-2024"- OutputPath (Optional): Path where the Word document will be saved. Defaults to current directory.
- DocumentName (Optional): Name of the Word document (without .docx extension). Defaults to "RAS-Settings-{timestamp}".
The script collects and documents the following information:
- Site Configuration - RAS site details
- Server Configuration - All RAS servers and their properties
- Farm Configuration - Application and desktop farms
- Application Configuration - Published applications
- User Configuration - RAS users
- Gateway Configuration - RAS Gateway servers
- License Configuration - License information
- Active Sessions - Current user sessions
- Detailed Configuration - Complete property details for all objects using all available Get-RAS* cmdlets
The generated Word document includes:
- Title page with generation metadata
- Formatted tables for structured data
- Detailed property listings for all configuration objects
- Professional formatting with headers and sections
If you receive an error about the Parallels RAS module not being found:
-
Verify the module is installed:
Get-Module -ListAvailable -Name rasadmin
-
Check the module path and ensure it's in your PSModulePath
Solution: Use the PSWriteWord version instead!
If you don't have Word installed, use:
.\Export-RASSettings-PSWriteWord.ps1This version uses the PSWriteWord module which creates Word documents without requiring Microsoft Word to be installed.
If you prefer the original version:
- Ensure Microsoft Word is installed
- Check that Word can be accessed via COM automation
- Try running PowerShell as administrator
If you receive permission errors:
- Run PowerShell as administrator
- Ensure your account has RAS administrator privileges
- Check that you can connect to the RAS management server
Some cmdlets may not be available or may return no data depending on:
- Your RAS installation type
- Module version
- Permissions level
- Configuration state
The script handles missing data gracefully and will document what is available.
- The script attempts to collect data from all available Get-RAS* cmdlets
- Some cmdlets may require specific parameters - the script uses default behavior
- Large configurations may take several minutes to document
- The Word document may be large if you have extensive configurations
For issues with:
- This script: Check the error messages and ensure prerequisites are met
- Parallels RAS module: Consult Parallels RAS documentation
- Word automation: Ensure Word is properly installed and accessible