Additional Resources

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

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

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.

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.

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-RASAVDHostPool [[-Id] <uint>] [<CommonParameters>] Get-RASAVDHostPool [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

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

AVDHostPool

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.

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.

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

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

DESCRIPTION

Adds a Gateway IP to the Criteria Gateway List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-IP <string> The IP of the gateway to add to the Criteria.

-GatewayId <uint> The ID of the gateway 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-RASCriteriaGatewayIP -Id 1 -ObjType MFA -IP "1.2.3.4" Adds the specified Gateway IP to the Criteria Gateway List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ---------- Add-RASCriteriaGatewayIP -Name "Logon1" -ObjType MFA -GatewayId 1 Adds the IP from the Gateway with specified ID to the Criteria Gateway List within the Criteria Settings of the specified MFA by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaGatewayIP

• Remove-RASCriteriaGatewayIP

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

-GroupSID <string> The group SID

-Name <string> Name of the Theme policy to modify. This must be the actual Theme policy name used in the RAS farm.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASThemeGroupFilter -Id 1 -GroupName GroupListName Adds a group filter with name GroupListName for theme with Id 1.

RELATED LINKS

• Get-RASThemeGroupFilter

• Remove-RASThemeGroupFilter

Copy-RASPubItem -Id <uint> [-ParentId <uint>] [-PreviousId <uint>] [<CommonParameters>] Copy-RASPubItem [-InputObject] <PubItem> [-ParentId <uint>] [-PreviousId <uint>] [<CommonParameters>]

DESCRIPTION

Copy (duplicate) a published item.

PARAMETERS

-Id <uint> ID of Pub item to duplicate. To obtain the pub item ID, use the Get-PubItem command.

-InputObject <PubItem> The published item object. To obtain a PubItem object representing a published item, use the Get-PubItem command.

-ParentId <uint> ID of a new parent published item. To obtain the published item ID, use the Get-PubItem command.

-PreviousId <uint> ID of a sibling item after which to place the specified published item. To obtain the sibling item ID, use the Get-PubItem command.

<CommonParameters>

INPUTS

PubItem

OUTPUTS

PubItem

EXAMPLES

---------- EXAMPLE 1 ---------- Copy-RASPubItem -Id 5 -ParentId 12 Duplicate the specified published item and it under the specified parent (ParentId). To obtain the parent item ID, use the Get-RASPubItem cmdlet. ---------- EXAMPLE 2 ---------- Copy-RASPubItem -Id 10 -ParentId 12 -PreviousId 22 Duplicate a published item and place it under the specified parent (ParentId) and after the specified sibling item (PreviousId). To obtain the parent item ID, use the Get-RASPubItem cmdlet. ---------- EXAMPLE 3 ---------- $PubItem | Copy-RASPubItem -ParentId 12 Invoke the duplicate pub item command, which is identified by an object obtained from the pipeline output. To obtain the parent item ID, use the Get-RASPubItem cmdlet.

RELATED LINKS

• Get-RASPubItem

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

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

RASAgentInfo

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.

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

Get-RASAppPackageAssigned -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-SiteId <uint>] [<CommonParameters>] Get-RASAppPackageAssigned [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<CommonParameters>] Get-RASAppPackageAssigned [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<CommonParameters>]

DESCRIPTION

Retrieves the assigned application package settings.

PARAMETERS

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

-SiteId <uint> 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 from which to retrieve the assigned application package.

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

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

AppPackageAssigned[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAppPackageAssigned -Id 1 -ObjType RDS Retrieves the assigned application package settings for the object type RDS.

Get-RASAVDHost [[-SiteId] <uint>] [-ProviderId <uint>] [<CommonParameters>] Get-RASAVDHost [-VMId] <string> [[-SiteId] <uint>] -ProviderId <uint> [<CommonParameters>]

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. This is an Experimental feature which is subject to slight changes.

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

AVDHost[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 Retrieves information about the Azure Virtual Desktop 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 Azure Virtual Desktop Hosts found within the Provider with Id 1.

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

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Publishers.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

AVDPublisher[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDPublisher -ProviderId 2 -Location "westeurope" | Format-List Retrieves all the Publishers under Azure Virtual Desktop 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-RASAVDPublisher -ProviderId 1 -Location "westeurope" -SiteId 2 Retrieves all the Publishers under Azure Virtual Desktop Provider with ID 2 and Location westeurope, from the Site with ID 2.

Add-RASPrintingAutoInstallFont -FontFilePath <string> [-ExcludeFont <SwitchParameter>] [-SiteId <uint>] [<CommonParameters>]

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

• Get-RASPrintingSettings

• Set-RASPrintingSettings

• Get-RASPrintingAutoInstallFont

• Remove-RASPrintingAutoInstallFont

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-RASAVDVMSize -Location <string> -ProviderId <uint> [-SiteId <uint>] [<CommonParameters>] Get-RASAVDVMSize -VMAzureId <string> -WorkspaceId <uint> [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop VM Size.

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.

-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

AVDVMSize[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDVMSize -ProviderId 2 -Location westeurope | Format-List Retrieves all the VM Sizes under Azure Virtual Desktop 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-RASAVDVMSize -ProviderId 1 -Location westeurope -SiteId 2 Retrieves all the VM Sizes under Azure Virtual Desktop Provider with ID 2 from the Site with ID 2. ---------- EXAMPLE 3 ---------- 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 under Azure Virtual Desktop Workspace with ID 2 from the Licensing Server site.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

RASAuthSettings

EXAMPLES

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

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-RASAVDHostPoolAssignment [[-Id] <uint>] [<CommonParameters>] Get-RASAVDHostPoolAssignment [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

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

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.

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

Find-RASTOTPUsers -Like <string> [-SiteId <uint>] [<CommonParameters>]

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

• Add-RASTOTPUsers

• Reset-RASTOTPUsers

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

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

AVDWorkspace[]

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.

Get-RASBroker [[-Id] <uint>] [<CommonParameters>] Get-RASBroker [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

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

Broker

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.

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

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

Certificate

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.

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

DESCRIPTION

Retrieves information about one or multiple custom routes. The cmdlet returns an object of type CustomRoute. Custom routes are used within published item preferred routing settings.

PARAMETERS

-Name <string> The name of the Custom Route for which to retrieve the information.

-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

CustomRoute

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCustomRoute -Name "My Custom Route" Retrieves information about the Custom Route specified by name from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. ---------- EXAMPLE 2 ---------- Get-RASCustomRoute -Id 10 Retrieves information about the Custom Route specified by ID from the Licensing Server site.