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.

lists available API versions and changes between them.

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

Parallels Remote Application Server Requirements

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

Get-RASAppPackageSettings

NAME

Add-RASAppPackageAssigned

SYNOPSIS

NAME

Get-RASAdminSession

SYNOPSIS

Add-RASAVDHostPoolAssignment

NAME

Add-RASAVDHostPoolAssignment

SYNOPSIS

Adds a user or group to the AVD Host Pool Assignment List.

SYNTAX

Add-RASAVDHostPoolAssignment [-Id] <uint> [-Account <string>] [-SID <string>] [<CommonParameters>] Add-RASAVDHostPoolAssignment [-InputObject] <AVDHostPool> [-Account <string>] [-SID <string>] [<CommonParameters>] Add-RASAVDHostPoolAssignment [-Name] <string> [[-SiteId] <uint>] [-Account <string>] [-SID <string>] [<CommonParameters>]

DESCRIPTION

Adds a user or group to the AVD Host Pool Assignment List within an AVD 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 <AVDHostPool> 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.

NAME

Find-RASTOTPUsers

SYNOPSIS

Find TOTP users by matching substring.

SYNTAX

Find-RASTOTPUsers - <string> [- <uint>] [<>]

DESCRIPTION

Find TOTP users by matching substring.

PARAMETERS

-SiteId <uint> Site ID where the users will be searched.

-Like <string> Find users matching this pattern.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Find-RASTOTPUsers -Like "@my.domain.local" Find TOTP users matching the pattern "@my.domain.local".

RELATED LINKS

NAME

Get-RASAVDPredefinedImages

SYNOPSIS

Retrieves the predefined Azure VM images.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the predefined Azure VM images.

PARAMETERS

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDPredefinedImages Retrieves information about the predefined Azure VM images.

NAME

Get-RASAVDHostPoolAssignment

SYNOPSIS

NAME

Get-RASAVDCustomHost

SYNOPSIS

NAME

Get-RASAppPackageAvailVersions

SYNOPSIS

NAME

Get-RASAdminAccount

SYNOPSIS

NAME

Get-RASAllowedDevicesSetting

SYNOPSIS

NAME

Get-RASAVDLocation

SYNOPSIS

NAME

Get-RASClientPolicy

SYNOPSIS

NAME

Get-RASClientPolicyAssignment

SYNOPSIS

NAME

Get-RASAVDSettings

SYNOPSIS

NAME

Get-RASFarmSettings

SYNOPSIS

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

Get-RASAgent

SYNOPSIS

Retrieves RAS Agent information by server type or server name.

SYNTAX

Get-RASAgent [-] <string> [- <uint>] [<>] Get-RASAgent [[-] {RDSHost | RDS | Provider | Gateway | Guest | VDITemplate | RDSTemplate | AVDTemplate | Broker | PA | Site | RDSHostPool | RDSGroup | HALBDevice | HALB | Enrollment | TenantBroker | VDIHost | AVDHost | AVDHostPool | AVDWorkspace | All}] [- <uint>] [<>]

DESCRIPTION

Retrieves the information about RAS Agent(s) installed on a specific server or on servers of a specific type, such as. Connection Broker, RD Session Host, RAS Secure Gateway, Provider, VDI Desktop, VDI Template.

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.

-ServerType <> Specifies the server type for which to retrieve the information. Possible values: RDSHost, RDS, Provider, Gateway, Guest, VDITemplate, RDSTemplate, AVDTemplate, Broker, PA, Site, RDSHostPool, RDSGroup, HALBDevice, HALB, Enrollment, TenantBroker, VDIHost, AVDHost, AVDHostPool, AVDWorkspace, All

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAgent -Server MyRASserver Retrieves the information about Agent(s) installed on the server named 'MyRASserver'. ---------- EXAMPLE 2 ---------- Get-RASAgent Retrieves the information about all Agents from all servers in the farm. ---------- EXAMPLE 3 ---------- Get-RASAgent -ServerType RDS Retrieves the information about the Agents installed on all RD Sessions Host servers in the farm. ---------- EXAMPLE 4 ---------- Get-RASAgent -SiteId 3 -ServerType RDS Retrieves the information about the Agents installed on all RD Sessions Host servers in the farm of a specific site. ---------- EXAMPLE 5 ---------- Get-RASAgent -SiteId 3 -Server MyRASserver Retrieves the information about Agent(s) installed on the server named 'MyRASserver' from a specific site.

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.

NAME

Add-RASTOTPUsers

SYNOPSIS

Import TOTP users from a CSV file.

SYNTAX

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

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

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.

NAME

Get-RASAVDHostPool

SYNOPSIS

Retrieves information about one or multiple Azure Virtual Desktop HostPool properties.

SYNTAX

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

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop HostPool 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. This is an Experimental feature which is subject to slight changes.

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 AVDHostPool properties specified by name from the Licensing Server site. ---------- EXAMPLE 2 ---------- Get-RASAVDHostPool -Id 10 Retrieves information about the AVDHostPool specified by ID from the Licensing Server site.

NAME

Get-RASAuthSettings

SYNOPSIS

Retrieves connection settings for authentication.

SYNTAX

Get-RASAuthSettings [- <uint>] [<>]

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAuthSettings Retrieves RAS authentication settings.

NAME

Get-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure AVD.

SYNTAX

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

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

NAME

Get-RASAVDWorkspace

SYNOPSIS

Retrieves information about an Azure Virtual Desktop Workspace.

SYNTAX

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

DESCRIPTION

Retrieves information about the specified Azure Virtual Desktop Workspace or all Azure Virtual Desktop Workspaces within a site. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-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

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDWorkspace -SiteId 1 Retrieves information about all the Azure Virtual Desktop Workspaces found withing the site with ID 1. ---------- EXAMPLE 2 ---------- Get-RASAVDWorkspace "My AVDWorkspace" -SiteId 1 | Format-List Retrieves information about the Azure Virtual Desktop Workspace specified by name from the site with ID 1. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 3 ---------- Get-RASAVDWorkspace -Id 10 Retrieves information about the Azure Virtual Desktop Workspace specified by ID from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter.

NAME

Get-RASCPUOptimizationSettings

SYNOPSIS

Obtains Parallels RAS CPU Optimization settings.

SYNTAX

Get-RASCPUOptimizationSettings [- <uint>] [<>]

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

EXAMPLES

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

NAME

Get-RASBrokerAutoPromotionSettings

SYNOPSIS

Obtains Parallels RAS Broker Auto Promotion settings.

SYNTAX

Get-RASBrokerAutoPromotionSettings [[-] <uint>] [<>]

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

EXAMPLES

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

NAME

Get-RASAVDVirtualNetwork

SYNOPSIS

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

SYNTAX

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

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

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.

NAME

Get-RASClientPolicyConnection

SYNOPSIS

Retrieves the connection list

SYNTAX

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

DESCRIPTION

Retrieves the connection list

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-RASClientPolicyConnection -Id 1 Retrieves the following client policy connection with Id=1.

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.

NAME

Get-RASCustomRoute

SYNOPSIS

Retrieves information about one or multiple custom routes.

SYNTAX

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

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.

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

-Id <uint> The ID of a Custom Route for which to retrieve the information.

<CommonParameters>

INPUTS

-none-

OUTPUTS

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.

NAME

Get-RASBroker

SYNOPSIS

Retrieves information about one or multiple RAS Connection Broker servers.

SYNTAX

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

DESCRIPTION

Retrieves the information about one or multiple RAS Connection Broker servers. It returns an array of objects of type Broker, each containing properties of a RAS Connection Broker server. To see the complete list of object properties, use the Format-List cmdlet (see examples). Note: the result set contains only the major server properties; it does not include all of the settings supported in RAS.

PARAMETERS

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

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

-Id <uint> The ID of the RAS Connection Broker server for which to retrieve the information.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASBroker "server.company.dom" | Format-List Retrieves properties of the specified RAS Connection Broker server. The Format-List cmdlet formats the display output to include all available server properties. ---------- EXAMPLE 2 ---------- Get-RASBroker -Id 5 Retrieves properties of the RAS Connection Broker server specified by ID.

NAME

Get-RASEnrollmentServer

SYNOPSIS

Retrieves information about one or multiple Enrollment servers.

SYNTAX

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

DESCRIPTION

Retrieves information about one or multiple Enrollment servers.

PARAMETERS

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

-SiteId <uint> Site ID from which to retrieve the enrollment server If the parameter is omitted, the licensing server site ID will be used.

-Id <uint> ID of an enrollment server for which to retrieve the information.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASEnrollmentServer -Id 10 Retrieves information about the Enrollment server specified by its ID

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.

NAME

Get-RASADIntegrationSettings

SYNOPSIS

Obtains AD integration settings.

SYNTAX

Get-RASADIntegrationSettings [- <uint>] [<>]

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

EXAMPLES

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

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.

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.

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

NAME

Add-RASCriteriaGatewayIP

SYNOPSIS

NAME

Add-RASPrintingAutoInstallFont

SYNOPSIS

NAME

Add-RASThemeFooterURL

SYNOPSIS

NAME

Add-RASURLRedirectionEntry

SYNOPSIS

NAME

Add-RASTemplateLicenseKey

SYNOPSIS

NAME

Get-RASAVDHost

SYNOPSIS

NAME

Get-RASAVDGalleryImage

SYNOPSIS

NAME

Get-RASAVDHostPoolStatus

SYNOPSIS

NAME

Add-RASCriteriaDevice

SYNOPSIS

NAME

Get-RASCriteriaDevice

SYNOPSIS

NAME

Copy-RASPubItem

SYNOPSIS

NAME

Get-RASAgentDiagnostic

SYNOPSIS

NAME

Get-RASAVDWorkspaceStatus

SYNOPSIS

NAME

Get-RASCriteriaGatewayIP

SYNOPSIS

NAME

Get-RASEnrollmentServerStatus

SYNOPSIS

NAME

Get-RASBrokerStatus

SYNOPSIS

NAME

Get-RASCustomPermission

SYNOPSIS

NAME

Get-RASAVDPublisher

SYNOPSIS

NAME

Get-RASAVDResourceGroup

SYNOPSIS

NAME

Get-RASClientSettings

SYNOPSIS