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
Adds an IP to the Connection Limit IP List.
Adds a Variable to a Custom Provider.
Retrieves the Device Posture Criteria.
Retrieves information about one or multiple file access items (drives and folders).
Retrieves information about one or multiple file access drives.
Retrieves information about a file access filter.
Retrieves information about one or multiple file access folders.
Get the file access item icon.
The cmdlet returns a list of Nutanix Clusters.
The cmdlet returns a list of Nutanix Subnets.
Retrieves the Variable list of a Custom Provider.
Retrieves effective access about one user.
Invokes a command on RAS Secure Gateway.
Invoke actions on Reporting Settings.
Invokes the export clipboard URL redirection.
Moves a file access item in the File Access tree.
Adds a new file access drive.
Adds a new file access folder.
Creates new notification.
Removes an IP from the ConnectionLimit IP List.
Removes a file access item (drive or folder) from a site.
Removes a file access drive from a site.
Removes a file access folder from a site.
Removes a Variable from a Custom Provider.
Modifies the Device Posture Criteria.
Modifies properties of a file access drive.
Modifies settings of the filter within a file access item.
Modifies properties of a file access folder.
Update notification.
Modifies a Variable of a Custom Provider.
Modified Cmdlets
Get-RASAWSSubnets
The cmdlet returns a list of AWS Subnets.
Added parameters
Dropped parameters
TemplateType
Get-RASBroker
Retrieves information about one or multiple RAS Connection Broker servers.
Renamed to
Get-RASConnectionBroker
Modified output type
Get-RASBrokerAutoPromotionSettings
Obtains Parallels RAS Broker Auto Promotion settings.
Renamed to
Get-RASConnectionBrokerAutoPromotionSettings
Modified output type
Get-RASBrokerStatus
Retrieves the RAS Connection Broker status information.
Renamed to
Get-RASConnectionBrokerStatus
Modified output type
Get-RASLicenseDetails
Retrieves Parallels RAS license details.
Modified output type
Dropped parameters
UseCache
Invoke-RASBrokerPromoteToPrimary
Promotes a RAS Connection Broker to the primary Connection Broker.
Renamed to
Invoke-RASConnectionBrokerPromoteToPrimary
Invoke-RASExportCertificate
Exports a certificate to a file.
Added parameters
Invoke-RASPerformanceMonitor
Invokes an action on the Performance Monitor.
Added parameters
New-RASAVDHostPool
The cmdlet creates an object of type Azure Virtual Desktop Host Pool.
Modified output type
Added parameters
Dropped parameters
OverwriteSize
New-RASBroker
Adds a RAS Connection Broker server to a site.
Renamed to
New-RASConnectionBroker
Modified output type
New-RASProvider
Adds a Provider server to a site.
Modified output type
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
Renamed parameters
Persistent to EnableStaticAssignmentToHost
New-RASPubVDIDesktop
Adds a published VDI desktop to a site.
Modified output type
Renamed parameters
Persistent to EnableStaticAssignmentToHost
New-RASRDSHostPool
Creates a new RD Session Host Pool.
Modified output type
Added parameters
AvailabilityOptions, Throughput, OverrideCluster, OverrideStorage, AWSSubnetsIds, Size, DomainOrgUnit, OverrideSize, VolumeType, FileTransferExistingFileMode, VMSize, OverrideDomainOrgUnit, OverrideNetwork, MaximumIOPS, OverrideHighAvailability, ClusterName, AvailabilityPreferredZone, FileTransferAutoCloseWindow, FileTransferSuppressPromptForUploadFiles, SubnetId, SubnetName, DeviceName, ClusterId
Renamed parameters
PreferredBrokerObj to PreferredConnectionBrokerObj, PreferredBrokerId to PreferredConnectionBrokerId
Dropped parameters
RASTemplate, RASTemplateId, RASTemplateVersionId
New-RASSAMLIDP
Creates a new SAMLIDP.
Modified output type
Added parameters
New-RASSchedule
Creates a new Schedule.
Modified output type
Added parameters
New-RASTemplate
Creates a Template.
Modified output type
Added parameters
New-RASVDIHostPool
Creates a new VDI Host Pool.
Modified output type
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
Renamed parameters
AppMonitor to EnableAppMonitoring
Set-RASAVDHostPool
Modifies a Azure Virtual Desktop Host Pool.
Added parameters
Renamed parameters
AppMonitor to EnableAppMonitoring
Dropped parameters
OverwriteSize
Set-RASAVDSettings
Modifies the Azure Virtual Desktop Features settings.
Added parameters
Set-RASBroker
Modifies settings of a RAS Connection Broker server.
Renamed to
Set-RASConnectionBroker
Added parameters
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-RASConnectionBrokerDefaultSettings
Modifies default settings used to configure a RAS Connection Broker.
Added parameters
Set-RASCostInsightsSettings
Updates the Cost Insights Settings.
Added parameters
Set-RASCriteria
Modifies the Criteria 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
BlockedTimeout, ClientLimit, ClientTunnelingViaAPILimit, BackendLimit, UseAutoKeyboardDetect, BlockAccessDeprecatedWebAPI, HTTPLimit, WebAPISecret, BlockAccessStandardRASSessions, BlockAccessSessionLaunchCBAPI, ClientNewAuthLimit, LimitsEnabled, AllowWebSocketsWithMissingOrigin, UserPortalLimit, AllClientConnectionsLimit, WyseLimit, BlockAccessSessionLaunchWebAPI, AllConnectionsLimit, BlockAccessUserPortal
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
BlockedTimeout, BackendLimit, ClientLimit, LimitsEnabled, BlockAccessDeprecatedWebAPI, HTTPLimit, WebAPISecret, BlockAccessStandardRASSessions, BlockAccessSessionLaunchWebAPI, BlockAccessSessionLaunchCBAPI, ClientNewAuthLimit, AllowWebSocketsWithMissingOrigin, UserPortalLimit, AllClientConnectionsLimit, ClientTunnelingViaAPILimit, WyseLimit, AllConnectionsLimit, BlockAccessUserPortal, UseAutoKeyboardDetect
Renamed parameters
AutoPreferredBroker to AutoPreferredConnectionBroker, PreferredBrokerObj to PreferredConnectionBrokerObj, PreferredBrokerId to PreferredConnectionBrokerId
Set-RASPerformanceMonitorSettings
Updates the Performance Monitor Settings.
Set-RASPowerPermission
Modifies the permissions of a RAS Power admin account.
Added parameters
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
Dropped parameters
RASTemplate, RASTemplateId, RASTemplateVersionId
Set-RASSAMLIDP
Modifies a SAMLIDP.
Added parameters
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.
Added parameters
OverrideCluster, SubnetId, OverrideStorage, SubnetName, VMSize, FileTransferAutoCloseWindow, FileTransferExistingFileMode, OverrideNetwork, DomainOrgUnit, ClusterName, DriveRedirectionFileCache, EnableAppMonitoring, FileTransferSuppressPromptForUploadFiles, OverrideDomainOrgUnit, ClusterId, OverrideSize
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, DriveRedirectionFileCache, FileTransferSuppressPromptForUploadFiles
Renamed Properties
AppMonitor to EnableAppMonitoring
AVDFeaturesSettings
Added Properties
HybridEnabled
AVDHostPool
Added Properties
HybridHostPoolId, Specifications
Renamed Properties
AppMonitor to EnableAppMonitoring
Dropped Properties
OverwriteSize, VMSize
AVDHostPoolStatus
Added Properties
Workload
AVDHostSysSessionApp
Added Properties
OSUptime
Dropped Properties
ServerID
AVDVMSize
Added Properties
Name
Dropped Properties
Offering, Family, DataDisk, MaximumIOPS, TempStorage, PremiumDiskSupport
ClientRules
Added Properties
RefreshConnectionOnAppLaunch
Dropped Properties
DoNotShowDriveRedirectionDlg, GraphicsAccel, ClientWorkAreaBackground
ConnectionBroker
Added Properties
ConnectionLimits
ConnectionBrokerDefaultSiteSettings
Added Properties
ConnectionLimits
ConnectionBrokerSysInfo
Added Properties
OSUptime
CostInsightsSettings
Added Properties
Port, CertificateId
CurrentAdminPermissions
Added Properties
AllowFileAccessChanges, TimeCreate, AdminCreate, TimeLastMod, AdminLastMod
EnrollmentServer
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
EnrollmentServerStatus
Added Properties
OSUptime
Gateway
Added Properties
BlockAccessDeprecatedWebAPI, WebAPISecret, BlockAccessStandardRASSessions, BlockAccessSessionLaunchWebAPI, BlockAccessSessionLaunchCBAPI, AllowWebSocketsWithMissingOrigin, ConnectionLimits, BlockAccessUserPortal, UseAutoKeyboardDetect
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer, AllowClipboard
GatewayDefaultSiteSettings
Added Properties
BlockAccessSessionLaunchCBAPI, BlockAccessStandardRASSessions, BlockAccessDeprecatedWebAPI, BlockAccessSessionLaunchWebAPI, WebAPISecret, BlockAccessUserPortal, AllowWebSocketsWithMissingOrigin, UseAutoKeyboardDetect, ConnectionLimits
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer, AllowClipboard
GatewaySysInfo
Added Properties
OSUptime
HALBVirtualServerStatus
Dropped Properties
CPULoad, MemLoad, DiskRead, DiskWrite
HyperVProvider
Added Properties
FileTransferAutoCloseWindow, FileTransferSuppressPromptForUploadFiles, DriveRedirectionFileCache, FileTransferExistingFileMode
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer
License
Added Properties
CurrentUsers, LicenseOveruseGracePeriod, SupportExpirationDate, Username, ExpirationDate, UsageToday, ExtraInfo, BillingPeriodEnd, Company, LicenseOveruseGracePeriodDaysLeft, CurrentPeriodUsage, UpgradeInsurance, Email, FirstActivation, State, MaxConcurrentUsers, PeakUsers, PeakUsageTodayTime, PeakUsersDate, BillingPeriodStart
Dropped Properties
ExpiryDate, InstalledUsers, UsersPeak, UsersLicenseInfo, GracePeriodState, GracePeriodDaysLeft, NeedsAttention, StatusMessage, AlertMessage
LogonHours
Added Properties
DevicePosture
Dropped Properties
Chrome
MFACriteria
Added Properties
DevicePosture
Dropped Properties
Chrome
MFADeepnet
Added Properties
DevicePosture
Dropped Properties
Chrome
MFADefaultSiteSettings
Added Properties
DevicePosture
Dropped Properties
Chrome
Notification
Added Properties
Threshold, Direction
Dropped Properties
HasThreshold
PackageDetails
Added Properties
Type
PerformanceMonitorSettings
Added Properties
Username, URL
ProviderSysInfo
Added Properties
OSUptime
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
EnableOverlayIcons
RASPowerPermission
Added Properties
AllowFileAccessChanges, TimeCreate, AdminCreate, TimeLastMod, AdminLastMod
RASSessionSetting
Added Properties
LogoffSessionIdleMode
RDSDefaultSiteSettings
Added Properties
FileTransferAutoCloseWindow, DriveRedirectionFileCache, FileTransferSuppressPromptForUploadFiles, FileTransferExistingFileMode
Renamed Properties
PreferredBrokerId to PreferredConnectionBrokerId
Dropped Properties
AllowFileTransfer, AllowDragAndDrop
RDSession
Dropped Properties
ServerID
RDSHost
Added Properties
FileTransferAutoCloseWindow, DriveRedirectionFileCache, 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, AWS
RDSHostPoolStatus
Added Properties
Workload
RDSHostSysInfo
Added Properties
OSUptime
SAMLIDP
Added Properties
Mode
Schedule
Added Properties
TriggerOnlyIfSessionStateDown
SiteSysInfo
Added Properties
OSUptime
Template
Added Properties
Management, Security
Renamed Properties
SubnetID to Id, SubnetName to Name
Dropped Properties
AvailabilitySet
Theme
Added Properties
AllowedAuthTypes, OverrideAllowedAuthTypes
VDIDefaultSettings
Added Properties
FileTransferAutoCloseWindow, EnableAppMonitoring, FileTransferExistingFileMode, DriveRedirectionFileCache, FileTransferSuppressPromptForUploadFiles
VDIHostPool
Added Properties
Specifications
Dropped Properties
AWS
VDIHostSysInfo
Added Properties
OSUptime
Last updated