1 of 100

Parallels RAS 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:

Additional Resources

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
New-RASSession -Server "server.company.dom"
Execute the following cmdlet to see the list of cmdlets included in the Parallels RAS PowerShell module:
Get-Command -Module RASAdmin
Get-RASGateway
To see help for a cmdlet, execute Get-Help passing a cmdlet name:
Get-Help Get-RASGateway
Invoke-RASApply
Invoke-RASLicenseActivate
When executing the cmdlet above, you'll be prompted to enter your Parallels My Account email address and password. Passing a license key (the -Key parameter) is optional. If omitted (as in the example above), Parallels RAS is activated as a trial.

Parallels RAS Powershell Admin Module

Commands

Add-RASAutoUpgradeMessage

NAME

Add-RASAutoUpgradeMessage

SYNOPSIS

Adds schedule message information within Auto-upgrade settings.

SYNTAX

DESCRIPTION

Adds schedule message information within Auto-upgrade settings.

PARAMETERS

-Enabled <bool> Whether to enable or disable the message.

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MessageTitle <string> The title of the message.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Message <string> A message that should be sent to users before the job starts.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SendMsgSecs <uint> Time interval in seconds before the job starts when the message to users should be sent.

        Required?                    false

        Position?                    named

        Default value                900

        Accept pipeline input?       false

        Accept wildcard characters?  false

Send Message When can only be set to After in the case of Reboot.

Possible values: Before, After

        Required?                    false

        Position?                    named

        Default value                Before

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Auto-upgrade settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the Auto-upgrade settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the Auto-upgrade settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASAutoUpgradeMessage -DefObjType RDSDef -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Add-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------

Add-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"

Adds a message to the Auto-upgrade settings of the specified AVDHostPool by Id.

Add-RASClientPolicyConnection

NAME

Add-RASClientPolicyConnection

SYNOPSIS

Adds a new connection to the Connection List.

SYNTAX

DESCRIPTION

Adds a new connection to the Connection List

PARAMETERS

Possible values: GatewayMode, GatewaySSLMode, DirectMode, DirectSSLMode

        Required?                    true

        Position?                    named

        Default value                GatewayMode

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Server <string> The Server which the user is going to connect to.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServerPort <uint> The port of the Server.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> Name of the client policy to modify.

This must be the actual client policy name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASClientPolicyConnection -Id 1 -Mode "Gateway Mode" -Server "xyz" -ServerPort "80"

Adds the client policy connection with the following settings with Id=1.

Add-RASCriteriaGatewayIP

NAME

Add-RASCriteriaGatewayIP

SYNOPSIS

Adds a Gateway IP to the Criteria Gateway List.

SYNTAX

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.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GatewayId <uint> The ID of the gateway to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

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.

Add-RASCriteriaHardwareID

NAME

Add-RASCriteriaHardwareID

SYNOPSIS

Adds a Hardware ID to the Criteria Hardware ID List.

SYNTAX

DESCRIPTION

Adds a Hardware ID to the Criteria Hardware ID List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-HardwareID <string> The hardware ID to add to the Criteria.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASCriteriaHardwareID -Id 1 -ObjType MFA -HardwareID "D4-3D-7E-BF-4B-DC"

Adds the specified Hardware ID to the Criteria Hardware ID List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaHardwareID -Name "Logon1" -ObjType MFA -HardwareID "D4-3D-7E-BF-4B-DC"

Adds the specified Hardware ID to the Criteria Hardware ID List within the Criteria Settings of the specified MFA by Name.

Add-RASCriteriaSecurityPrincipal

NAME

Add-RASCriteriaSecurityPrincipal

SYNOPSIS

Adds a user, group or machine to the Criteria Security Principal List.

SYNTAX

DESCRIPTION

Adds a user, group or machine to the Criteria Security Principal List within the Criteria settings of a ClientPolicy, MFA or PubItem.

PARAMETERS

-Account <string> The name of the account to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SID <string> The SID of the account to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASCriteriaSecurityPrincipal -Id 1 -ObjType MFA -Account "JaneDoe"

Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaSecurityPrincipal -Name "Logon1" -ObjType MFA -Account "SID://DOMAIN/JaneDoe"

Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by Name.

Add-RASCriteriaTheme

NAME

Add-RASCriteriaTheme

SYNOPSIS

Adds a Theme to the Criteria Theme List.

SYNTAX

DESCRIPTION

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

PARAMETERS

-ThemeName <string> The name of the theme to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ThemeId <uint> The ID of the theme to add to the Criteria.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: MFA

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleId <uint> The ID of the Rule to modify.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASCriteriaTheme -Id 1 -ObjType LogonHours -ThemeName "Theme1"

Adds the Theme specified by Name to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ----------

Add-RASCriteriaTheme -Name "Logon1" -ObjType LogonHours -ThemeId 1

Adds the Theme specified by ID to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by Name.

Add-RASExcludeADGroup

NAME

Add-RASExcludeADGroup

SYNOPSIS

Adds an Exclude AD group entry.

SYNTAX

DESCRIPTION

Adds an Exclude AD group to the Exclude AD group settings list.

PARAMETERS

-Account <string> The name of the group account to add to the Exclude AD group list.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SID <string> The SID of the group account to add to the Exclude AD group list.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified Exclude AD group settings.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASExcludeADGroup -Account Guests

Adds an Exclude AD group to the Exclude AD group settings list for the current site.

Add-RASFSLogixCCDLocation

NAME

Add-RASFSLogixCCDLocation

SYNOPSIS

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

SYNTAX

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.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the FSLogix settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OfficeContainer <SwitchParameter> Sets the Office Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GeneralSettings <SwitchParameter> Sets the General settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASFSLogixCCDLocation -DefObjType RDSDef -ContainerType Profile -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

NAME

Add-RASFSLogixFolder

SYNOPSIS

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

SYNTAX

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

Possible values: None, CopyBase, CopyBack

        Required?                    false

        Position?                    named

        Default value                CopyBase, CopyBack

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: Inclusion, Exclusion

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Folder <string> Specifies the 'Folder' path to add to the Include/Exclude Folder List.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name or server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the FSLogix settings.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Add-RASFSLogixFolder -DefObjType RDSDef -ContainerType Profile -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 -ContainerType Profile -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

NAME

Add-RASVDIHostPoolMember

SYNOPSIS

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

SYNTAX

DESCRIPTION

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

PARAMETERS

-VDIHostPoolName <string> The VDI Host Pool name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDIHostPoolId <uint> The VDI Host Pool ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

The object is obtained using the Get-RASVDIHostPool cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

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

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

        Required?                    true

        Position?                    named

        Default value                AllGuestsInProvider

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The VDI Host Pool Member Name.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProviderId <uint> The VDI Host Pool Member Provider ID.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VMId <string> The VDI Host Pool Member Guest ID.

This parameter is only accepted with Type: GUEST.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NativePoolId <string> The VDI Host Pool Member Native Pool ID.

This parameter is only accepted with Type: NATIVEPOOL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <SecureString> The password of the account specified in the Username parameter.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VMIds <List`1> The VDI Host Pool Member Desktops IDs.

This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

        Required?                    false

        Position?                    named

        Default value                System.Collections.Generic.List`1[System.String]

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

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 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 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 VDI Host Pool.

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

Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type TEMPLATEDESKTOP -Name "MY VDI Host Pool Member" -VDITemplateId 1

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

The Type TEMPLATEGUEST requires the VDITemplateId to be specified.

Parallels RAS PowerShell API

Parallels RAS PowerShell

Organization of This Guide

Additional Resources

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

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASClientPolicyConnection

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASCriteriaGatewayIP

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASCriteriaHardwareID

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASCriteriaSecurityPrincipal

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASCriteriaTheme

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Add-RASExcludeADGroup

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES