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

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

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.

© 2024 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-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>

        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

AVDPredefinedVMImage

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDPredefinedImages

Retrieves information about the predefined AVD VM images.

RELATED LINKS

• Get-RASAVDVersion

NAME

Get-RASAVDSettings

SYNOPSIS

Retrieves the Azure Virtual Desktop Features settings.

SYNTAX

Get-RASAVDSettings [-SiteId <uint>] [<CommonParameters>]

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.

        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

AVDFeaturesSettings

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDSettings

Retrieves the AVD Features Settings.

RELATED LINKS

• Set-RASAVDSettings

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

Add-RASExcludeADGroup

SYNOPSIS

Adds an Exclude AD group entry.

SYNTAX

Add-RASExcludeADGroup [- <string>] [- <string>] [- <uint>] [<>]

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.

-SID <string> The SID of the group account to add to the Exclude AD group list.

-SiteId <uint> Site ID in which to modify the specified Exclude AD group settings.

<CommonParameters>

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

NAME

Get-RASAllowedDevicesSetting

SYNOPSIS

Returns settings for types of allowed clients.

SYNTAX

Get-RASAllowedDevicesSetting [- <uint>] [<>]

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

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

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-RASAppPackageSettings

SYNOPSIS

Retrieves Application Package settings.

SYNTAX

Get-RASAppPackageSettings [- <uint>] [<>]

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAppPackageSettings

Obtains the active Application package settings for the current site.

RELATED LINKS

NAME

Get-RASAVDCustomHost

SYNOPSIS

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

SYNTAX

Get-RASAVDCustomHost - <uint> [- <SwitchParameter>] [<>]

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.

-ShowHostsInHostPool <SwitchParameter> Show Hosts in existing host pools.

<CommonParameters>

INPUTS

-none-

OUTPUTS

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-

NAME

Get-RASAVDGallery

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Galleries.

SYNTAX

Get-RASAVDGallery - <uint> [<>]

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDGallery -ProviderId 2

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

RELATED LINKS

-none-

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

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-RASAppPackage

SYNOPSIS

Retrieves the application package settings.

SYNTAX

Get-RASAppPackage [-Id] <uint> [<CommonParameters>]

Get-RASAppPackage [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

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.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of an application package from 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

AppPackage

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

• New-RASAppPackage

• Remove-RASAppPackage

• Set-RASAppPackage

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-RASAVDGalleryImage

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Gallery Images.

SYNTAX

Get-RASAVDGalleryImage -Location <string> -Name <string> -ProviderId <uint> -ResourceGroup <string> [<CommonParameters>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Gallery Images.

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

-Name <string> Name of the Azure Virtual Desktop Gallery.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ResourceGroup <string> Resource Group of the Azure Virtual Desktop Gallery Image.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Location <string> Location of the Azure Virtual Desktop Gallery Image.

        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

AVDGalleryImage

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDGalleryImage -ProviderId 2 -Location "westeurope" -Name "myGalleryImage" -ResourceGroup "myResourceGroup"

Retrieves a list of Gallery Images which fall under the Provider, Location, ProviderId and ResourceGroup specified.

RELATED LINKS

-none-

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-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-RASAVDVirtualNetwork

SYNOPSIS

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

SYNTAX

Get-RASAVDVirtualNetwork -Location <string> -ProviderId <uint> [<CommonParameters>]

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.

        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

AVDVirtualNetwork

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-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-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-RASAVDResourceGroup

SYNOPSIS

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

SYNTAX

Get-RASAVDResourceGroup -ProviderId <uint> [<CommonParameters>]

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.

        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

AVDResourceGroup

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

• New-RASAVDResourceGroup

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

Add-RASAVDHostPoolAssignment

SYNOPSIS

Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List.

SYNTAX

Add-RASAVDHostPoolAssignment [-] <uint> [- <string>] [- <string>] [<>]

Add-RASAVDHostPoolAssignment [-] <> [- <string>] [- <string>] [<>]

Add-RASAVDHostPoolAssignment [-] <string> [[-] <uint>] [- <string>] [- <string>] [<>]

DESCRIPTION

Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.

PARAMETERS

-Id <uint> ID for which to modify the Azure Virtual Desktop Host Pool settings.

-Name <string> The name of the target Azure Virtual Desktop Host Pool settings.

This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm.

-SiteId <uint> Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings .

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

-InputObject <> An object of type AVDHostPool for which to modify settings.

-Account <string> The name of the account to add to the Assignments.

-SID <string> The SID of the account to add to the Assignments.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASAVDHostPoolAssignment -Id 1 -Account "JaneDoe"

Adds a user to the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Id. ---------- EXAMPLE 2 ----------

Add-RASAVDHostPoolAssignment -Name "Logon1" -Account "SID://DOMAIN/JaneDoe"

Adds a user to the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Name.

RELATED LINKS

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

Add-RASPubAppFileExt

SYNOPSIS

Adds a file extension for the specified published application.

SYNTAX

Add-RASPubAppFileExt [-] <uint> - <string> [- <uint>] [<>]

Add-RASPubAppFileExt [-] <> - <string> [- <uint>] [<>]

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.

-Id <uint> Published resource ID.

-InputObject <> An object specifying the published resource.

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

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASPubAppFileExt -Id 3 -Extension "txt"

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

RELATED LINKS

NAME

Add-RASThemeCustomImage

SYNOPSIS

Add a theme custom image.

SYNTAX

Add-RASThemeCustomImage - <string> [- <string>] [- <uint>] [<>]

DESCRIPTION

Add a theme custom image.

PARAMETERS

-Name <string> Theme custom image name.

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

-ImageFile <string> Image file path of the image to be added to the Theme Custom Images list.

<CommonParameters>

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

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

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-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure an Azure Virtual Desktop.

SYNTAX

Get-RASAVDDefaultSettings [[-] <uint>] - {AVDMultiSessionDefaultSettings | AVDSingleSessionDefaultSettings} [<>]

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.

-DefObjType <> The Default Object Type

Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings

<CommonParameters>

INPUTS

-none-

OUTPUTS

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

NAME

Get-RASAVDHost

SYNOPSIS

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

SYNTAX

Get-RASAVDHost [[-] <uint>] [- <uint>] [<>]

Get-RASAVDHost [-] <string> [[-] <uint>] - <uint> [<>]

DESCRIPTION

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

-VMId <string> The ID of the VM for which to retrieve the information.

-ProviderId <uint> Provider Id from which to retrieve the AVD Host.

-SiteId <uint> Site ID from which to retrieve the AVD Host.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 | Format-List

Retrieves information about the AVD Host properties specified by the VMId and ProviderId.

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

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

Get-RASAVDHost -ProviderID 1

Retrieves all the AVD Hosts found within the Provider with Id 1.

RELATED LINKS

NAME

Get-RASAVDHostPool

SYNOPSIS

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

SYNTAX

Get-RASAVDHostPool [[-] <uint>] [<>]

Get-RASAVDHostPool [[-] <string>] [[-] <uint>] [<>]

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.

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

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-RASAVDSKU

SYNOPSIS

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

SYNTAX

Get-RASAVDSKU - <string> - <string> - <uint> - <string> [<>]

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.

-Location <string> Location of the Azure Virtual Desktop Provider.

-Publisher <string> The Azure Virtual Desktop Publisher.

-Offer <string> The Azure Virtual Desktop Offer.

<CommonParameters>

INPUTS

-none-

OUTPUTS

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-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-RASAVDWorkspaceStatus

SYNOPSIS

Retrieves the status of one or multiple Azure Virtual Desktop Workspaces.

SYNTAX

Get-RASAVDWorkspaceStatus [[-] <uint>] [<>]

Get-RASAVDWorkspaceStatus [[-] <>] [<>]

Get-RASAVDWorkspaceStatus [[-] <string>] [[-] <uint>] [<>]

DESCRIPTION

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

The cmdlet returns an object of type AVDWorkspaceStatus.

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

-InputObject <> An object of type AVDWorkspace representing the AVD Workspace.

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

-Name <string> The name of the Azure Virtual Desktop Workspace for which to retrieve the information.

This must be the actual Azure Virtual Desktop Workspace name.

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Workspace information.

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

-Id <uint> The ID of a Azure Virtual Desktop Workspace for which to retrieve the information.

<CommonParameters>

INPUTS

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASAVDWorkspaceStatus -ID 1 | Format-List

Retrieves the status of the AVD Workspace specified by Id.

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

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-RASCustomPermission

SYNOPSIS

Retrieves the permissions of a RAS custom admin account.

SYNTAX

Get-RASCustomPermission [-] <uint> [<>]

DESCRIPTION

Retrieves the permissions of a RAS custom admin account.

PARAMETERS

-AdminId <uint> Admin ID to retrieve the specified RAS Custom Administrator Account.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASCustomPermission -AdminId 100

Retrieves the permissions of a custom administrator specified by ID.

RELATED LINKS

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

Add-RASAppPackageAssigned

SYNOPSIS

Assigns an application package to an object type.

SYNTAX

Add-RASAppPackageAssigned -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -PackageName <string> -Version <string> [-SiteId <uint>] [<CommonParameters>]

Add-RASAppPackageAssigned [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>]

Add-RASAppPackageAssigned [-InputObject] <RASSerilazableObj> -PackageName <string> -Version <string> [<CommonParameters>]

Add-RASAppPackageAssigned [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>]

DESCRIPTION

Adds assigned application package to an object type.

PARAMETERS

-Name <string> The name for which to modify the application package assigned settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the application package assigned settings.

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 for which to modify the Application Package assigned settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <AppPackageAssignedObjType> The Object Type for which to modify the assigned application package settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <ServerDefObjType> The Default Object Type for which to modify the application package settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, RDSHostPool or VDIHostPool for which to modify the Assigned Application settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PackageName <string> The application package name.

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Version <string> The version of the application package.

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

        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-RASAppPackageAssigned -Id 3 -ObjType VDIPool -PackageName Mozilla.MozillaFireFox -Version 99.0.0.0

Adds the assigned application package to the object type VDIPool.

RELATED LINKS

• Remove-RASAppPackageAssigned

• Get-RASAppPackageAssigned

• Set-RASAppPackageAssigned

• Invoke-RASAppPackageAssigned

NAME

Add-RASMFAUsers

SYNOPSIS

Import MFA TOTP/EmailOTP users from a CSV file.

SYNTAX

Add-RASMFAUsers -FilePath <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

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".

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> 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

        Required?                    false

        Position?                    named

        Default value                TOTP

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

• Find-RASMFAUsers

• Reset-RASMFAUsers

NAME

Add-RASTemplateLicenseKey

SYNOPSIS

Modifies properties of a RAS Template license key.

SYNTAX

Add-RASTemplateLicenseKey [-Id] <uint> -Key <string> -KeyLimit <uint> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>]

Add-RASTemplateLicenseKey [-InputObject] <Template> -Key <string> -KeyLimit <uint> [<CommonParameters>]

DESCRIPTION

Modifies properties of a license key used by a RAS Template.

PARAMETERS

-Id <uint> The ID of a RAS Template to modify.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <TemplateObjType> The Object Type for which to add Template License Key.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <Template> An object of type Template representing a RAS Template.

The object is obtained using the Get-Template cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Key <string> The license key.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-KeyLimit <uint> The max limit for the license key.

        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

Template

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASTemplateLicenseKey -ObjType VDITemplate -Id 1 -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template specified by ObjType and ID. ---------- EXAMPLE 2 ----------

Add-RASTemplateLicenseKey -InputObject $Template -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template specified by the Object Type variable. ---------- EXAMPLE 3 ----------

Get-RASTemplate -ObjType VDITemplate -Id 1 | Add-RASTemplateLicenseKey -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template obtained from the pipeline output.

RELATED LINKS

• Set-RASTemplate

• Get-RASTemplateLicenseKey

• Remove-RASTemplateLicenseKey

NAME

Add-RASThemeFooterURL

SYNOPSIS

Adds a new footer URL to the footer URLs list.

SYNTAX

Add-RASThemeFooterURL [-Id] <uint> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]

Add-RASThemeFooterURL [-Name] <string> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]

DESCRIPTION

Adds a new footer URL to the footer URLs list.

PARAMETERS

-URL <string> The URL

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Text <string> The text

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Tooltip <string> The tooltip

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> Name of the Theme policy to modify.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASThemeFooterURL -Id 1 -URL link -Text text -Tooltip tooltip

Adds a footer URL to theme with Id 1.

RELATED LINKS

• Get-RASTheme

• Get-RASThemeFooterURL

• Remove-RASThemeFooterURL

NAME

Add-RASThemeGroupFilter

SYNOPSIS

Adds a new group filter to the theme group filters.

SYNTAX

Add-RASThemeGroupFilter [-Id] <uint> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]

Add-RASThemeGroupFilter [-Name] <string> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]

DESCRIPTION

Adds a new group filter to the theme group filters.

PARAMETERS

-GroupName <string> The name of the group list

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GroupSID <string> The group SID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false