# Getting Started

## Parallels RAS PowerShell - Getting Started

### Parallels Remote Application Server Requirements

Parallels RAS PowerShell requires 'Connection Broker' component of a matching version to communicate with.

### Microsoft Windows Component Requirements

The following components must be installed on the computer where you'll be executing Parallels RAS PowerShell cmdlets:

* Windows PowerShell 3.0 or higher
* Microsoft .NET Framework 4.5.2 or higher

### Basic Concepts

To get started with Parallels RAS PowerShell, complete thefollowing steps:

1. Open the Windows PowerShell console.
2. In the console, type the following command to import the Parallels RAS PowerShell module:

   Import-Module RASAdmin
3. Create a Parallels RAS session by executing the [New-RASSession](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/New-RASSession/README.md) cmdlet. Substitute the server name (in quotes) with the name or IP address of your Parallels RAS Licensing Server. Type your RAS administrator username and password when prompted.

   New-RASSession -Server "server.company.dom"
4. Execute the following cmdlet to see the list of cmdlets included in the Parallels RAS PowerShell module:

   Get-Command -Module RASAdmin
5. Execute other cmdlets. For example, try executing the [Get-RASGateway](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/Get-RASGateway/README.md) cmdlet to retrieve information about RAS Secure Gateway(s). The example below returns information about all RAS Secure Gateways available in the RAS Licensing Server site:

   Get-RASGateway
6. To see help for a cmdlet, execute Get-Help passing a cmdlet name:

   Get-Help Get-RASGateway

   To apply changes you've made to the farm configuration, use the [Invoke-RASApply](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/Invoke-RASApply/README.md) cmdlet:

   Invoke-RASApply

   To activate a Parallels RAS license, use [Invoke-RASLicenseActivate](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/Invoke-RASLicenseActivate/README.md):

   Invoke-RASLicenseActivate

   When executing the cmdlet above, you'll be prompted to enter your Parallels My Account email address and password. Passing a license key (the -Key parameter) is optional. If omitted (as in the example above), Parallels RAS is activated as a trial.

© 2026 Parallels International GmbH. Parallels and the Parallels logo are trademarks or registered trademarks of Parallels International GmbH in Canada, the U.S., and/or elsewhere.