This guide contains information about Parallels RAS PowerShell. It is intended for Parallels RAS administrators who would like to use PowerShell to automate their RAS administration tasks.

Organization of This Guide

The guide is organized into the following main sections:

Getting Started lists system requirements and explains basic RAS PowerShell concepts.

Parallels RAS Powershell Admin Module is a complete reference to RAS PowerShell cmdlets.

API Versions lists available API versions and changes between them.

Examples includes cmdlet examples demonstrating how to perform the most common Parallels RAS management tasks.

Additional Resources

For additional Parallels RAS documentation and resources, please visit https://www.parallels.com/products/ras/resources

© 2025 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.

NAME

Get-RASAVDGallery

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Galleries.

SYNTAX

Get-RASAVDGallery -ProviderId** (uint) [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Galleries.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Gallery information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDGallery

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDGallery -ProviderId 2

Retrieves a list of Galleries which fall under the Provider specified.

RELATED LINKS

-none-

NAME

Get-RASAVDCustomHost

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

SYNTAX

Get-RASAVDCustomHost -ProviderId (uint) [ShowHostsInHostPool (SwitchParameter)] [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ShowHostsInHostPool (SwitchParameter)

Show Hosts in existing host pools.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDCustomHost

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDCustomHost -ProviderId 2 | Format-List

Retrieves all the Custom Hosts under the Provider with ID 2.

The Format-List cmdlet formats the display output to include all available properties.

RELATED LINKS

-none-

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 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 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 cmdlet:

   Invoke-RASApply

   To activate a Parallels RAS license, use :

   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.

© 2025 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.

NAME

Add-RASPrintingAutoInstallFont

SYNOPSIS

Adds an Auto install font to Parallels RAS Universal Printing settings.

SYNTAX

Add-RASPrintingAutoInstallFont - (string) [ (SwitchParameter)] [ (uint)] [()]

DESCRIPTION

Adds an Auto install font to Parallels RAS Universal Printing settings.

PARAMETERS

SiteId (uint)

The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

FontFilePath (string)

Auto Install Font Path.

ExcludeFont (SwitchParameter)

Automatically Exclude Font from embedding.

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf"

Adds the font to RAS Universal Printing Auto install fonts settings. **---------- EXAMPLE 2 ----------

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf" -ExcludeFont

Adds the font to RAS Universal Printing Auto install fonts settings and adds the font to the embedding exclusion list.

RELATED LINKS

NAME

Get-RASAppPackageAvailVersions

SYNOPSIS

Retrieves the application package version.

SYNTAX

Get-RASAppPackageAvailVersions [] (string) [[-] (uint)] [()]

DESCRIPTION

Retrieves the application package version.

PARAMETERS

Name (string)

The name of the application package for which to retrieve the available versions.

This must be the actual application package name used in the RAS farm.

SiteId (uint)

The ID of the Site from which to retrieve the available application package versions.

If the parameter is omitted, the Licensing Server site ID will be used.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAppPackageAvailVersions

Retrieves the list of application package versions. **---------- EXAMPLE 2 ----------

Get-RASAppPackageAvailVersions -Name "MSIX_APP_PACKAGE"

Retrieves the version of the application package named AppPackage1.

RELATED LINKS

-none-

NAME

Get-RASAdminSession

SYNOPSIS

Retrieves information about RAS Admin sessions.

SYNTAX

-none-

DESCRIPTION

Retrieves information about RAS Admin sessions.

PARAMETERS

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAdminSession

Retrieves information about RAS Admin sessions.

RELATED LINKS

NAME

Get-RASAVDVirtualNetwork

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Virtual Networks.

SYNTAX

Get-RASAVDVirtualNetwork - (string) - (uint) [()]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Virtual Networks.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Virtual Network information.

Location (string)

Location of the Azure Virtual Desktop Provider.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" | Format-List

Retrieves all the Virtual Networks found under the Provider with ID 2 and Location westeurope.

The Format-List cmdlet formats the display output to include all available properties.

RELATED LINKS

-none-

NAME

Get-RASAVDSettings

SYNOPSIS

Retrieves the Azure Virtual Desktop Features settings.

SYNTAX

Get-RASAVDSettings [** (uint)] [()]

DESCRIPTION

Retrieves the Azure Virtual Desktop Features settings.

PARAMETERS

SiteId (uint)

Site ID from which to retrieve the AVD settings.

If the parameter is omitted, the Licensing Server site ID will be used.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDSettings

Retrieves the AVD Features Settings.

RELATED LINKS

NAME

Get-RASAVDLocation

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Locations.

SYNTAX

Get-RASAVDLocation -** (uint) [()]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Locations.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Location information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDLocation -ProviderId 2 | Format-List

Retrieves all the Locations under the Provider with ID 2.

The Format-List cmdlet formats the display output to include all available properties.

RELATED LINKS

-none-

NAME

Get-RASAVDResourceGroup

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Resource Groups.

SYNTAX

Get-RASAVDResourceGroup - (uint) [()]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Resource Groups.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Resource Group information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDResourceGroup -ProviderId 2 | Format-List

Retrieves all the Resource Groups under the Provider with ID 2.

The Format-List cmdlet formats the display output to include all available properties.

RELATED LINKS

NAME

Get-RASAVDPredefinedImages

SYNOPSIS

Retrieves the predefined Azure Virtual Desktop VM images.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the predefined Azure Virtual Desktop VM images.

To retrieve the AzureId of the Latest Predefined Image, use the Get-RASAVDVersion command and pass along the respective data.

PARAMETERS

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDPredefinedImages

Retrieves information about the predefined AVD VM images.

RELATED LINKS

NAME

Get-RASAWSSubnets

SYNOPSIS

The cmdlet returns a list of Amazon Web Service Subnets.

SYNTAX

Get-RASAWSSubnets -** (uint) - {RDSTemplate | VDITemplate} [()]

DESCRIPTION

The cmdlet returns a list of Amazon Web Service Subnets.

PARAMETERS

TemplateId (uint)

Template ID from which to retrieve the Amazon Web Service Subtnets.

TemplateType ()

Template Type from which to retrieve the Amazon Web Service Subtnets.

Possible values: RDSTemplate, VDITemplate

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAWSSubnets -TemplateId 2 -TemplateType RDSTemplate

Retrieves a list of Subnets that are available to the specified Template.

RELATED LINKS

-none-

NAME

Get-RASCurrentAdminPermissions

SYNOPSIS

Retrieve information about the current admin permissions.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the current admin permissions.

PARAMETERS

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASCurrentAdminPermissions

Retrieves information about the current admin permissions.

RELATED LINKS

NAME

Add-RASExcludeADGroup

SYNOPSIS

Adds an Exclude AD group entry.

SYNTAX

Add-RASExcludeADGroup [Account (string)] [SID (string)] [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Adds an Exclude AD group to the Exclude AD group settings list.

PARAMETERS

Account (string)

The name of the group account to add to the Exclude AD group list.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SID (string)

The SID of the group account to add to the Exclude AD group list.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID in which to modify the specified Exclude AD group settings.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASExcludeADGroup -Account Guests

Adds an Exclude AD group to the Exclude AD group settings list for the current site.

RELATED LINKS

• Remove-RASExcludeADGroup

• Get-RASExcludeADGroup

NAME

Add-RASPubAppFileExt

SYNOPSIS

Adds a file extension for the specified published application.

SYNTAX

Add-RASPubAppFileExt [Id]** (uint) -Extension (string) [SiteId (uint)] [(CommonParameters)]

Add-RASPubAppFileExt [-InputObject] (PubItem) -Extension (string) [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

This cmdlet only allows you to add a file extension.

To modify other file extensions, use the Set-RASPubAppFileExt cmdlet.

PARAMETERS

Extension (string)

The file extension that will be added/modified.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (PubItem)

An object specifying the published resource.

To obtain the object, use the Get-PubItem cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

SiteId (uint)

Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

PubItem

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASPubAppFileExt -Id 3 -Extension "txt"

Adds the specified file extension for the resource specified by ID.

RELATED LINKS

• Get-RASPubItem

• Get-RASPubAppFileExt

• Set-RASPubAppFileExt

• Remove-RASPubAppFileExt

NAME

Get-RASADIntegrationSettings

SYNOPSIS

Obtains AD integration settings.

SYNTAX

Get-RASADIntegrationSettings [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Obtains the active AD integration settings for the current site.

PARAMETERS

SiteId (uint)

Site ID from which to retrieve the AD Integration Settings.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

ADIntegrationSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASADIntegrationSettings

Obtains the active AD integration settings for the current site.

RELATED LINKS

• Set-RASADIntegrationSettings

• Invoke-RASADIntegrationSettings

NAME

Get-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure an Azure Virtual Desktop.

SYNTAX

Get-RASAVDDefaultSettings [[-SiteId] (uint)] -DefObjType {AVDMultiSessionDefaultSettings | AVDSingleSessionDefaultSettings} [(CommonParameters)]

DESCRIPTION

Retrieves default settings used to configure an Azure Virtual Desktop.

Default settings are defined on a site level and are applied to an Azure Virtual Desktop when it is initially created.

PARAMETERS

SiteId (uint)

Site ID from which to retrieve the defaults.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

DefObjType (AVDDefObjType)

The Default Object Type

Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDDefaultSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDDefaultSettings -DefObjType AVDSingleSessionDefaultSettings

Retrieves default Personal AVD settings from the specified site. **---------- EXAMPLE 2 ----------

Get-RASAVDDefaultSettings -DefObjType AVDMultiSessionDefaultSettings

Retrieves default Pooled AVD settings from the specified site.

RELATED LINKS

• Set-RASAVDDefaultSettings

NAME

Add-RASThemeCustomImage

SYNOPSIS

Add a theme custom image.

SYNTAX

Add-RASThemeCustomImage -ImageFile (string) [Name (string)] [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Add a theme custom image.

PARAMETERS

Name (string)

Theme custom image name.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID in which to create the theme custom image.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ImageFile (string)

Image file path of the image to be added to the Theme Custom Images list.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASThemeCustomImage -ImageFile "C:\temp\image.png"

Add a theme custom image to the list of theme custome images of the Licensing site.

RELATED LINKS

• Get-RASTheme

• Get-RASThemeCustomImage

• Set-RASThemeCustomImage

• Remove-RASThemeCustomImage

NAME

Get-RASAppPackageSettings

SYNOPSIS

Retrieves Application Package settings.

SYNTAX

Get-RASAppPackageSettings [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Retrieves the active Application Package settings for the current site.

PARAMETERS

SiteId (uint)

The ID of the Site from which to retrieve the application package settings.

To obtain the ID of the desired Site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AppPackageSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAppPackageSettings

Obtains the active Application package settings for the current site.

RELATED LINKS

• Set-RASAppPackageSettings

NAME

Get-RASAllowedDevicesSetting

SYNOPSIS

Returns settings for types of allowed clients.

SYNTAX

Get-RASAllowedDevicesSetting [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

Returns settings for types of allowed clients.

PARAMETERS

SiteId (uint)

The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

RASAllowedDevicesSetting

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAllowedDevicesSetting

Retrieves settings for each of device types shown in 'Allowed Devices'. The permission of the device is represented as a boolean.

RELATED LINKS

• Set-RASAllowedDevicesSetting

NAME

Get-RASBrokerAutoPromotionSettings

SYNOPSIS

Obtains Parallels RAS Broker Auto Promotion settings.

SYNTAX

Get-RASBrokerAutoPromotionSettings [[-SiteId] (uint)] [(CommonParameters)]

DESCRIPTION

The Get-RASBrokerAutoPromotionSettings cmdlet obtains the complete set of Parallels RAS Broker Auto Promotion settings for the current session.

PARAMETERS

SiteId (uint)

Site ID from which to retrieve the specified RAS Auto Promotion settings.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

BrokerAutoPromotion

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASBrokerAutoPromotionSettings

Obtains Parallels RAS Auto Promote settings for the current session.

RELATED LINKS

• Set-RASBrokerAutoPromotionSettings

NAME

Get-RASAVDPublisher

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Publishers.

SYNTAX

Get-RASAVDPublisher -Location** (string) -ProviderId (uint) [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Publishers.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Location (string)

Location of the Azure Virtual Desktop Provider.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDPublisher

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDPublisher -ProviderId 2 -Location "westeurope"

Retrieves a list of Publishers which fall under the Provider and Location specified.

RELATED LINKS

-none-

NAME

Get-RASAuthSettings

SYNOPSIS

Retrieves connection settings for authentication.

SYNTAX

Get-RASAuthSettings [SiteId** (uint)] [(CommonParameters)]

DESCRIPTION

Retrieves all of the available connection settings for the Authentication category.

PARAMETERS

SiteId (uint)

The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

RASAuthSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAuthSettings

Retrieves RAS authentication settings.

RELATED LINKS

• Set-RASAuthSettings

NAME

Get-RASClientPolicyConnection

SYNOPSIS

Retrieves the connection list.

SYNTAX

Get-RASClientPolicyConnection [Id] (uint) [(CommonParameters)]

Get-RASClientPolicyConnection [[-Name] (string)] [(CommonParameters)]

DESCRIPTION

Retrieves the connection list.

PARAMETERS

Name (string)

Name of the client policy for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of the client policy for which to retrieve the information.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

SecondaryConnection

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASClientPolicyConnection -Id 1

Retrieves the following client policy connection with Id=1.

RELATED LINKS

• Set-RASClientPolicy

• Get-RASClientPolicy

• Add-RASClientPolicyConnection

• Remove-RASClientPolicyConnection

NAME

Get-RASAVDSKU

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.

SYNTAX

Get-RASAVDSKU -Location (string)** -Offer (string) -ProviderId (uint) -Publisher (string) [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Stock Keeping Unit information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Location (string)

Location of the Azure Virtual Desktop Provider.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Publisher (string)

The Azure Virtual Desktop Publisher.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Offer (string)

The Azure Virtual Desktop Offer.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDSKU

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDSKU -ProviderId 2 -Location "westeurope" -Publisher "my-publisher" -Offer "my-offer"

Retrieves a list of Stock Keeping Units which fall under the Provider, Location, Publisher and Offer specified.

RELATED LINKS

-none-

NAME

Get-RASAVDHostPool

SYNOPSIS

Retrieves information about one or multiple Azure Virtual Desktop Host Pool properties.

SYNTAX

Get-RASAVDHostPool [[-Id]** (uint)] [(CommonParameters)]

Get-RASAVDHostPool [[-Name]** (string)] [[-SiteId] (uint)] [(CommonParameters)]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Host Pool properties.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

The result set contains only the major properties of a pool; it does not include the complete list of settings supported in RAS.

PARAMETERS

Name (string)

The name of the Azure Virtual Desktop Host Pool for which to retrieve the information.

This must be the actual AVD Host Pool name used in the RAS farm.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve the AVD Host Pool information.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of a Azure Virtual Desktop Host Pool for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDHostPool

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDHostPool -Name "My AVDHostPool" | Format-List

Retrieves information about the AVD Host Pool properties specified by name from the Licensing Server site. **---------- EXAMPLE 2 ----------

Get-RASAVDHostPool -Id 10

Retrieves information about the AVD Host Pool specified by ID from the Licensing Server site.

RELATED LINKS

• New-RASAVDHostPool

• Remove-RASAVDHostPool

• Set-RASAVDHostPool

NAME

Get-RASAVDOffer

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Offers.

SYNTAX

Get-RASAVDOffer -Location** (string) -ProviderId (uint) -Publisher (string) [(CommonParameters)]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Offers.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Location (string)

Location of the Azure Virtual Desktop Provider.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Publisher (string)

The Azure Virtual Desktop Publisher.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

AVDOffer

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDOffer -ProviderId 2 -Location "westeurope" -Publisher "publisher-server"

Retrieves a list of Offers which fall under the Provider, Location and Publisher specified.

RELATED LINKS

-none-

NAME

Get-RASClientSettings

SYNOPSIS

Retrieves the Parallels RAS client settings.

SYNTAX

Get-RASClientSettings [SiteId** (uint)] [(CommonParameters)]

DESCRIPTION

Retrieves the Parallels RAS client settings.

PARAMETERS

SiteId (uint)

The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

RASClientSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASClientSettings

Retrieves the RAS Farm client settings. **---------- EXAMPLE 2 ----------

Get-RASClientSettings | Format-List

Retrieves the RAS client settings.

RELATED LINKS

• Get-RASHelpDeskEmailSettings

• Get-RASProxySettings

• Get-RASSystemSettings

• Set-RASClientSettings

• Get-RASFarmSettings

NAME

Get-RASCPUOptimizationSettings

SYNOPSIS

Obtains Parallels RAS CPU Optimization settings.

SYNTAX

Get-RASCPUOptimizationSettings [SiteId (uint)] [(CommonParameters)]

DESCRIPTION

The Get-RASCPUOptimizationSettings cmdlet obtains the complete set of CPU optimization settings for the current session.

PARAMETERS

SiteId (uint)

The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

CPUOptimizationSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASCPUOptimizationSettings

Obtains Parallels RAS CPU optimization settings for the current session.

RELATED LINKS

• Set-RASCPUOptimizationSettings

NAME

Get-RASCustomPermission

SYNOPSIS

Retrieves the permissions of a RAS custom admin account.

SYNTAX

Get-RASCustomPermission [AdminId] (uint) [(CommonParameters)]

DESCRIPTION

Retrieves the permissions of a RAS custom admin account.

PARAMETERS

AdminId (uint)

Admin ID to retrieve the specified RAS Custom Administrator Account.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

CustomPermission

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASCustomPermission -AdminId 100

Retrieves the permissions of a custom administrator specified by ID.

RELATED LINKS

• Set-RASCustomPermission

• Get-RASAdminAccount

• New-RASAdminAccount

• Set-RASAdminAccount

• Remove-RASAdminAccount

NAME

Get-RASCustomRoute

SYNOPSIS

Retrieves information about one or multiple custom routes.

SYNTAX

Get-RASCustomRoute [[-Id]** (uint)] [(CommonParameters)]

Get-RASCustomRoute [[-Name]** (string)] [[-SiteId] (uint)] [(CommonParameters)]

DESCRIPTION

Retrieves information about one or multiple custom routes.

The cmdlet returns an object of type CustomRoute.

Custom routes are used within published item preferred routing settings.

PARAMETERS

Name (string)

The name of the Custom Route for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve the Custom Route information.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of a Custom Route for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

CustomRoute

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASCustomRoute -Name "My Custom Route"

Retrieves information about the Custom Route specified by name from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter. **---------- EXAMPLE 2 ----------

Get-RASCustomRoute -Id 10

Retrieves information about the Custom Route specified by ID from the Licensing Server site.

RELATED LINKS

• New-RASCustomRoute

• Set-RASCustomRoute

• Remove-RASCustomRoute

• Add-RASPubItemPreferredRoute

• Get-RASPubItemPreferredRoute

• Set-RASPubItemPreferredRoute

• Remove-RASPubItemPreferredRoute

NAME

Add-RASHALBDevice

SYNOPSIS

Add a new HALB Device to the specific HALB Virtual Server instance.

SYNTAX

Add-RASHALBDevice [[-]** (uint)] [] (string) [[-] (SwitchParameter)] [()]

Add-RASHALBDevice [-] () [] (string) [[-] (SwitchParameter)] [()]

Add-RASHALBDevice []** (string) [[-] (uint)] [] (string) [[-] (SwitchParameter)] [()]

DESCRIPTION

Add a new HALB Device to the specific HALB Virtual Server instance.

PARAMETERS

HALBName (string)

SiteId (uint)

HALBId (uint)

DeviceIP (string)

NoInstall (SwitchParameter)

InputObject ()

An object of type HALBSettings.

The object is obtained using the Get-RASHALB cmdlet.

(CommonParameters)

INPUTS

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASHALBDevice -HALBId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by id. **---------- EXAMPLE 2 ----------

Add-RASHALBDevice -HALBName "HALB-VS" -SiteId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by name.

RELATED LINKS

NAME

Add-RASURLRedirectionEntry

SYNOPSIS

Adds a URL redirection entry.

SYNTAX

Add-RASURLRedirectionEntry - (string) [- {DoNotRedirect | Redirect}] [ (bool)] [ (uint)] [()]

DESCRIPTION

Adds a URL redirection to the URL redirection settings list for the current site.

PARAMETERS

Enabled (bool)

Whether the URL redirection will be enabled or disabled.

URL (string)

The URL to redirect or not.

Action ()

The redirect action type.

Possible values: DoNotRedirect, Redirect

SiteId (uint)

Site ID in which to modify the specified URL redirection settings.

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASURLRedirectionEntry -URL test.com

Adds a URL redirection for test.com to the URL redirection settings list for the current site.

RELATED LINKS

NAME

Add-RASMFAUsers

SYNOPSIS

Import MFA TOTP/EmailOTP users from a CSV file.

SYNTAX

Add-RASMFAUsers -** (string) [ (uint)] [ (uint)] [- {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [()]

DESCRIPTION

Import MFA TOTP/EmailOTP users from a CSV file.

PARAMETERS

FilePath (string)

File path to CSV containing user and secret.

Must be in the format "user,secret".

SiteId (uint)

Site ID in where the users will be imported.

If the parameter is omitted, the site ID of the Licensing Server will be used.

MFAId (uint)

The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

Type ()

The MFA Provider Type to be modified.

If the parameter is omitted, the site ID of the Licensing Server will be used.

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASMFAUsers -FilePath "users.csv" -Type TOTP

Imports MFA TOTP users from file. Operation is done on licensing site. **---------- EXAMPLE 2 ----------

Add-RASMFAUsers -FilePath "users.csv" -Type EmailOTP -MFAId 1

Imports MFA EmailOTP users from file in MFA with Id 1. **---------- EXAMPLE 3 ----------

Add-RASMFAUsers -FilePath "users.csv" -SiteId 2 -Type TOTP

Imports MFA TOTP users from file. Operation is done on site 2.

RELATED LINKS

NAME

Get-RASAdminAccount

SYNOPSIS

Retrieves information about one or multiple Parallels RAS administrator accounts.

SYNTAX

Get-RASAdminAccount [[-]** (uint)] [()]

Get-RASAdminAccount [[-]** (string)] [()]

DESCRIPTION

Retrieves information about one or multiple Parallels RAS administrator accounts.

The cmdlet returns an array of objects of type RASAdminAccount.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

PARAMETERS

Name (string)

The username of a Parallels RAS administrator account for which to retrieve the information.

Id (uint)

The ID of an administrator account for which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAdminAccount | Format-List

Retrieves the list of all available Parallels RAS administrator accounts.

The Format-List cmdlet formats the display output to include all available settings for each administrator. **---------- EXAMPLE 2 ----------

Get-RASAdminAccount "username@dom"

Retrieves information about an administrator specified by username. **---------- EXAMPLE 3 ----------

Get-RASAdminAccount -Id 1

Retrieves information about an administrator specified by ID.

RELATED LINKS

NAME

Add-RASProviderAdminCredentials

SYNOPSIS

Adds Admin Credential property to the list.

SYNTAX

Add-RASProviderAdminCredentials [] (uint) [ (bool)] [ (string)] [ (string)] [()]

Add-RASProviderAdminCredentials [] (string) [[-] (uint)] [ (bool)] [ (string)] [ (string)] [()]

DESCRIPTION

Adds Admin Credential to the following list.

PARAMETERS

Name (string)

The name of the Provider.

SiteId (uint)

Site ID in which to modify the specified Provider server.

If the parameter is omitted, the site ID of the Licensing Server will be used.

Id (uint)

The ID of the Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

Enabled (bool)

Whether credentials are enabled or not

Username (string)

Username

Password (string)

Password

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASProviderAdminCredential -Id 1 -Enabled $true -Username "Administrator"

Adds the Admin Credentials to the property list

RELATED LINKS

NAME

Get-RASAgentDiagnostic

SYNOPSIS

Retrieves RAS Agent Diagnostic information.

SYNTAX

Get-RASAgentDiagnostic - {RDS | Provider | Gateway | Guest | Broker | PA | HALBDevice | EnrollmentServer} - (string) [ (uint)] [()]

DESCRIPTION

Retrieves the diagnostic information about the RAS Agent installed on a specific server, for diagnostic purposes, with a specific type, such as

RD Session Host, Provider, Gateway, Guest, Broker, HALB Device.

PARAMETERS

Server (string)

The name of server from which to retrieve Agent information.

This must be the actual server name used in the RAS farm.

SiteId (uint)

Site ID from which to retrieve the specified Agent information.

If the parameter is omitted, the site ID of the Licensing Server will be used.

AgentDiagnosticType

() Specifies the server type for which to retrieve the information.

Possible values: RDS, Provider, Gateway, Guest, Broker, PA, HALBDevice, EnrollmentServer

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAgentDiagnostic -Server test.domain -ServerType RDS

Retrieves the information about the RDS Agent installed on the server 'test.domain'. **---------- EXAMPLE 2 ----------

Get-RASAgentDiagnostic -Server test.domain -ServerType Provider

Retrieves the information about the Provider Agent installed on the server 'test.domain'.

RELATED LINKS

NAME

Get-RASAppPackage

SYNOPSIS

Retrieves the application package settings.

SYNTAX

Get-RASAppPackage [] (uint)** [()]

Get-RASAppPackage [[-]** (string)] [[-] (uint)] [()]

DESCRIPTION

Retrieves the application package settings.

PARAMETERS

Name (string)

The name of the application package from which to retrieve the information.

This must be the actual application package name used in the RAS farm.

SiteId (uint)

The ID of the Site from which to retrieve the application package information.

If the parameter is omitted, the Licensing Server Site ID will be used.

Id (uint)

The ID of an application package from which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAppPackage

Retrieves the list of Application Packages. **---------- EXAMPLE 2 ----------

Get-RASAppPackage -Id 1

Retrieves the Application Package with Id 1.

RELATED LINKS

NAME

Add-RASThemeGroupFilter

SYNOPSIS

Adds a new group filter to the theme group filters.

SYNTAX

Add-RASThemeGroupFilter []** (uint) [ (string)] [ (string)] [()]

Add-RASThemeGroupFilter [] (string) [[-] (uint)] [ (string)] [ (string)] [()]

DESCRIPTION

Adds a new group filter to the theme group filters.

PARAMETERS

GroupName (string)

The name of the group list

GroupSID (string)

The group SID

Name (string)

Name of the Theme policy to modify.

This must be the actual Theme policy name used in the RAS farm.

SiteId (uint)

The site ID to which to add the specified server.

If the parameter is omitted, the Licensing Server site ID will be used.

Id (uint)

The ID of the Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASThemeGroupFilter -Id 1 -GroupName GroupListName

Adds a group filter with name GroupListName for theme with Id 1.

RELATED LINKS

NAME

Get-RASAVDHostPoolAssignment

SYNOPSIS

Retrieves the Azure Virtual Desktop Host Pool Assignment List.

SYNTAX

Get-RASAVDHostPoolAssignment [[-] (uint)] [()]

Get-RASAVDHostPoolAssignment [[-] (string)] [[-] (uint)] [()]

DESCRIPTION

Retrieves the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.

PARAMETERS

Name (string)

The name of the Azure Virtual Desktop Host Pool for which to retrieve the information.

This must be the actual AVD Host Pool name used in the RAS farm.

SiteId (uint)

Site ID from which to retrieve the AVD Host Pool information.

If the parameter is omitted, the Licensing Server site ID will be used.

Id (uint)

The ID of a Azure Virtual Desktop Host Pool for which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDHostPoolAssignment -Id 1 -ObjType MFA

Retrieves the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by ID. **---------- EXAMPLE 2 ----------

Get-RASAVDHostPoolAssignment -Name "Logon1" -ObjType MFA

Retrieves the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Name.

RELATED LINKS

NAME

Get-RASAVDVMSize

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop VM Sizes.

SYNTAX

Get-RASAVDVMSize -** (string) - (uint) [()]

Get-RASAVDVMSize -** (string) - (uint) [()]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop VM Sizes.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.

Location (string)

Location of the Azure Virtual Desktop Provider.

WorkspaceId (uint)

Workspace ID from which to retrieve the Azure Virtual Desktop VMSize information.

VMAzureId (string)

Azure Virtual Desktop VM Id.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDVMSize -ProviderId 2 -Location westeurope | Format-List

Retrieves all the VM Sizes which fall under the AVD Provider and Location specified.

The Format-List cmdlet formats the display output to include all available properties. **---------- EXAMPLE 2 ----------

Get-RASAVDVMSize -WorkspaceId 2 -VMAzureId "/subscriptions/w7647456-39g5-113d-pe43-34le8xwj92tn/resourceGroups/My-Resource-Group/providers/Microsoft.Compute/virtualMachines/My-Host"

Retrieves all the VM Sizes which fall under the AVD Workspace and VMAzure specified.

RELATED LINKS

-none-

NAME

Get-RASClientPolicyAssignment

SYNOPSIS

Retrieves information about a client policy assignment.

SYNTAX

Get-RASClientPolicyAssignment [] (uint) [()]

Get-RASClientPolicyAssignment [] (string) [()]

DESCRIPTION

Retrieves information about a client policy assignment.

PARAMETERS

Name (string)

Name of the client policy for which to retrieve the information.

Id (uint)

The ID of the client policy for which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASClientPolicyAssignment -Name PDFPolicy

Retrieves information about the assignment from a client policy named PDFPolicy.

RELATED LINKS

NAME

Get-RASClientPolicy

SYNOPSIS

Retrieves information about one or all the client policies.

SYNTAX

Get-RASClientPolicy []** (uint) [()]

Get-RASClientPolicy [[-]** (string)] [()]

DESCRIPTION

Retrieves information about one or all the client policies.

PARAMETERS

Name (string)

Name of the client policy for which to retrieve the information.

Id (uint)

The ID of the client policy for which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASClientPolicy -Name PDFPolicy

Retrieves information about the client policy named PDFPolicy. **---------- EXAMPLE 2 ----------

Get-RASClientPolicy

Retrieves information about all the client policies.

RELATED LINKS

NAME

Get-RASCertificate

SYNOPSIS

Retrieves information about one or multiple Certificates.

SYNTAX

Get-RASCertificate [[-]** (uint)] [()]

Get-RASCertificate [[-]** (string)] [[-] (uint)] [()]

DESCRIPTION

Retrieves information about one or multiple Certificates.

PARAMETERS

Name (string)

The name of the Certificate for which to retrieve the information.

SiteId (uint)

Site ID from which to retrieve the Certificate information.

Id (uint)

The ID of a Certificate for which to retrieve the information.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASCertificate

Retrieves information about all the Certificates from the Licensing Server site. **---------- EXAMPLE 2 ----------

Get-RASCertificate -Name "Cert"

Retrieves information about the Certificate specified by Name from the Licensing Server site. **---------- EXAMPLE 3 ----------

Get-RASCertificate -Id 1

Retrieves information about the Certificate specified by ID from the Licensing Server site.

RELATED LINKS

NAME

Get-RASAVDHostPoolStatus

SYNOPSIS

Retrieves the status of one or multiple Azure Virtual Desktop Host Pools.

SYNTAX

Get-RASAVDHostPoolStatus [[-] (uint)] [()]

Get-RASAVDHostPoolStatus [[-] ()] [()]

Get-RASAVDHostPoolStatus [[-] (string)] [[-] (uint)] [()]

DESCRIPTION

Retrieves information about the status of one or multiple Azure Virtual Desktop Host Pools.

The cmdlet returns an object of type AVDHostPoolStatus.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

PARAMETERS

Name (string)

The name of the AVD Host Pool for which to retrieve the status.

SiteId (uint)

Site ID from which to retrieve the specified RDS Host Pool Name.

If the parameter is omitted, the site ID of the Licensing Server will be used.

Id (uint)

The ID of the AVD Host Pool. To obtain the ID, use the Get-RASAVDHostPool cmdlet.

InputObject ()

An object of type AVDHostPool representing the AVD Host Pool.

To obtain the object, use the Get-RASAVDHostPool cmdlet.

(CommonParameters)

INPUTS

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDHostPoolStatus "My AVD Host Pool" | Format-List

Retrieves the status of the AVD Host Pool specified by name from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include all available pool properties. **---------- EXAMPLE 2 ----------

Get-RASAVDHostPoolStatus -Id 10

Retrieves the status information about the AVD Host Pool specified by Id from the Licensing Server site.

RELATED LINKS