API Versions
In Parallels RAS 21.2 the PowerShell module is named RASAdmin and it supports version 5.0 (latest) and version 4.0.
Version 5.0
This version is the one loaded by default by the system or if the RequiredVersion is not specified when importing the module.
Backward Compatibility
This version keeps backward compatibility with the older RASAdmin modules found in previous versions. It allows administrators to use existing scripts with minor modification.
To make use of a previous version, one needs to specify the RequiredVersion (eg. 4.0) when importing the module:
Import-Module RASAdmin -RequiredVersion 4.0Versions:
Version 5.0 - Parallels RAS 21.2 onwards
Version 4.0 - Parallels RAS 19.3 - 21.1
Includes:
Cmdlet aliases
Aliased parameters
Old and new properties in the returned objects
Changes between Version 5.0 and Version 4.0
The below sections highlight the differences between Version 5.0 and Version 4.0.
New Cmdlets
Retrieves effective access about one user.
Invoke actions on Reporting Settings.
Creates new notification.
Update notification.
Modified Cmdlets
Get-RASAVDVMSize
The cmdlet returns a list of Azure Virtual Desktop VM Sizes.
Modified output type
[AzureVMSize](#azurevmsize)
Get-RASBroker
Retrieves information about one or multiple RAS Connection Broker servers.
Renamed to
Get-RASConnectionBroker
Modified output type
[ConnectionBroker](#connectionbroker)
Get-RASBrokerAutoPromotionSettings
Obtains Parallels RAS Broker Auto Promotion settings.
Renamed to
Get-RASConnectionBrokerAutoPromotionSettings
Modified output type
[ConnectionBrokerAutoPromotion](#connectionbrokerautopromotion)
Get-RASBrokerStatus
Retrieves the RAS Connection Broker status information.
Renamed to
Get-RASConnectionBrokerStatus
Modified output type
[ConnectionBrokerSysInfo](#connectionbrokersysinfo)
Invoke-RASBrokerPromoteToPrimary
Promotes a RAS Connection Broker to the primary Connection Broker.
Renamed to
Invoke-RASConnectionBrokerPromoteToPrimary
New-RASAVDHostPool
The cmdlet creates an object of type Azure Virtual Desktop Host Pool.
Modified output type
[AVDHostPool](#avdhostpool)
Added parameters
New-RASBroker
Adds a RAS Connection Broker server to a site.
Renamed to
New-RASConnectionBroker
Modified output type
[ConnectionBroker](#connectionbroker)
New-RASProvider
Adds a Provider server to a site.
Modified output type
[HyperVProvider](#hypervprovider)
Added parameters
Renamed parameters
PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Dropped parameters
Dummy DummyVersion
New-RASPubVDIApp
Adds a published VDI application to a Site.
Modified output type
[PubVDIApp](#pubvdiapp)
Renamed parameters
Persistent to EnableStaticAssignmentToHost
New-RASPubVDIDesktop
Adds a published VDI desktop to a site.
Modified output type
[PubVDIDesktop](#pubvdidesktop)
Renamed parameters
Persistent to EnableStaticAssignmentToHost
New-RASRDSHostPool
Creates a new RD Session Host Pool.
Modified output type
[RDSHostPool](#rdshostpool)
Added parameters
Renamed parameters
PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
New-RASSchedule
Creates a new Schedule.
Modified output type
[Schedule](#schedule)
Added parameters
New-RASTemplate
Creates a Template.
Modified output type
[Template](#template)
Added parameters
New-RASVDIHostPool
Creates a new VDI Host Pool.
Modified output type
[VDIHostPool](#vdihostpool)
Added parameters
Remove-RASBroker
Removes a RAS Connection Broker server from a site.
Renamed to
Remove-RASConnectionBroker
Set-RASAllowedDevicesSetting
Modifies the types of clients that are allowed to connect.
Dropped parameters
AllowClientChromeApp MinBuildChromeApp
Set-RASAVDDefaultSettings
Modifies default settings used to configure Azure Virtual Desktop.
Added parameters
Set-RASAVDHostPool
Modifies a Azure Virtual Desktop Host Pool.
Added parameters
Set-RASBroker
Modifies settings of a RAS Connection Broker server.
Renamed to
Set-RASConnectionBroker
Set-RASBrokerAutoPromotionSettings
Modifies Parallels RAS Broker Auto Promotion settings.
Renamed to
Set-RASConnectionBrokerAutoPromotionSettings
Set-RASBrokerPriority
Change the priority of a RAS Connection Broker server.
Renamed to
Set-RASConnectionBrokerPriority
Set-RASClientPolicy
Modifies settings of a client policy.
Added parameters
Dropped parameters
DoNotShowDriveRedirectionDlg GraphicsAccel ClientWorkAreaBackground
Set-RASClientSettings
Update RAS client settings.
Dropped parameters
ExcludeTunnelSessions
Set-RASCostInsightsSettings
Updates the Cost Insights Settings.
Added parameters
Set-RASCriteriaOS
Modifies the Operating System Criteria.
Dropped parameters
AllowClientChrome
Set-RASEnrollmentServer
Modifies an Enrollment server.
Renamed parameters
PreferredBrokerId to PreferredConnectionBrokerId
Set-RASGateway
Modifies properties of a RAS Secure Gateway.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASGatewayDefaultSettings
Modifies default settings used to configure a RAS Secure Gateway.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASProvider
Modifies Provider server settings.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASPubVDIApp
Modifies properties of a published VDI application.
Renamed parameters
Persistent to EnableStaticAssignmentToHost
Set-RASPubVDIDesktop
Modifies properties of a published desktop.
Renamed parameters
Persistent to EnableStaticAssignmentToHost
Set-RASRDSDefaultSettings
Modifies default settings used to configure an RD Session Host server.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASRDSHost
Modifies RD Session Host server settings.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASRDSHostPool
Modifies an RD Session Host Pool.
Added parameters
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker PreferredBrokerObj to PreferredConnectionBrokerObj PreferredBrokerId to PreferredConnectionBrokerId
Set-RASSchedule
Modifies a Schedule.
Added parameters
Set-RASSessionSetting
Modifies Parallels RAS session connection settings.
Added parameters
Set-RASTemplate
Modifies a Template property.
Added parameters
Set-RASTheme
Modifies settings of a theme.
Added parameters
Set-RASVDIDefaultSettings
Modifies default settings used to configure a host VM.
Added parameters
Set-RASVDIHostPool
Modifies a VDI Host Pool.
Removed Cmdlets
Get-RASNotificationEvent
Get-RASNotificationResource
New-RASNotificationEvent
New-RASNotificationResource
Remove-RASNotificationEvent
Remove-RASNotificationResource
Set-RASNotificationEvent
Set-RASNotificationResource
Modified Outputs
AllowedOperatingSystems
Dropped Properties
Chrome
AppPackage
Added Properties
Type
AVDDefaultSettings
Added Properties
FileTransferAutoCloseWindow FileTransferExistingFileMode FileTransferSuppressPromptForUploadFiles
AVDHostPool
Added Properties
Specifications
Dropped Properties
OverwriteSize VMSize
AzureVMSize
Added Properties
Name
Dropped Properties
Offering Family DataDisk MaximumIOPS TempStorage PremiumDiskSupport
ClientRules
Added Properties
KybdMapRightOption KybdMapLeftOption KybdMapLeftShift KybdMapRightShift
Dropped Properties
DoNotShowDriveRedirectionDlg GraphicsAccel ClientWorkAreaBackground
CostInsightsSettings
Added Properties
Port
CurrentAdminPermissions
Added Properties
AdminCreate TimeCreate TimeLastMod AdminLastMod
EnrollmentServer
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Gateway
Added Properties
BlockAccessStandardRASSessions BlockAccessSessionLaunchWebAPI BlockAccessSessionLaunchCBAPI BlockAccessUserPortal UseAutoKeyboardDetect
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer AllowClipboard
GatewayDefaultSiteSettings
Added Properties
BlockAccessSessionLaunchCBAPI BlockAccessStandardRASSessions BlockAccessSessionLaunchWebAPI BlockAccessUserPortal UseAutoKeyboardDetect
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer AllowClipboard
HALBVirtualServerStatus
Dropped Properties
CPULoad MemLoad DiskRead DiskWrite
HyperVProvider
Added Properties
FileTransferAutoCloseWindow FileTransferSuppressPromptForUploadFiles FileTransferExistingFileMode
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer
License
Added Properties
ExtraInfo
LogonHours
Dropped Properties
Chrome
MFACriteria
Dropped Properties
Chrome
MFADeepnet
Dropped Properties
Chrome
MFADefaultSiteSettings
Dropped Properties
Chrome
Notification
Added Properties
Threshold Direction
Dropped Properties
HasThreshold
PackageDetails
Added Properties
Type
ProviderSysInfo
Renamed Properties
PreferredBroker to ConnectedConnectionBroker
PubItemCriteria
Dropped Properties
Chrome
PubItemRule
Dropped Properties
Chrome
PubVDIApp
Renamed Properties
Persistent to EnableStaticAssignmentToHost
PubVDIDesktop
Renamed Properties
Persistent to EnableStaticAssignmentToHost
RASAllowedDevicesSetting
Dropped Properties
AllowClientChromeApp MinBuildChromeApp
RASClientSettings
Dropped Properties
ExcludeTunnelSessions
RASPowerPermission
Added Properties
AdminCreate TimeCreate TimeLastMod AdminLastMod
RASSessionSetting
Added Properties
LogoffSessionIdleMode
RDSDefaultSiteSettings
Added Properties
FileTransferAutoCloseWindow FileTransferSuppressPromptForUploadFiles FileTransferExistingFileMode
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer AllowDragAndDrop
RDSHost
Added Properties
FileTransferAutoCloseWindow FileTransferSuppressPromptForUploadFiles FileTransferExistingFileMode
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer AllowDragAndDrop
RDSHostPool
Added Properties
ProvisioningType Specifications
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer AllowDragAndDrop
Schedule
Added Properties
TriggerOnlyIfSessionStateDown
Template
Added Properties
NutanixPC
Dropped Properties
AvailabilitySet
Theme
Added Properties
UseAutoKeyboardDetect
VDIDefaultSettings
Added Properties
FileTransferExistingFileMode FileTransferAutoCloseWindow FileTransferSuppressPromptForUploadFiles
VDIHostPool
Added Properties
Specifications
Last updated