• Windows PowerShell 3.0 or higher

• Microsoft .NET Framework 4.5.2 or higher

Basic Concepts

To get started with Parallels RAS PowerShell, complete the following steps:

1. Open the Windows PowerShell console.

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

   Import-Module RASAdmin

3. Create a Parallels RAS session by executing the New-RASSession 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.

Get-RASAdminAccount [[-Id] <uint>] [<CommonParameters>] Get-RASAdminAccount [[-Name] <string>] [<CommonParameters>]

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

AdminAccount

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.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

AVDGallery[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDGallery -ProviderId 2 Retrieves a list of Galleries which fall under the Provider specified.

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.

-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

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.

Add-RASTOTPUsers -FilePath <string> [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASTOTPUsers -FilePath "users.csv" Imports TOTP users from file. Operation is done on licensing site. ---------- EXAMPLE 2 ---------- Add-RASTOTPUsers -FilePath "users.csv" -SiteId 2 Imports TOTP users from file. Operation is done on site 2.

RELATED LINKS

• Find-RASTOTPUsers

• Reset-RASTOTPUsers

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

DESCRIPTION

Retrieves default settings used to configure AVD. Default settings are defined on a site level and are applied to a AVD when it is initially created. This is an Experimental feature which is subject to slight changes.

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 <AVDDefObjType> The Default Object Type Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings

<CommonParameters>

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.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

ADIntegrationSettings

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASADIntegrationSettings Obtains the active AD integration settings for the current site.

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.

<CommonParameters>

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.

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

DESCRIPTION

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

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Virtual Network information. If the parameter is omitted, the Licensing Server site ID will be used.

-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

AVDVirtualNetwork[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" | Format-List Retrieves all the Virtual Networks found under Provider with ID 2 and Location westeurope, 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 properties. ---------- EXAMPLE 2 ---------- Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" -SiteId 1 Retrieves all the Virtual Networks found under Provider with ID 2 and Location westeurope, from site with ID 1.

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

DESCRIPTION

Retrieves the Azure Virtual Desktop Features settings. This is an Experimental feature which is subject to slight changes.

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

AVDFeaturesSettings

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDSettings Retrieves the AVD Features Settings.

Get-RASAVDCustomHost -ProviderId <uint> [-ShowHostsInHostPool <SwitchParameter>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop VMSize information. If the parameter is omitted, the Licensing Server site ID will be used.

-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

AVDCustomHost[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDCustomHost -ProviderId 2 | Format-List Retrieves all the Custom Hosts under Provider with ID 2 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 properties. ---------- EXAMPLE 2 ---------- Get-RASAVDCustomHost -ProviderId 2 -SiteId 1 Retrieves all the Custom Hosts under Provider with ID 2 from site with ID 1.

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.

<CommonParameters>

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.

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

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Resource Group. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Resource Group information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Resource Group information.

<CommonParameters>

INPUTS

-none-

OUTPUTS

AVDResourceGroup[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDResourceGroup -ProviderId 2 | Format-List Retrieves all the Resource Groups under Provider with ID 2 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 properties. ---------- EXAMPLE 2 ---------- Get-RASAVDResourceGroup -ProviderId 2 -SiteId 1 Retrieves all the Resource Groups under Provider with ID 2 from site with ID 1.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

CPUOptimizationSettings

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCPUOptimizationSettings Obtains Parallels RAS CPU optimization settings for the current session.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

BrokerAutoPromotion

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASBrokerAutoPromotionSettings Obtains Parallels RAS Auto Promote settings for the current session.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

CustomPermission

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCustomPermission -AdminId 100 Retrieves the permissions of a custom administrator specified by ID.

-none-

DESCRIPTION

Retrieves information about RAS Admin sessions.

PARAMETERS

<CommonParameters>

INPUTS

-none-

OUTPUTS

AdminSession

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAdminSession Retrieves information about RAS Admin sessions.

-none-

DESCRIPTION

The cmdlet returns the current admin permissions.

PARAMETERS

<CommonParameters>

INPUTS

-none-

OUTPUTS

CurrentAdminPermissions

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCurrentAdminPermissions Retrieves information about the current admin permissions.

Get-RASClientPolicy [-Id] <uint> [<CommonParameters>] Get-RASClientPolicy [[-Name] <string>] [<CommonParameters>]

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

ClientRules

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.

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.

-Id <uint> Published resource ID.

-InputObject <PubItem> An object specifying the published resource. To obtain the object, use the Get-PubItem cmdlet.

-SiteId <uint> Site ID.

<CommonParameters>

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

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.

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

-Id <uint> The ID for which to modify the Application Package assigned settings.

-ObjType <AppPackageAssignedObjType> The Object Type for which to modify the assigned application package settings. Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

-DefObjType <ServerDefObjType> The Default Object Type for which to modify the application package settings. Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

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

-PackageName <string> The application package name. This must be the actual application package name used in the RAS farm.

-Version <string> The version of the application package. This must be the actual application package version used in the RAS farm.

<CommonParameters>

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

Add-RASHALBDevice [[-HALBId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>] Add-RASHALBDevice [-InputObject] <HALBSettings> [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>] Add-RASHALBDevice [-HALBName] <string> [[-SiteId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

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 <HALBSettings> An object of type HALBSettings. The object is obtained using the Get-RASHALB cmdlet.

<CommonParameters>

INPUTS

HALBSettings

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

• Remove-RASHALBDevice

• Get-RASHALBDevice

• Set-RASHALBDevicePriority

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.

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

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

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

<CommonParameters>

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.

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.

-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

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-

Get-RASAVDOffer -Location <string> -ProviderId <uint> -Publisher <string> [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Offers.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop VMSize information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.

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

-Publisher <string> The Azure Virtual Desktop Publisher.

<CommonParameters>

INPUTS

-none-

OUTPUTS

AVDOffer[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDOffer -ProviderId 2 -Location "westeurope" -Publisher "publisher-server" | Format-List Retrieves the Offer that Azure Virtual Desktop Provider with ID 2, Location westeurope and Publisher publisher-server, 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 properties. ---------- EXAMPLE 2 ---------- Get-RASAVDOffer -ProviderId 1 -Location "westeurope" -Publisher "publisher-server" -SiteId 2 Retrieves the Offer under Azure Virtual Desktop Provider with ID 2 and Location westeurope and Publisher publisher-server, from the Site with ID 2.

Add-RASCriteriaDevice [-DefObjType] {MFA} [[-SiteId] <uint>] -ClientDeviceName <string> [<CommonParameters>] Add-RASCriteriaDevice [-Id] <uint> -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaDevice [-InputObject] <RASListObj> -ClientDeviceName <string> [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaDevice [-Name] <string> [[-SiteId] <uint>] -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Adds a Client Device to the Criteria Device List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-ClientDeviceName <string> The name of the client device to add to the Criteria.

-Name <string> The name or server for which to modify the Criteria settings.

-SiteId <uint> Site ID for which to modify the Criteria settings. If the parameter is omitted, the Licensing Server site ID will be used.

-Id <uint> The ID of a server for which to modify the Criteria settings.

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. Possible values: MFA

-RuleId <uint> The ID of the Rule to modify.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASCriteriaDevice -Id 1 -ObjType LogonHours -ClientDeviceName "Device1" Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ---------- Add-RASCriteriaDevice -Name "Logon1" -ObjType LogonHours -ClientDeviceName "Device1" Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaDevice

• Remove-RASCriteriaDevice

Get-RASBrokerStatus [[-Id] <uint>] [<CommonParameters>] Get-RASBrokerStatus [[-InputObject] <Broker>] [<CommonParameters>] Get-RASBrokerStatus [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the RAS Connection Broker status information.

PARAMETERS

-Server <string> The name of the server for which to retrieve the information. This must be the actual server name used in the RAS farm.

-SiteId <uint> Site ID from which to retrieve the specified RAS Connection Broker info. If the parameter is omitted, the site ID of the Licensing Server will be used.

-Id <uint> The ID of the server for which to retrieve the information. To obtain the ID, use the Get-RASBroker cmdlet.

-InputObject <Broker> An object of type Broker representing a server for which to retrieve the information. To obtain the object, use the Get-RASBroker cmdlet.

<CommonParameters>

INPUTS

Broker

OUTPUTS

BrokerSysInfo

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASBrokerStatus -Id 15 Retrieves the RAS Connection Broker status information for the server with ID 15. ---------- EXAMPLE 2 ---------- Get-RASBrokerStatus -Server MyBroker Retrieves the RAS Connection Broker status information for the server named "MyBroker". ---------- EXAMPLE 3 ---------- Get-RASBrokerStatus -InputObject $Broker Retrieves the RAS Connection Broker status information for the server represented by the $Broker object. ---------- EXAMPLE 4 ---------- Get-RASBroker -Id 15 | Get-RASBrokerStatus Retrieves the RAS Connection Broker status information for the server represented by the $Broker object obtained from pipeline output.

Get-RASAVDHostPoolStatus [[-Id] <uint>] [<CommonParameters>] Get-RASAVDHostPoolStatus [[-InputObject] <AVDHostPool>] [<CommonParameters>] Get-RASAVDHostPoolStatus [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about the status of one or multiple AVD 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 <AVDHostPool> An object of type AVDHostPool representing the AVD Host Pool. To obtain the object, use the Get-RASAVDHostPool cmdlet.

<CommonParameters>

INPUTS

AVDHostPool

OUTPUTS

AVDHostPoolStatus

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDHostPoolStatus "My AVD Host Pool" | Format-List Retrieves the status of the 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 information about the pool specified by ID from the Licensing Server site.

Get-RASAVDHostPoolAssignment [[-Id] <uint>] [<CommonParameters>] Get-RASAVDHostPoolAssignment [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the AVD Host Pool Assignment List within the AVD 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

Assignment[]

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.

Get-RASAVDWorkspaceStatus [[-Id] <uint>] [<CommonParameters>] Get-RASAVDWorkspaceStatus [[-InputObject] <AVDWorkspace>] [<CommonParameters>] Get-RASAVDWorkspaceStatus [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about the status of one or multiple AVD 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 <AVDWorkspace> 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

AVDWorkspace

OUTPUTS

AVDWorkspaceStatus

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDWorkspaceStatus -ID 1 | Format-List Retrieves the status of the Workspace specified by Id. The Format-List cmdlet formats the display output to include all available Workspace properties.

Add-RASThemeCustomImage -ImageFile <string> [-Name <string>] [-SiteId <uint>] [<CommonParameters>]

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 custom images of the Licensing site.