1 of 100

RAS_20_PowerShell_API

Parallels RAS PowerShell

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:

lists system requirements and explains basic RAS PowerShell concepts.

is a complete reference to RAS PowerShell cmdlets.

lists available API versions and changes between them.

Getting Started

Parallels RAS PowerShell - Getting Started

Parallels Remote Application Server Requirements

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

Microsoft Windows Component Requirements

The following components must be installed on the computer where you'll be executing Parallels RAS PowerShell cmdlets:

Windows PowerShell 3.0 or higher
Microsoft .NET Framework 4.5.2 or higher

Basic Concepts

To get started with Parallels RAS PowerShell, complete thefollowing steps:

Open the Windows PowerShell console.
In the console, type the following command to import the Parallels RAS PowerShell module:
Import-Module RASAdmin
Create a Parallels RAS session by executing the cmdlet. Substitute the server name (in quotes) with the name or IP address of your Parallels RAS Licensing Server. Type your RAS administrator username and password when prompted.
New-RASSession -Server "server.company.dom"

Parallels RAS Powershell Admin Module

Commands

Add-RASExcludeADGroup.md

NAME

Add-RASExcludeADGroup

SYNOPSIS

Adds an Exclude AD group entry.

Get-RASADIntegrationSettings.md

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.

Get-RASAdminSession.md

NAME

Get-RASAdminSession

SYNOPSIS

Retrieves information about RAS Admin sessions.

SYNTAX

-none-

DESCRIPTION

Retrieves information about RAS Admin sessions.

PARAMETERS

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAdminSession

Retrieves information about RAS Admin sessions.

Get-RASAllowedDevicesSetting.md

NAME

Get-RASAllowedDevicesSetting

SYNOPSIS

Returns settings for types of allowed clients.

Get-RASAppPackageAvailVersions.md

NAME

Get-RASAppPackageAvailVersions

SYNOPSIS

Retrieves the application package version.

Get-RASAppPackageSettings.md

NAME

Get-RASAppPackageSettings

SYNOPSIS

Retrieves Application Package settings.

Get-RASAuthSettings.md

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.

Get-RASAVDCustomHost.md

NAME

Get-RASAVDCustomHost

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

SYNTAX

**Get-RASAVDCustomHost - (uint) [ (SwitchParameter)] [()]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.

PARAMETERS

ProviderId (uint)

Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information.

ShowHostsInHostPool (SwitchParameter)

Show Hosts in existing host pools.

(CommonParameters)

INPUTS

-none-

OUTPUTS

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASAVDCustomHost -ProviderId 2 | Format-List

Retrieves all the Custom Hosts under the Provider with ID 2.

The Format-List cmdlet formats the display output to include all available properties.

-none-

Get-RASAVDDefaultSettings.md

NAME

Get-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure an Azure Virtual Desktop.

Get-RASAVDGallery.md

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.

-none-

Get-RASAVDOffer.md

NAME

Get-RASAVDOffer

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Offers.

Get-RASAVDPredefinedImages.md

NAME

Get-RASAVDPredefinedImages

SYNOPSIS

Retrieves the predefined Azure Virtual Desktop VM images.

Get-RASAVDVirtualNetwork.md

NAME

Get-RASAVDVirtualNetwork

SYNOPSIS

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

SYNTAX

**Get-RASAVDVirtualNetwork - (string) - (uint) [()]

DESCRIPTION

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

PARAMETERS

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 the Provider with ID 2 and Location westeurope.

The Format-List cmdlet formats the display output to include all available properties.

-none-

Get-RASAWSSubnets.md

NAME

Get-RASAWSSubnets

SYNOPSIS

The cmdlet returns a list of Amazon Web Service Subnets.

Get-RASBrokerAutoPromotionSettings.md

NAME

Get-RASBrokerAutoPromotionSettings

SYNOPSIS

Obtains Parallels RAS Broker Auto Promotion settings.

Get-RASClientSettings.md

NAME

Get-RASClientSettings

SYNOPSIS

Retrieves the Parallels RAS client settings.

Get-RASCPUOptimizationSettings.md

NAME

Get-RASCPUOptimizationSettings

SYNOPSIS

Obtains Parallels RAS CPU Optimization settings.

Add-RASMFARadiusAttr.md

NAME

Add-RASMFARadiusAttr

SYNOPSIS

Adds attribute settings to Radius provider settings.

SYNTAX

**Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [] (uint) - (uint) - (string) - (string) - (string) - (uint) [()]

**Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [-] () - (uint) - (string) - (string) - (string) - (uint) [()]

**Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [] (string) [[-] (uint)] - (uint) - (string) - (string) - (string) - (uint) [()]

DESCRIPTION

The cmdlet appends new attribute settings to existing ones. All parameters are mandatory.

PARAMETERS

VendorID (uint)

RADIUS attribute vendor ID

AttributeID (uint)

RADIUS attribute ID

Value (string)

RADIUS attribute value

The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

RadiusAttrName (string)

RADIUS attribute name

Vendor (string)

RADIUS attribute vendor name

AttributeType ()

RADIUS attribute type. IP, string, number, or time

Possible values: Number, String, IP, Time

Name (string)

The name of the target multi-factor authentication .

This must be the actual multi-factor authentication name used in the RAS farm.

SiteId (uint)

Site ID in which to modify the specified multi-factor authentication .

If the parameter is omitted, the site ID of the Licensing Server will be used.

Id (uint)

The ID of the multi-factor authentication to modify. To obtain the ID, use the Get-RASMFA cmdlet.

InputObject ()

The multi factor authentication to modify.

To obtain an object of type MFA, use the Get-RASMFA cmdlet.

(CommonParameters)

INPUTS

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASMFARadiusAttr -AttributeType IP -VendorID 1 -AttributeID 1 -Value 127.0.0.1 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type IP. The "Value" parameter must be in a valid IP format (IPv4 only). **---------- EXAMPLE 2 ----------

Add-RASMFARadiusAttr -AttributeType String -VendorID 1 -AttributeID 1 -Value "This is a string" -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type String. The "Value" parameter can contain a character of any type, but cannot be empty. **---------- EXAMPLE 3 ----------

Add-RASMFARadiusAttr -AttributeType Number -VendorID 1 -AttributeID 1 -Value 42 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type Number. The "Value" parameter must contain numbers. The input can also be a string but must contain numbers only. **---------- EXAMPLE 4 ----------

Add-RASMFARadiusAttr -AttributeType Time -VendorID 1 -AttributeID 1 -Value 1500892318 -Name AttrName -Vendor VendorName

Adds a new entry to Radius attributes of type Time. The "Value" parameter represents the date using the epoch time format.

Add-RASImageOptimizationRegistry.md

NAME

Add-RASImageOptimizationRegistry

SYNOPSIS

Adds Registry property to the list.

SYNTAX

**Add-RASImageOptimizationRegistry - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - (string) - (string) [- {Add | Modify | Delete}] [ (uint)] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [ (string)] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [ (uint)] [ (string)] [()]

**Add-RASImageOptimizationRegistry [] (uint) - (string) - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - (string) [- {Add | Modify | Delete}] [ (uint)] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [ (string)] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [ (string)] [()]

**Add-RASImageOptimizationRegistry [-] () - (string) - (string) [- {Add | Modify | Delete}] [ (uint)] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [ (string)] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [ (string)] [()]

**Add-RASImageOptimizationRegistry [] (string) [[-] (uint)] - (string) - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - (string) [- {Add | Modify | Delete}] [ (uint)] [- {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [ (string)] [- {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [ (string)] [()]

DESCRIPTION

Adds Registry to the following list.

PARAMETERS

Action ()

Possible values: Add, Modify, Delete

RegistryName (string)

DWORDValue (uint)

DisplayName (string)

HiveType ()

Possible values: HKEY_CURRENT_CONFIG, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT

Path (string)

RegType ()

Possible values: REG_SZ, REG_DWORD, REG_QWORD, REG_MULTI_SZ, REG_EXPAND_SZ

StringValue (string)

Name (string)

The name or server for which to modify the Image Optimization settings.

SiteId (uint)

Site ID from which to modify the Image Optimization 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 Image Optimization settings.

InputObject

() An object of type RDS, VDITemplate or VDIDesktop for which to modify the Image Optimization settings.

ObjType

() The Object Type for which to modify the Image Optimization settings.

Possible values: RDSHost, RDS, VDIHostPool, AVDHostPool, RDSTemplate, VDITemplate, AVDTemplate

DefObjType ()

The Default Object Type for which to modify the Image Optimization settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASImageOptimizationRegistry -Id 30 -ObjType RDS -Action Add -RegistryName "Name" -DWORDValue 1 -DisplayName HKEY_test -HiveType HKEY_CURRENT_CONFIG -Path System\CurrentControlSet\Services\Disk -RegType REG_SZ

Adds the Image Optimization Registry of the Object Type 'RDS'.

Add-RASFSLogixCCDLocation.md

NAME

Add-RASFSLogixCCDLocation

SYNOPSIS

Adds a CCDLocation to a CCDLocation List of the Profile Container.

SYNTAX

**Add-RASFSLogixCCDLocation - (string) - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - (SwitchParameter) [ (uint)] [()]

**Add-RASFSLogixCCDLocation [] (uint) - (string) - (SwitchParameter) - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [()]

**Add-RASFSLogixCCDLocation [] (uint) - (string) - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - (SwitchParameter) [()]

**Add-RASFSLogixCCDLocation [-] () - (string) - (SwitchParameter) [()]

**Add-RASFSLogixCCDLocation [] (string) [[-] (uint)] - (string) - (SwitchParameter) - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [()]

**Add-RASFSLogixCCDLocation [] (string) [[-] (uint)] - (string) - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - (SwitchParameter) [()]

DESCRIPTION

Adds a CCDLocation to a CCDLocation List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults

PARAMETERS

CCDLocation (string)

Specifies the 'CCDLocation' path to add to the CCDLocation List.

Name (string)

The name or server for which to modify the FSLogix settings.

SiteId (uint)

Site ID from which to modify the FSLogix 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 FSLogix settings.

InputObject

() An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.

ObjType

() The Object Type for which to modify the FSLogix settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

DefObjType ()

The Default Object Type for which to modify the FSLogix settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

ProfileContainer (SwitchParameter)

Set the Profile Container settings.

OfficeContainer (SwitchParameter)

Sets the Office Container settings.

GeneralSettings (SwitchParameter)

Sets the General settings.

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASFSLogixCCDLocation -DefObjType RDSDef -ProfileContainer -CCDLocation "type=smb,connectionString=Location1"

Adds a CCDLocation to the CCDLocation List of the Profile Container within the FSLogix Settings of the RDS Default Settings.

Add-RASFSLogixFolder.md

NAME

Add-RASFSLogixFolder

SYNOPSIS

Adds a folder to an Inclusion/Exclusion List of the Profile Container.

SYNTAX

**Add-RASFSLogixFolder - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - (string) - {Inclusion | Exclusion} [- {None | CopyBase | CopyBack}] [ (uint)] [()]

**Add-RASFSLogixFolder - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - (string) - {Inclusion | Exclusion} - (SwitchParameter) [- {None | CopyBase | CopyBack}] [ (uint)] [()]

Add-RASFSLogixFolder [] (uint) - (string) - {Inclusion | Exclusion} - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [- {None | CopyBase | CopyBack}] [()]

Add-RASFSLogixFolder [] (uint) - (string) - {Inclusion | Exclusion} - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - (SwitchParameter) [- {None | CopyBase | CopyBack}] [()]

**Add-RASFSLogixFolder [-] () - (string) - {Inclusion | Exclusion} [- {None | CopyBase | CopyBack}] [()]

**Add-RASFSLogixFolder [-] () - (string) - {Inclusion | Exclusion} - (SwitchParameter) [- {None | CopyBase | CopyBack}] [()]

Add-RASFSLogixFolder [] (string) [[-] (uint)] - (string) - {Inclusion | Exclusion} - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [- {None | CopyBase | CopyBack}] [()]

Add-RASFSLogixFolder [] (string) [[-] (uint)] - (string) - {Inclusion | Exclusion} - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - (SwitchParameter) [- {None | CopyBase | CopyBack}] [()]

DESCRIPTION

Adds a folder to an Inclusion/Exclusion List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults.

PARAMETERS

ExcludeFolderCopy

() Specifies the 'Exclude Folder Copy', in case of adding to the Exclude Folder List.

Possible values: None, CopyBase, CopyBack

FolderListType

() Specifies the 'Folder List Type'.

Possible values: Inclusion, Exclusion

Folder (string)

Specifies the 'Folder' path to add to the Include/Exclude Folder List.

Name (string)

The name or server for which to modify the FSLogix settings.

SiteId (uint)

Site ID from which to modify the FSLogix 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 FSLogix settings.

InputObject

() An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.

ObjType

() The Object Type for which to modify the FSLogix settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

DefObjType ()

The Default Object Type for which to modify the FSLogix settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

ProfileContainer (SwitchParameter)

Set the Profile Container settings.

(CommonParameters)

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASFSLogixFolder -DefObjType RDSDef -ProfileContainer -FolderListType Inclusion -Folder "C:/Test1"

Adds a folder to the Inclusion List of the Profile Container within the FSLogix Settings of the RDS Default Settings. **---------- EXAMPLE 2 ----------

Add-RASFSLogixFolder -Name "RDSHostPool1" -ObjType RDSHostPool -ProfileContainer -FolderListType Exclusion -Folder "C:/Test2"

Adds a folder to the Exclusion List of the Profile Container within the FSLogix Settings of the specified RDSHostPool by Name.

Add-RASVDIHostPoolMember.md

NAME

Add-RASVDIHostPoolMember

SYNOPSIS

Adds one or multiple VDI Host Pool Members to a standalone VDI Host Pool.

SYNTAX

**Add-RASVDIHostPoolMember [] (uint) - (string) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [ (string)] [ (SwitchParameter)] [ (uint)] [ (string)] [- (List`1)] [()]

**Add-RASVDIHostPoolMember [] (uint) - (string) - (SecureString) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} - (string) [ (string)] [ (uint)] [ (string)] [- (List`1)] [()]

**Add-RASVDIHostPoolMember [-] () - (string) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [ (string)] [ (SwitchParameter)] [ (uint)] [ (string)] [- (List`1)] [()]

**Add-RASVDIHostPoolMember [-] () - (string) - (SecureString) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} - (string) [ (string)] [ (uint)] [ (string)] [- (List`1)] [()]

**Add-RASVDIHostPoolMember [] (string) [[-] (uint)] - (string) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [ (string)] [ (SwitchParameter)] [ (uint)] [ (string)] [- (List`1)] [()]

**Add-RASVDIHostPoolMember [] (string) [[-] (uint)] - (string) - (SecureString) - {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} - (string) [ (string)] [ (uint)] [ (string)] [- (List`1)] [()]

DESCRIPTION

Adds one or multiple VDI Host Pool Members to an existing standalone VDI Host Pool.

PARAMETERS

VDIHostPoolName (string)

The VDI Host Pool name.

SiteId (uint)

Site ID where the VDI Host Pool is located.

If the parameter is omitted, the site ID of the Licensing Server will be used.

VDIHostPoolId (uint)

The VDI Host Pool ID.

InputObject ()

An object of type VDIHostPool identifying the target VDI Host Pool.

The object is obtained using the Get-RASVDIHostPool cmdlet.

Type ()

The VDI Host Pool Member Type.

The type can either be: ALLGUESTSINPROVIDER, GUEST, NATIVEPOOL, TEMPLATEGUEST or TEMPLATEVERSION.

Possible values: AllHostsInProvider, AllGuestsInProvider, Host, Guest, NativePool, Template, TemplateGuest, TemplateVersion

Name (string)

The VDI Host Pool Member Name.

ProviderId (uint)

The VDI Host Pool Member Provider ID.

This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.

VMId (string)

The VDI Host Pool Member Guest ID.

This parameter is only accepted with Type: GUEST.

NativePoolId (string)

The VDI Host Pool Member Native Pool ID.

This parameter is only accepted with Type: NATIVEPOOL.

NoInstall (SwitchParameter)

Specifies not to install the RAS Guest Agent on the server.

If this parameter is omitted, the agent will be push installed in the VM using your RAS admin credentials.

To specify different credentials for push installation, use the Username and Password parameters.

This parameter can be used in situations when the RAS Guest Agent is already installed in a VM, but the VM is powered down.

By including this parameter, you will simply power up the VM and make it available for Parallels RAS operations.

Username (string)

An administrator account for push installing the RAS Guest Agent in the VM.

If this parameter is omitted, your RAS admin username (and password) will be used.

Password (SecureString)

The password of the account specified in the Username parameter.

VMIds (List`1)

The VDI Host Pool Member Desktops IDs.

This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

(CommonParameters)

INPUTS

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type ALLGUESTSONPROVIDER -Name "MY VDI Host Pool Member" -ProviderId 1

Adds the specified VDI Host Pool Member to the specified standalone VDI Host Pool.

The Type ALLGUESTSONPROVIDER requires the ProviderId to be specified. **---------- EXAMPLE 2 ----------

Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type GUEST -Name "MY VDI Host Pool Member" -ProviderId 1 -VMId 42312685-05c9-ca51-342d-b3943046edf1

Adds the specified VDI Host Pool Member to the specified standalone VDI Host Pool.

The Type GUEST requires the ProviderId and VDIDesktopId to be specified. **---------- EXAMPLE 3 ----------

Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type NATIVEPOOL -Name "MY VDI Host Pool Member" -ProviderId 1 -NativePoolId 1

Adds the specified VDI Host Pool Member to the specified standalone VDI Host Pool.

The Type NATIVEPOOL requires the ProviderId and NativePoolId to be specified.

RAS_20_PowerShell_API

Parallels RAS PowerShell

Organization of This Guide

Getting Started

Parallels RAS PowerShell - Getting Started

Parallels Remote Application Server Requirements

Microsoft Windows Component Requirements

Basic Concepts

Parallels RAS Powershell Admin Module

Commands

Add-RASExcludeADGroup.md

NAME

SYNOPSIS

Get-RASADIntegrationSettings.md

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

SiteId (uint)

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Get-RASAdminSession.md

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Get-RASAllowedDevicesSetting.md

NAME

SYNOPSIS

Get-RASAppPackageAvailVersions.md

NAME

SYNOPSIS

Get-RASAppPackageSettings.md

NAME

SYNOPSIS

Get-RASAuthSettings.md

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

SiteId (uint)

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Get-RASAVDCustomHost.md

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

ProviderId (uint)

ShowHostsInHostPool (SwitchParameter)

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Get-RASAVDDefaultSettings.md

NAME

SYNOPSIS

Get-RASAVDGallery.md

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

ProviderId (uint)

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS