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

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

• Invoke-RASAppPackageAssigned

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:

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.

© 2024 Parallels International GmbH. Parallels and the Parallels logo are trademarks or registered trademarks of Parallels International GmbH in Canada, the U.S., and/or elsewhere.

NAME

Add-RASAutoUpgradeMessage

SYNOPSIS

Adds schedule message information within Auto-upgrade settings.

SYNTAX

Add-RASAutoUpgradeMessage -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Message <string> -MessageTitle <string> [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [-SiteId <uint>] [<CommonParameters>]

Add-RASAutoUpgradeMessage [-Id] <uint> -Message <string> -MessageTitle <string> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]

Add-RASAutoUpgradeMessage [-InputObject] <RASSerilazableObj> -Message <string> -MessageTitle <string> [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]

Add-RASAutoUpgradeMessage [-Name] <string> [[-SiteId] <uint>] -Message <string> -MessageTitle <string> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]

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

-SendMsgWhen <SendMsgWhen> Whether the message is sent Before/After the AutoUpgrade is triggered.

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

-InputObject <RASSerilazableObj> An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the Auto-upgrade settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <HostPoolObjType> The Object Type for which to modify the Auto-upgrade settings.

Possible values: RDSHostPool, VDIHostPool, 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 Auto-upgrade settings.

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

        Required?                    true

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

RELATED LINKS

• Get-RASAutoUpgrade

• Get-RASAutoUpgradeMessage

• Set-RASAutoUpgradeMessage

• Remove-RASAutoUpgradeMessage

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

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

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

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaHardwareID

• Remove-RASCriteriaHardwareID

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:

Getting Started lists system requirements and explains basic RAS PowerShell concepts.

Parallels RAS Powershell Admin Module is a complete reference to RAS PowerShell cmdlets.

API Versions lists available API versions and changes between them.

Examples 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 https://www.parallels.com/products/ras/resources

© 2024 Parallels International GmbH. Parallels and the Parallels logo are trademarks or registered trademarks of Parallels International GmbH in Canada, the U.S., and/or elsewhere.

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

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

Parallels RAS PowerShell - Getting Started

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

RELATED LINKS

• Get-RASCriteria

• Set-RASCriteria

• Get-RASCriteriaGatewayIP

• Remove-RASCriteriaGatewayIP

NAME

Add-RASExcludeADGroup

SYNOPSIS

Adds an Exclude AD group entry.

SYNTAX

Add-RASExcludeADGroup [- <string>] [- <string>] [- <uint>] [<>]

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.

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

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

<CommonParameters>

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.

RELATED LINKS

NAME

Add-RASCriteriaTheme

SYNOPSIS

Adds a Theme to the Criteria Theme List.

SYNTAX

Add-RASCriteriaTheme [-] {MFA} [[-] <uint>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaTheme [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaTheme [-] <> [- <uint>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaTheme [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [- <uint>] [- <string>] [<>]

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.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

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

NAME

Add-RASCriteriaSecurityPrincipal

SYNOPSIS

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

SYNTAX

Add-RASCriteriaSecurityPrincipal [-] {MFA} [[-] <uint>] [- <string>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <string>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <> [- <string>] [- <uint>] [- <string>] [<>]

Add-RASCriteriaSecurityPrincipal [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <string>] [- <uint>] [- <string>] [<>]

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.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

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

NAME

Add-RASCriteriaIP

SYNOPSIS

Adds an IP to the Criteria IP List.

SYNTAX

Add-RASCriteriaIP [-] {MFA} [[-] <uint>] - <string> - {Version4 | Version6 | BothVersions} [<>]

Add-RASCriteriaIP [-] <uint> - <string> - {Version4 | Version6 | BothVersions} - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

Add-RASCriteriaIP [-] <> - <string> - {Version4 | Version6 | BothVersions} [- <uint>] [<>]

Add-RASCriteriaIP [-] <string> [[-] <uint>] - <string> - {Version4 | Version6 | BothVersions} - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

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

Possible values: Version4, Version6, BothVersions

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

Possible values: ClientPolicy, PubItem, MFA, LogonHours

Possible values: MFA

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

<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

NAME

Add-RASAVDHostPoolAssignment

SYNOPSIS

Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List.

SYNTAX

Add-RASAVDHostPoolAssignment [-] <uint> [- <string>] [- <string>] [<>]

Add-RASAVDHostPoolAssignment [-] <> [- <string>] [- <string>] [<>]

Add-RASAVDHostPoolAssignment [-] <string> [[-] <uint>] [- <string>] [- <string>] [<>]

DESCRIPTION

Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.

PARAMETERS

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

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

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

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

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

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

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> [<>]

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.

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

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

SYNOPSIS

Adds RDS application attributes to specific server from where the application is hosted.

SYNTAX

Add-RASPubRDSAppServerAttr [-] <uint> - <uint> [- <string>] [- <uint>] [- <string>] [- <string>] [<>]

Add-RASPubRDSAppServerAttr [-] <> - <uint> [- <string>] [- <uint>] [- <string>] [- <string>] [<>]

DESCRIPTION

Adds RDS application attributes to a specific server from where the application is hosted.

PARAMETERS

-ServerID <uint> RDS server ID on which the attributes will be updated.

-Target <string> Application target file. (i.e. calc.exe, file.txt, etc.)

-StartIn <string> Application working directory.

-Parameters <string> Application parameters.

-Id <uint> Published resource ID.

To obtain the object, use the Get-PubItem cmdlet.

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubRDSAppServerAtt -Id 2 -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by application Id. ---------- EXAMPLE 2 ----------

Add-RASPubRDSAppServerAtt -InputObject $RDSApp -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by input object. ---------- EXAMPLE 3 ----------

Get-RASPubRDSApp -Id 2 | Add-RASPubRDSAppServerAtt -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"

Adds an existing per server application attribute settings by input object from pipeline.

RELATED LINKS

NAME

Add-RASHALBDevice

SYNOPSIS

Add a new HALB Device to the specific HALB Virtual Server instance.

SYNTAX

Add-RASHALBDevice [[-HALBId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

Add-RASHALBDevice [-InputObject] <HALBSettings> [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

Add-RASHALBDevice [-HALBName] <string> [[-SiteId] <uint>] [-DeviceIP] <string> [[-NoInstall] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Add a new HALB Device to the specific HALB Virtual Server instance.

PARAMETERS

-HALBName <string>

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HALBId <uint>

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DeviceIP <string>

        Required?                    true

        Position?                    2

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NoInstall <SwitchParameter>

        Required?                    false

        Position?                    3

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <HALBSettings> An object of type HALBSettings.

The object is obtained using the Get-RASHALB cmdlet.

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

INPUTS

HALBSettings

OUTPUTS

-none-

EXAMPLES

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

Add-RASHALBDevice -HALBId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by id. ---------- EXAMPLE 2 ----------

Add-RASHALBDevice -HALBName "HALB-VS" -SiteId 1 -DeviceIP "1.2.3.4"

Adds the HALB Device to a specific HALB Virtual Server instance by name.

RELATED LINKS

• Remove-RASHALBDevice

• Get-RASHALBDevice

• Set-RASHALBDevicePriority

NAME

Add-RASImageOptimizationWindowsComponent

SYNOPSIS

Adds Windows Custom Component.

SYNTAX

Add-RASImageOptimizationWindowsComponent -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-Aliases <string>] [-ComponentName <string>] [-DisplayName <string>] [-SiteId <uint>] [<CommonParameters>]

Add-RASImageOptimizationWindowsComponent [-Id] <uint> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-ComponentName <string>] [-DisplayName <string>] [<CommonParameters>]

Add-RASImageOptimizationWindowsComponent [-InputObject] <RASSerilazableObj> [-Aliases <string>] [-ComponentName <string>] [-DisplayName <string>] [<CommonParameters>]

Add-RASImageOptimizationWindowsComponent [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-ComponentName <string>] [-DisplayName <string>] [<CommonParameters>]

DESCRIPTION

Adds Windows Component to the following list.

PARAMETERS

-Aliases <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DisplayName <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ComponentName <string>

        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 Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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 Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, VDITemplate or VDIDesktop for which to modify the Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <OptimizationServerObjType> The Object Type for which to modify the Image Optimization settings.

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

        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 Image Optimization settings.

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

        Required?                    true

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

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASImageOptimizationWindowsComponent -Id 30 -ObjType RDS -DisplayName Name -Aliases alias -ComponentName Component Name

Adds the Windows Custom Component to the object type RDS.

RELATED LINKS

• Remove-RASImageOptimizationWindowsComponent

• Get-RASImageOptimizationWindowsComponent

NAME

Add-RASImageOptimizationRegistry

SYNOPSIS

Adds Registry property to the list.

SYNTAX

Add-RASImageOptimizationRegistry -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -DisplayName <string> -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-SiteId <uint>] [-StringValue <string>] [<CommonParameters>]

Add-RASImageOptimizationRegistry [-Id] <uint> -DisplayName <string> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]

Add-RASImageOptimizationRegistry [-InputObject] <RASSerilazableObj> -DisplayName <string> -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]

Add-RASImageOptimizationRegistry [-Name] <string> [[-SiteId] <uint>] -DisplayName <string> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]

DESCRIPTION

Adds Registry to the following list.

PARAMETERS

-Action <ActionType>

Possible values: Add, Modify, Delete

        Required?                    false

        Position?                    named

        Default value                Add

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RegistryName <string>

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DWORDValue <uint>

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DisplayName <string>

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HiveType <HiveType>

Possible values: HKEY_CURRENT_CONFIG, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT

        Required?                    false

        Position?                    named

        Default value                HKEY_CURRENT_CONFIG

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Path <string>

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RegType <ValueType>

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

        Required?                    false

        Position?                    named

        Default value                REG_SZ

        Accept pipeline input?       false

        Accept wildcard characters?  false

-StringValue <string>

        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 Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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 Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RASSerilazableObj> An object of type RDS, VDITemplate or VDIDesktop for which to modify the Image Optimization settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <OptimizationServerObjType> The Object Type for which to modify the Image Optimization settings.

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

        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 Image Optimization settings.

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

        Required?                    true

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

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

RELATED LINKS

• Get-RASImageOptimizationRegistry

• Remove-RASImageOptimizationRegistry

NAME

Add-RASFSLogixVHDLocation

SYNOPSIS

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

SYNTAX

Add-RASFSLogixVHDLocation -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -GeneralSettings <SwitchParameter> -VHDLocation <string> [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixVHDLocation -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -OfficeContainer <SwitchParameter> -VHDLocation <string> [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixVHDLocation -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -ProfileContainer <SwitchParameter> -VHDLocation <string> [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Id] <uint> -GeneralSettings <SwitchParameter> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-InputObject] <RASSerilazableObj> -GeneralSettings <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-InputObject] <RASSerilazableObj> -OfficeContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-InputObject] <RASSerilazableObj> -ProfileContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Name] <string> [[-SiteId] <uint>] -GeneralSettings <SwitchParameter> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

Add-RASFSLogixVHDLocation [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> -VHDLocation <string> [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-VHDLocation <string> Specifies the 'VHDLocation' path to add to the VHDLocation 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

-InputObject <RASSerilazableObj> An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <FSLogixServerObjType> The Object Type for which to modify the FSLogix 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 FSLogix settings.

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

<CommonParameters>

        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-RASFSLogixVHDLocation -DefObjType RDSDef -ContainerType Profile -VHDLocation "type=smb,connectionString=Location1"

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

RELATED LINKS

• Get-RASFSLogix

• Set-RASFSLogix

• Get-RASFSLogixVHDLocation

• Remove-RASFSLogixVHDLocation

NAME

Add-RASFSLogixUser

SYNOPSIS

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

SYNTAX

Add-RASFSLogixUser -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -GeneralSettings <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixUser -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -OfficeContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixUser -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -ProfileContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [-SiteId <uint>] [<CommonParameters>]

Add-RASFSLogixUser [-Id] <uint> -GeneralSettings <SwitchParameter> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-InputObject] <RASSerilazableObj> -GeneralSettings <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-InputObject] <RASSerilazableObj> -OfficeContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-InputObject] <RASSerilazableObj> -ProfileContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-Name] <string> [[-SiteId] <uint>] -GeneralSettings <SwitchParameter> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

Add-RASFSLogixUser [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> -UserListType {Inclusion | Exclusion} [-Account <string>] [-SID <string>] [<CommonParameters>]

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 <FSLogixListType> Specifies the 'User List Type'.

Possible values: Inclusion, Exclusion

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false