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 the following steps:

1. Open the Windows PowerShell console.

2. In the console, type the following command to import the Parallels RAS PowerShell module:

   Import-Module RASAdmin

3. Create a Parallels RAS session by executing the New-RASSession 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"

4. Execute the following cmdlet to see the list of cmdlets included in the Parallels RAS PowerShell module:

   Get-Command -Module RASAdmin

5. Execute other cmdlets. For example, try executing the Get-RASGateway cmdlet to retrieve information about RAS Secure Gateway(s). The example below returns information about all RAS Secure Gateways available in the RAS Licensing Server site:

   Get-RASGateway

6. To see help for a cmdlet, execute Get-Help passing a cmdlet name:

   Get-Help Get-RASGateway

   To apply changes you've made to the farm configuration, use the Invoke-RASApply cmdlet:

   Invoke-RASApply

   To activate a Parallels RAS license, use Invoke-RASLicenseActivate:

   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.

NAME

Add-RASCriteriaDevice

SYNOPSIS

Adds a Client Device to the Criteria Device List.

SYNTAX

Add-RASCriteriaDevice [-DefObjType] {MFA} [[-SiteId] <uint>] -ClientDeviceName <string> [<CommonParameters>] Add-RASCriteriaDevice [-Id] <uint> -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaDevice [-InputObject] <RASListObj> -ClientDeviceName <string> [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaDevice [-Name] <string> [[-SiteId] <uint>] -ClientDeviceName <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-ClientDeviceName <string> The name of the client device 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

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. 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

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASCriteriaDevice -Id 1 -ObjType LogonHours -ClientDeviceName "Device1" Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ---------- Add-RASCriteriaDevice -Name "Logon1" -ObjType LogonHours -ClientDeviceName "Device1" Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaDevice

• Remove-RASCriteriaDevice

NAME

Add-RASCriteriaGatewayIP

SYNOPSIS

Adds a Gateway IP to the Criteria Gateway List.

SYNTAX

Add-RASCriteriaGatewayIP [-DefObjType] {MFA} [[-SiteId] <uint>] [-GatewayId <uint>] [-IP <string>] [<CommonParameters>] Add-RASCriteriaGatewayIP [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaGatewayIP [-InputObject] <RASListObj> [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaGatewayIP [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-GatewayId <uint>] [-IP <string>] [-RuleId <uint>] [<CommonParameters>]

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

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. 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

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

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.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaGatewayIP

• Remove-RASCriteriaGatewayIP

Add-RASAVDHostPoolAssignment

NAME

Add-RASAVDHostPoolAssignment

SYNOPSIS

Adds a user or group to the AVD Host Pool Assignment List.

SYNTAX

Add-RASAVDHostPoolAssignment [-Id] <uint> [-Account <string>] [-SID <string>] [<CommonParameters>] Add-RASAVDHostPoolAssignment [-InputObject] <AVDHostPool> [-Account <string>] [-SID <string>] [<CommonParameters>] Add-RASAVDHostPoolAssignment [-Name] <string> [[-SiteId] <uint>] [-Account <string>] [-SID <string>] [<CommonParameters>]

DESCRIPTION

Adds a user or group to the AVD Host Pool Assignment List within an AVD Host Pool.

PARAMETERS

-Id <uint> ID for which to modify the Azure Virtual Desktop Host Pool settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target Azure Virtual Desktop Host Pool settings. This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings . 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

-InputObject <AVDHostPool> An object of type AVDHostPool for which to modify settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASAVDHostPoolAssignment -Id 1 -Account "JaneDoe" Adds a user to the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by ID. ---------- EXAMPLE 2 ---------- Add-RASAVDHostPoolAssignment -Name "Logon1" -Account "SID://DOMAIN/JaneDoe" Adds a user to the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Name.

NAME

Add-RASCriteriaIP

SYNOPSIS

Adds an IP to the Criteria IP List.

SYNTAX

Add-RASCriteriaIP [-DefObjType] {MFA} [[-SiteId] <uint>] -IP <string> -IPType {Version4 | Version6 | BothVersions} [<CommonParameters>] Add-RASCriteriaIP [-Id] <uint> -IP <string> -IPType {Version4 | Version6 | BothVersions} -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaIP [-InputObject] <RASListObj> -IP <string> -IPType {Version4 | Version6 | BothVersions} [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaIP [-Name] <string> [[-SiteId] <uint>] -IP <string> -IPType {Version4 | Version6 | BothVersions} -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-IP <string> Value that represents the IP

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-IPType <IPVersion> Represents the type of IP Possible values: Version4, Version6, BothVersions

        Required?                    true

        Position?                    named

        Default value                Version4

        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

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. 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

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASCriteriaIP -Id 1 -ObjType MFA -IP "1.2.3.4" -IPType Version4 Adds the specified IPv4 to the Criteria IP List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ---------- Add-RASCriteriaIP -Name "Logon1" -ObjType MFA -IP "1.2.3.4-1.2.3.5" -IPType Version4 Adds the IPv4 Range to the Criteria IP List within the Criteria Settings of the specified MFA by Name.

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaIP

• Remove-RASCriteriaIP

NAME

Add-RASAppPackageAssigned

SYNOPSIS

Assigns an application package to an object type.

SYNTAX

Add-RASAppPackageAssigned -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -PackageName <string> -Version <string> [-SiteId <uint>] [<CommonParameters>] Add-RASAppPackageAssigned [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>] Add-RASAppPackageAssigned [-InputObject] <RASSerilazableObj> -PackageName <string> -Version <string> [<CommonParameters>] Add-RASAppPackageAssigned [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -PackageName <string> -Version <string> [<CommonParameters>]

DESCRIPTION

Adds assigned application package to an object type.

PARAMETERS

-Name <string> The name for which to modify the application package assigned settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the application package assigned 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 for which to modify the Application Package assigned settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <AppPackageAssignedObjType> The Object Type for which to modify the assigned application package settings. Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <ServerDefObjType> The Default Object Type for which to modify the application package settings. Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, RDSHostPool or VDIHostPool for which to modify the Assigned Application settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PackageName <string> The application package name. This must be the actual application package name used in the RAS farm.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Version <string> The version of the application package. This must be the actual application package version used in the RAS farm.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASAppPackageAssigned -Id 3 -ObjType VDIPool -PackageName Mozilla.MozillaFireFox -Version 99.0.0.0 Adds the assigned application package to the object type VDIPool.

RELATED LINKS

• Remove-RASAppPackageAssigned

• Get-RASAppPackageAssigned

• Set-RASAppPackageAssigned

NAME

Add-RASClientPolicyConnection

SYNOPSIS

Adds a new connection to the Connection List.

SYNTAX

Add-RASClientPolicyConnection [-Id] <uint> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>] Add-RASClientPolicyConnection [-InputObject] <ClientRules> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>] Add-RASClientPolicyConnection [-Name] <string> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]

DESCRIPTION

Adds a new connection to the Connection List

PARAMETERS

-Mode <Mode> The mode type of connection. 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

-InputObject <ClientRules> The client policy object to modify.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters . 

INPUTS

ClientRules

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.

RELATED LINKS

• Set-RASClientPolicy

• Get-RASClientPolicy

• Get-RASClientPolicyConnection

• Remove-RASClientPolicyConnection

NAME

Add-RASCriteriaHardwareID

SYNOPSIS

Adds a Hardware ID to the Criteria Hardware ID List.

SYNTAX

Add-RASCriteriaHardwareID [-DefObjType] {MFA} [[-SiteId] <uint>] -HardwareID <string> [<CommonParameters>] Add-RASCriteriaHardwareID [-Id] <uint> -HardwareID <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaHardwareID [-InputObject] <RASListObj> -HardwareID <string> [-RuleId <uint>] [<CommonParameters>] Add-RASCriteriaHardwareID [-Name] <string> [[-SiteId] <uint>] -HardwareID <string> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

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.

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

-SiteId <uint> Site ID for which to modify the Criteria 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 Criteria settings.

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. Possible values: MFA

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

<CommonParameters>

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.

RELATED LINKS

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 - <string> - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> [- <uint>] [<>] 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 [-] <uint> - <string> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> [<>] Add-RASFSLogixCCDLocation [-] <> - <string> - <SwitchParameter> [<>] Add-RASFSLogixCCDLocation [-] <> - <string> - <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> [<>] 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.

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

RELATED LINKS

NAME

Add-RASCriteriaTheme

SYNOPSIS

Adds a Theme to the Criteria Theme List.

SYNTAX

Add-RASCriteriaTheme [-DefObjType] {MFA} [[-SiteId] <uint>] [-ThemeId <uint>] [-ThemeName <string>] [<CommonParameters>] Add-RASCriteriaTheme [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [-ThemeId <uint>] [-ThemeName <string>] [<CommonParameters>] Add-RASCriteriaTheme [-InputObject] <RASListObj> [-RuleId <uint>] [-ThemeId <uint>] [-ThemeName <string>] [<CommonParameters>] Add-RASCriteriaTheme [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [-ThemeId <uint>] [-ThemeName <string>] [<CommonParameters>]

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.

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

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

-SiteId <uint> Site ID for which to modify the Criteria 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 Criteria settings.

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. Possible values: MFA

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

<CommonParameters>

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.

RELATED LINKS

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.

includes cmdlet examples demonstrating how to perform the most common Parallels RAS management tasks.

Additional Resources

For additional Parallels RAS documentation and resources, please visit

NAME

Add-RASFSLogixUser

SYNOPSIS

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

SYNTAX

Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>] Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>] Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>] Add-RASFSLogixUser [-] <uint> - <SwitchParameter> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <uint> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <uint> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <string> [[-] <uint>] - <SwitchParameter> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <string> [[-] <uint>] - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>] Add-RASFSLogixUser [-] <string> [[-] <uint>] - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>]

DESCRIPTION

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

PARAMETERS

-UserListType <> Specifies the 'User List Type'. Possible values: Inclusion, Exclusion

-Account <string> The name of the user/group account to add to the FSLogix Container.

-SID <string> The SID of the user/group account to add to the FSLogix Container.

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

-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-RASFSLogixUser -DefObjType RDSDef -ContainerType Profile -UserListType Inclusion -Account "JaneDoe" Adds a user to the Inclusion List of the Profile Container within the FSLogix Settings of the RDS Default Settings. ---------- EXAMPLE 2 ---------- Add-RASFSLogixUser -Name "RDSHostPool1" -ObjType RDSHostPool -ContainerType Profile -UserListType Exclusion -Account "SID://DOMAIN/JaneDoe" Adds a user to the Exclusion List of the Profile Container within the FSLogix Settings of the specified RDSHostPool by Name.

RELATED LINKS

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} [- {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} [- {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} [- {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} [- {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

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

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

<CommonParameters>

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.

RELATED LINKS

NAME

Add-RASCriteriaSecurityPrincipal

SYNOPSIS

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

SYNTAX

Add-RASCriteriaSecurityPrincipal [-DefObjType] {MFA} [[-SiteId] <uint>] [-Account <string>] [-SID <string>] [<CommonParameters>] Add-RASCriteriaSecurityPrincipal [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-Account <string>] [-RuleId <uint>] [-SID <string>] [<CommonParameters>] Add-RASCriteriaSecurityPrincipal [-InputObject] <RASListObj> [-Account <string>] [-RuleId <uint>] [-SID <string>] [<CommonParameters>] Add-RASCriteriaSecurityPrincipal [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-Account <string>] [-RuleId <uint>] [-SID <string>] [<CommonParameters>]

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.

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

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

-SiteId <uint> Site ID for which to modify the Criteria 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 Criteria settings.

-InputObject <RASListObj> An object of type ClientPolicy, PubItem or MFA for which to modify the Criteria settings.

-ObjType <CriteriaObjType> The Object Type for which to modify the Criteria settings. Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <CriteriaDefObjType> The Default Object Type for which to modify the Criteria settings. Possible values: MFA

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

<CommonParameters>

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.

RELATED LINKS