API Versions

Parallels RAS PowerShell - API Versions

In Parallels RAS 20.0 the PowerShell module is named RASAdmin and it supports version 4.0 (latest) and version 3.0.

Version 4.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. 3.0) when importing the module:

Import-Module RASAdmin -RequiredVersion 3.0

Versions:

• Version 3.0 - Parallels RAS 19

Includes:

• Cmdlet aliases

• Aliased parameters

• Old and new properties in the returned objects

Changes between Version 4.0 and Version 3.0

The below sections highlight the differences between Version 4.0 and Version 3.0.

• New Cmdlets

• Modified Cmdlets

• Removed Cmdlets

• Modified Outputs

New Cmdlets

Add-RASAutoUpgradeMessage	Adds schedule message information within Auto-upgrade settings.
Add-RASAVDHostPoolAssignment	Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List.
Add-RASExcludeADGroup	Adds an Exclude AD group entry.
Add-RASProviderAdminCredentials	Adds Admin Credential property to the list.
Add-RASScheduleMessage	Adds schedule message information for a Schedule.
Add-RASScheduleTarget	Adds a new Schedule target.
Add-RASTemplateLicenseKey	Modifies properties of a RAS Template license key.
Add-RASThemeCustomImage	Add a theme custom image.
Add-RASWinDeviceGroupInboundPort	Adds the Windows device group Inbound ports.
Get-RASAutoUpgrade	Retrieves the Auto-upgrade settings.
Get-RASAutoUpgradeMessage	Retrieves schedule message information from Auto-upgrade settings.
Get-RASAVDCustomHost	The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.
Get-RASAVDDefaultSettings	Retrieves default settings used to configure an Azure Virtual Desktop.
Get-RASAVDGallery	The cmdlet returns a list of Azure Virtual Desktop Galleries.
Get-RASAVDGalleryImage	The cmdlet returns a list of Azure Virtual Desktop Gallery Images.
Get-RASAVDHost	The cmdlet returns an object of type Azure Virtual Desktop Host properties.
Get-RASAVDHostPool	Retrieves information about one or multiple Azure Virtual Desktop Host Pool properties.
Get-RASAVDHostPoolAssignment	Retrieves the Azure Virtual Desktop Host Pool Assignment List.
Get-RASAVDHostPoolStatus	Retrieves the status of one or multiple Azure Virtual Desktop Host Pools.
Get-RASAVDHostStatus	Retrieves the list of, or a specific, Azure Virtual Desktop Host status.
Get-RASAVDLocation	The cmdlet returns a list of Azure Virtual Desktop Locations.
Get-RASAVDOffer	The cmdlet returns a list of Azure Virtual Desktop Offers.
Get-RASAVDPredefinedImages	Retrieves the predefined Azure Virtual Desktop VM images.
Get-RASAVDPublisher	The cmdlet returns a list of Azure Virtual Desktop Publishers.
Get-RASAVDResourceGroup	The cmdlet returns a list of Azure Virtual Desktop Resource Groups.
Get-RASAVDSettings	Retrieves the Azure Virtual Desktop Features settings.
Get-RASAVDSKU	The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.
Get-RASAVDVersion	The cmdlet retrieves a list or the latest Azure Virtual Desktop Version.
Get-RASAVDVirtualNetwork	The cmdlet returns a list of Azure Virtual Desktop Virtual Networks.
Get-RASAVDVMSize	The cmdlet returns a list of Azure Virtual Desktop VM Sizes.
Get-RASAVDWorkspace	Retrieves information about an Azure Virtual Desktop Workspace.
Get-RASAVDWorkspaceStatus	Retrieves the status of one or multiple Azure Virtual Desktop Workspaces.
Get-RASAWSSubnets	The cmdlet returns a list of Amazon Web Service Subnets.
Get-RASDevicesInfo	Retrieves Devices Info.
Get-RASExcludeADGroup	Retrieves Exclude AD group settings.
Get-RASOverwriteSupportActions	Obtains Overwrite Support Actions settings.
Get-RASProviderAdminCredentials	Retrieves the Admin Credential List.
Get-RASPubAVDApp	Retrieves information about one or multiple published applications.
Get-RASPubAVDDesktop	Retrieves information about one or multiple published desktops.
Get-RASPubLocalApp	Retrieves information about one or multiple published applications.
Get-RASSchedule	Retrieves information about one or multiple Schedule properties.
Get-RASScheduleMessage	Retrieves schedule message information for a Schedule.
Get-RASScheduleTarget	Gets a list of a Schedule's target native hosts or ids.
Get-RASTemplate	Retrieves information about one or multiple Template properties.
Get-RASTemplateLicenseKey	Retrieves the list RAS Template license keys.
Get-RASTemplateStatus	Retrieves the status of a RAS Template.
Get-RASTemplateVersion	Retrieves the settings information of one or more Template Versions.
Get-RASTemplateVersionStatus	Retrieves the Status information of one or more Template Versions.
Get-RASTenant	Retrieves information about one or multiple Tenants.
Get-RASTenantBrokerSettings	Gets the default Tenant Broker Settings.
Get-RASThemeCustomImage	Retrieve theme custom image(s).
Get-RASTrustedDomain	Retrieves the Trusted Domains.
Get-RASVDIHostPoolStatus	Retrieves the status of one or multiple VDI Host Pools.
Get-RASWinDeviceGroup	Retrieves the Windows device group.
Get-RASWinDeviceGroupInboundPort	Retrieves the Windows device group Inbound ports.
Invoke-RASAppPackageAssigned	Invokes an action on an assigned application package.
Invoke-RASAVDHost	The cmdlet invoke a command on an object of type Azure Virtual Desktop Host.
Invoke-RASCheckForUpdate	Invokes a Check For Update action.
Invoke-RASHostPool	Perform RAS Host Pool commands.
Invoke-RASPerformanceMonitor	Invokes an action on the Performance Monitor.
Invoke-RASProviderCheckCredentials	Invokes a Provider Check Credentials action.
Invoke-RASRepair	Repair Azure Virtual Desktop objects.
Invoke-RASRetryLastAction	Retry last action on template.
Invoke-RASSitePromoteToLicensing	Promotes a RAS Site to Licensing.
Invoke-RASStopOptimization	Stop optimization on specified object.
Invoke-RASTemplate	Perform RAS Template commands.
Invoke-RASTenant	The cmdlet invokes a command on an object of type Tenant. Available commands: SendInvitation, GenerateHash
Invoke-RASTenantBrokerSettings	The cmdlet invokes a command on an object of type Tenant Broker Settings. Available commands: GenerateHash
Invoke-RASTestDetectClientIP	Tests a URL that leads to a client IP detection service.
Invoke-RASVDIHost	The cmdlet invoke a command on an object of type VDI Host.
New-RASAVDHost	The cmdlet creates an object of type Azure Virtual Desktop Host.
New-RASAVDHostPool	The cmdlet creates an object of type Azure Virtual Desktop Host Pool.
New-RASAVDResourceGroup	The cmdlet creates a new object of type Azure Virtual Desktop Resource Group.
New-RASAVDWorkspace	Creates an Azure Virtual Desktop Workspace.
New-RASPubAVDApp	Adds a published AVD application to a Site.
New-RASPubAVDDesktop	Adds a published AVD desktop to a site.
New-RASPubLocalApp	Creates a published application to a Site.
New-RASSchedule	Creates a new Schedule.
New-RASTemplate	Creates a Template.
New-RASTenant	Creates a new Tenant with a new invitation.
New-RASWinDeviceGroup	Creates a Windows device group.
Remove-RASAutoUpgradeMessage	Removes an Auto-upgrade Message within Auto-upgrade settings.
Remove-RASAVDHost	The cmdlet removes an object of type Azure Virtual Desktop Host.
Remove-RASAVDHostPool	The cmdlet removes an object of type Azure Virtual Desktop Host Pool.
Remove-RASAVDHostPoolAssignment	Removes a user or group from the Azure Virtual Desktop Host Pool Assignment List.
Remove-RASAVDWorkspace	Removes an Azure Virtual Desktop Workspace.
Remove-RASExcludeADGroup	Removes an Exclude AD group entry.
Remove-RASProviderAdminCredentials	Removes admin credential property from the list.
Remove-RASPubAVDApp	Removes a published AVDapplication from a site.
Remove-RASPubAVDDesktop	Removes a published desktop from a site.
Remove-RASPubLocalApp	Removes a published application from a site.
Remove-RASSchedule	Removes a Schedule.
Remove-RASScheduleMessage	Removes a Schedule Message from a Schedule Item.
Remove-RASScheduleTarget	Removes a Schedule.
Remove-RASTemplate	Remove a Template property.
Remove-RASTemplateLicenseKey	Removes the licenses key info from a RAS Template.
Remove-RASTemplateVersion	Removes a Template version.
Remove-RASTenant	Removes a Tenant.
Remove-RASThemeCustomImage	Remove a theme custom image.
Remove-RASWinDeviceGroup	Removes a Windows device group.
Remove-RASWinDeviceGroupInboundPort	Removes the Windows device group Inbound ports.
Set-RASAutoUpgrade	Modifies the Auto-upgrade settings.
Set-RASAutoUpgradeMessage	Modifies an Auto-upgrade Message within Auto-upgrade settings.
Set-RASAVDDefaultSettings	Modifies default settings used to configure Azure Virtual Desktop.
Set-RASAVDHostPool	Modifies a Azure Virtual Desktop Host Pool.
Set-RASAVDSettings	Modifies the Azure Virtual Desktop Features settings.
Set-RASAVDWorkspace	Modifies an Azure Virtual Desktop Workspace.
Set-RASAzureMarketplaceDeploymentSettings
Set-RASMFARadiusAuto	Modifies automation settings to Radius provider settings based on Id.
Set-RASOverwriteSupportActions	Updates the Overwrite Support Actions settings.
Set-RASProviderAdminCredentials	Update Admin Credential property to the list.
Set-RASPubAVDApp	Modifies properties of a published AVD application.
Set-RASPubAVDDesktop	Modifies properties of a published desktop.
Set-RASPubLocalApp	Modifies properties of a published application.
Set-RASSchedule	Modifies a Schedule.
Set-RASScheduleMessage	Modifies a Schedule Message from a Schedule Item.
Set-RASTemplate	Modifies a Template property.
Set-RASTemplateVersion	Modifies the properties of a Template Version.
Set-RASTenant	Updates a Tenant.
Set-RASTenantBrokerSettings	Updates the default Tenant Broker Settings.
Set-RASThemeCustomImage	Modify a theme custom image.
Set-RASWinDeviceGroup	Modifies the Windows device group.

Modified Cmdlets

[TABLE]

Removed Cmdlets

Add-RASClientPolicyGateway

Add-RASClientPolicyMAC

Add-RASClientPolicyUserGroup

Add-RASPubItemClientFilter

Add-RASPubItemGatewayFilter

Add-RASPubItemIPFilter

Add-RASPubItemMACFilter

Add-RASPubItemUserFilter

Add-RASRDSScheduleMessage

Add-RASVDITemplateLicenseKey

Get-RASClientPolicyUserGroup

Get-RASPubItemClientFilter

Get-RASPubItemGatewayFilter

Get-RASPubItemIPFilter

Get-RASPubItemMACFilter

Get-RASPubItemUserFilter

Get-RASRDSSchedule

Get-RASRDSScheduleDisable

Get-RASRDSScheduleMessage

Get-RASRDSScheduleReboot

Get-RASRDSScheduleShutdown

Get-RASRDSScheduleStartup

Get-RASVDITemplate

Get-RASVDITemplateLicenseKey

Get-RASVDITemplateStatus

Invoke-RASVDITemplateCmd

New-RASRDSScheduleDisable

New-RASRDSScheduleReboot

New-RASRDSScheduleShutdown

New-RASRDSScheduleStartup

New-RASVDIGuest

New-RASVDITemplate

Remove-RASClientPolicyGateway

Remove-RASClientPolicyMAC

Remove-RASClientPolicyUserGroup

Remove-RASPubItemClientFilter

Remove-RASPubItemGatewayFilter

Remove-RASPubItemIPFilter

Remove-RASPubItemMACFilter

Remove-RASPubItemUserFilter

Remove-RASRDSGroupMember

Remove-RASRDSSchedule

Remove-RASRDSScheduleDisable

Remove-RASRDSScheduleMessage

Remove-RASRDSScheduleReboot

Remove-RASRDSScheduleShutdown

Remove-RASRDSScheduleStartup

Remove-RASVDITemplate

Remove-RASVDITemplateLicenseKey

Set-RASPubItemClientFilter

Set-RASPubItemClientOSFilter

Set-RASPubItemGatewayFilter

Set-RASPubItemIPFilter

Set-RASPubItemMACFilter

Set-RASPubItemUserFilter

Set-RASRDSScheduleDisable

Set-RASRDSScheduleMessage

Set-RASRDSScheduleReboot

Set-RASRDSScheduleShutdown

Set-RASRDSScheduleStartup

Set-RASVDIDesktop

Set-RASVDITemplate

Modified Outputs

[TABLE]