1 of 100

Parallels PowerShell RAS

Parallels RAS PowerShell

This guide contains information about Parallels RAS PowerShell. It is intended for Parallels RAS administrators who would like to use PowerShell to automate their RAS administration tasks.

Organization of This Guide

The guide is organized into the following main sections:

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

Getting Started

Parallels Remote Application Server Requirements

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

Microsoft Windows Component Requirements

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

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

Basic Concepts

To get started with Parallels RAS PowerShell, complete the following steps:

Open the Windows PowerShell console.
In the console, type the following command to import the Parallels RAS PowerShell module:
Import-Module RASAdmin
Create a Parallels RAS session by executing the 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"
Execute the following cmdlet to see the list of cmdlets included in the Parallels RAS PowerShell module:
Get-Command -Module RASAdmin
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
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.

Parallels RAS Powershell Admin Module

Commands

Add-RASThemeCustomImage

NAME

Add-RASThemeCustomImage

SYNOPSIS

Add a theme custom image.

SYNTAX

Add-RASThemeCustomImage -ImageFile <string> [-Name <string>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Add a theme custom image.

PARAMETERS

-Name <string> Theme custom image name.

-SiteId <uint> Site ID in which to create the theme custom image. If the parameter is omitted, the site ID of the Licensing Server will be used.

-ImageFile <string> Image file path of the image to be added to the Theme Custom Images list.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASThemeCustomImage -ImageFile "C:\temp\image.png" Add a theme custom image to the list of theme custom images of the Licensing site.

Add-RASTOTPUsers

NAME

Add-RASTOTPUsers

SYNOPSIS

Import TOTP users from a CSV file.

SYNTAX

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

DESCRIPTION

Import TOTP users from a CSV file.

PARAMETERS

-FilePath <string> File path to CSV containing user and secret. Must be in the format "user,secret".

-SiteId <uint> Site ID in where the users will be imported. If the parameter is omitted, the site ID of the Licensing Server will be used.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASTOTPUsers -FilePath "users.csv" Imports TOTP users from file. Operation is done on licensing site. ---------- EXAMPLE 2 ---------- Add-RASTOTPUsers -FilePath "users.csv" -SiteId 2 Imports TOTP users from file. Operation is done on site 2.

Find-RASTOTPUsers

NAME

Find-RASTOTPUsers

SYNOPSIS

Find TOTP users by matching substring.

SYNTAX

Find-RASTOTPUsers - <string> [- <uint>] [<>]

DESCRIPTION

Find TOTP users by matching substring.

PARAMETERS

-SiteId <uint> Site ID where the users will be searched.

-Like <string> Find users matching this pattern.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Find-RASTOTPUsers -Like "@my.domain.local" Find TOTP users matching the pattern "@my.domain.local".

Get-RASADIntegrationSettings

NAME

Get-RASADIntegrationSettings

SYNOPSIS

Obtains AD integration settings.

SYNTAX

Get-RASADIntegrationSettings [- <uint>] [<>]

DESCRIPTION

Obtains the active AD integration settings for the current site.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the AD Integration Settings. To obtain the ID of a desired site, use the Get-Sites cmdlet.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASADIntegrationSettings Obtains the active AD integration settings for the current site.

Get-RASAdminAccount

NAME

Get-RASAdminAccount

SYNOPSIS

Retrieves information about one or multiple Parallels RAS administrator accounts.

SYNTAX

Get-RASAdminAccount [[-] <uint>] [<>] Get-RASAdminAccount [[-] <string>] [<>]

DESCRIPTION

Retrieves information about one or multiple Parallels RAS administrator accounts. The cmdlet returns an array of objects of type RASAdminAccount. To see the complete list of object properties, use the Format-List cmdlet (see examples).

PARAMETERS

-Name <string> The username of a Parallels RAS administrator account for which to retrieve the information.

-Id <uint> The ID of an administrator account for which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAdminAccount | Format-List Retrieves the list of all available Parallels RAS administrator accounts. The Format-List cmdlet formats the display output to include all available settings for each administrator. ---------- EXAMPLE 2 ---------- Get-RASAdminAccount "username@dom" Retrieves information about an administrator specified by username. ---------- EXAMPLE 3 ---------- Get-RASAdminAccount -Id 1 Retrieves information about an administrator specified by ID.

Get-RASAdminSession

NAME

Get-RASAdminSession

SYNOPSIS

Retrieves information about RAS Admin sessions.

SYNTAX

-none-

DESCRIPTION

Retrieves information about RAS Admin sessions.

PARAMETERS

        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

AdminSession

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAdminSession Retrieves information about RAS Admin sessions.

Get-RASAllowedDevicesSetting

NAME

Get-RASAllowedDevicesSetting

SYNOPSIS

Returns settings for types of allowed clients.

SYNTAX

Get-RASAllowedDevicesSetting [- <uint>] [<>]

DESCRIPTION

Returns settings for types of allowed clients.

PARAMETERS

-SiteId <uint> The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAllowedDevicesSetting Retrieves settings for each of device types shown in 'Allowed Devices'. The permission of the device is represented as a boolean.

Get-RASAppPackage

NAME

Get-RASAppPackage

SYNOPSIS

Retrieves the application package settings.

SYNTAX

Get-RASAppPackage [-] <uint> [<>] Get-RASAppPackage [[-] <string>] [[-] <uint>] [<>]

DESCRIPTION

Retrieves the application package settings.

PARAMETERS

-Name <string> The name of the application package from which to retrieve the information. This must be the actual application package name used in the RAS farm.

-SiteId <uint> The ID of the Site from which to retrieve the application package information. If the parameter is omitted, the Licensing Server Site ID will be used.

-Id <uint> The ID of an application package from which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAppPackage Retrieves the list of Application Packages. ---------- EXAMPLE 2 ---------- Get-RASAppPackage -Id 1 Retrieves the Application Package with Id 1.

Get-RASAppPackageSettings

Get-RASAuthSettings

NAME

Get-RASAuthSettings

SYNOPSIS

Retrieves connection settings for authentication.

SYNTAX

Get-RASAuthSettings [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves all of the available connection settings for the Authentication category.

PARAMETERS

-SiteId <uint> The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

RASAuthSettings

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAuthSettings Retrieves RAS authentication settings.

Get-RASAVDCustomHost

NAME

Get-RASAVDCustomHost

SYNOPSIS

The cmdlet returns an object of type Azure Virtual Desktop Custom Host.

SYNTAX

Get-RASAVDCustomHost - <uint> [- <SwitchParameter>] [- <uint>] [<>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Custom Host.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop VMSize information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information.

-ShowHostsInHostPool <SwitchParameter> Show Hosts in existing host pools.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDCustomHost -ProviderId 2 | Format-List Retrieves all the Custom Hosts under Provider with ID 2 from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASAVDCustomHost -ProviderId 2 -SiteId 1 Retrieves all the Custom Hosts under Provider with ID 2 from site with ID 1.

Get-RASAVDDefaultSettings

NAME

Get-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure AVD.

SYNTAX

Get-RASAVDDefaultSettings [[-] <uint>] - {AVDMultiSessionDefaultSettings | AVDSingleSessionDefaultSettings} [<>]

DESCRIPTION

Retrieves default settings used to configure AVD. Default settings are defined on a site level and are applied to a AVD when it is initially created. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the defaults. If the parameter is omitted, the site ID of the Licensing Server will be used.

-DefObjType <> The Default Object Type Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDDefaultSettings -DefObjType AVDSingleSessionDefaultSettings Retrieves default Personal AVD settings from the specified site. ---------- EXAMPLE 2 ---------- Get-RASAVDDefaultSettings -DefObjType AVDMultiSessionDefaultSettings Retrieves default Pooled AVD settings from the specified site.

Get-RASAVDGallery

NAME

Get-RASAVDGallery

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Galleries.

SYNTAX

Get-RASAVDGallery - <uint> [<>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Galleries.

PARAMETERS

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Gallery information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDGallery -ProviderId 2 Retrieves a list of Galleries which fall under the Provider specified.

Get-RASAVDHostPool

NAME

Get-RASAVDHostPool

SYNOPSIS

Retrieves information about one or multiple Azure Virtual Desktop Host Pool properties.

SYNTAX

Get-RASAVDHostPool [[-] <uint>] [<>] Get-RASAVDHostPool [[-] <string>] [[-] <uint>] [<>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Host Pool properties. To see the complete list of object properties, use the Format-List cmdlet (see examples). The result set contains only the major properties of a pool; it does not include the complete list of settings supported in RAS.

PARAMETERS

-Name <string> The name of the Azure Virtual Desktop Host Pool for which to retrieve the information. This must be the actual AVD Host Pool name used in the RAS farm.

-SiteId <uint> Site ID from which to retrieve the AVD Host Pool information. If the parameter is omitted, the Licensing Server site ID will be used.

-Id <uint> The ID of a Azure Virtual Desktop Host Pool for which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDHostPool -Name "My AVDHostPool" | Format-List Retrieves information about the AVD Host Pool properties specified by name from the Licensing Server site. ---------- EXAMPLE 2 ---------- Get-RASAVDHostPool -Id 10 Retrieves information about the AVD Host Pool specified by ID from the Licensing Server site.

Get-RASAVDLocation

NAME

Get-RASAVDLocation

SYNOPSIS

The cmdlet returns an object of type Azure Virtual Desktop Location.

SYNTAX

Get-RASAVDLocation - <uint> [- <uint>] [<>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Location. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Location information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Location information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDLocation -ProviderId 2 | Format-List Retrieves all the Locations under Provider with ID 2 from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASAVDLocation -ProviderId 2 -SiteId 1 Retrieves all the Locations under Provider with ID 2 from site with ID 1.

Get-RASAVDPredefinedImages

NAME

Get-RASAVDPredefinedImages

SYNOPSIS

Retrieves the predefined Azure VM images.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the predefined Azure VM images.

PARAMETERS

        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

AVDPredefinedVMImage[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDPredefinedImages Retrieves information about the predefined Azure VM images.

Get-RASAVDPublisher

NAME

Get-RASAVDPublisher

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Publishers.

SYNTAX

Get-RASAVDPublisher - <string> - <uint> [- <uint>] [<>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Publishers.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop VMSize information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.

-Location <string> Location of the Azure Virtual Desktop Provider.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDPublisher -ProviderId 2 -Location "westeurope" | Format-List Retrieves all the Publishers under Azure Virtual Desktop Provider with ID 2 and Location westeurope, from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASAVDPublisher -ProviderId 1 -Location "westeurope" -SiteId 2 Retrieves all the Publishers under Azure Virtual Desktop Provider with ID 2 and Location westeurope, from the Site with ID 2.

Get-RASAVDResourceGroup

NAME

Get-RASAVDResourceGroup

SYNOPSIS

The cmdlet returns an object of type Azure Virtual Desktop Resource Group.

SYNTAX

Get-RASAVDResourceGroup - <uint> [- <uint>] [<>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Resource Group. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Resource Group information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Resource Group information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDResourceGroup -ProviderId 2 | Format-List Retrieves all the Resource Groups under Provider with ID 2 from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASAVDResourceGroup -ProviderId 2 -SiteId 1 Retrieves all the Resource Groups under Provider with ID 2 from site with ID 1.

Get-RASAVDSettings

NAME

Get-RASAVDSettings

SYNOPSIS

Retrieves the AVD Features settings.

SYNTAX

Get-RASAVDSettings [- <uint>] [<>]

DESCRIPTION

Retrieves the Azure Virtual Desktop Features settings. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the AVD settings. If the parameter is omitted, the Licensing Server site ID will be used.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDSettings Retrieves the AVD Features Settings.

Get-RASAVDVirtualNetwork

NAME

Get-RASAVDVirtualNetwork

SYNOPSIS

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

SYNTAX

Get-RASAVDVirtualNetwork - <string> - <uint> [- <uint>] [<>]

DESCRIPTION

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

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Virtual Network information. If the parameter is omitted, the Licensing Server site ID will be used.

-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Virtual Network information.

-Location <string> Location of the Azure Virtual Desktop Provider.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" | Format-List Retrieves all the Virtual Networks found under Provider with ID 2 and Location westeurope, from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" -SiteId 1 Retrieves all the Virtual Networks found under Provider with ID 2 and Location westeurope, from site with ID 1.

Get-RASAVDWorkspace

NAME

Get-RASAVDWorkspace

SYNOPSIS

Retrieves information about an Azure Virtual Desktop Workspace.

SYNTAX

Get-RASAVDWorkspace [[-Id] <uint>] [<CommonParameters>] Get-RASAVDWorkspace [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about the specified Azure Virtual Desktop Workspace or all Azure Virtual Desktop Workspaces within a site. This is an Experimental feature which is subject to slight changes.

PARAMETERS

-Name <string> The name of the Azure Virtual Desktop Workspace for which to retrieve the information. This must be the actual Azure Virtual Desktop Workspace name.

        Required?                    false

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the Azure Virtual Desktop Workspace information. 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 Azure Virtual Desktop Workspace for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

AVDWorkspace[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASAVDWorkspace -SiteId 1 Retrieves information about all the Azure Virtual Desktop Workspaces found withing the site with ID 1. ---------- EXAMPLE 2 ---------- Get-RASAVDWorkspace "My AVDWorkspace" -SiteId 1 | Format-List Retrieves information about the Azure Virtual Desktop Workspace specified by name from the site with ID 1. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 3 ---------- Get-RASAVDWorkspace -Id 10 Retrieves information about the Azure Virtual Desktop Workspace specified by ID from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter.

Get-RASBrokerAutoPromotionSettings

NAME

Get-RASBrokerAutoPromotionSettings

SYNOPSIS

Obtains Parallels RAS Broker Auto Promotion settings.

SYNTAX

Get-RASBrokerAutoPromotionSettings [[-] <uint>] [<>]

DESCRIPTION

The Get-RASBrokerAutoPromotionSettings cmdlet obtains the complete set of Parallels RAS Broker Auto Promotion settings for the current session.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the specified RAS Auto Promotion settings. If the parameter is omitted, the site ID of the Licensing Server will be used.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASBrokerAutoPromotionSettings Obtains Parallels RAS Auto Promote settings for the current session.

Get-RASClientPolicy

NAME

Get-RASClientPolicy

SYNOPSIS

Retrieves information about one or all the client policies.

SYNTAX

Get-RASClientPolicy [-] <uint> [<>] Get-RASClientPolicy [[-] <string>] [<>]

DESCRIPTION

Retrieves information about one or all the client policies.

PARAMETERS

-Name <string> Name of the client policy for which to retrieve the information.

-Id <uint> The ID of the client policy for which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASClientPolicy -Name PDFPolicy Retrieves information about the client policy named PDFPolicy. ---------- EXAMPLE 2 ---------- Get-RASClientPolicy Retrieves information about all the client policies.

Get-RASClientPolicyAssignment

NAME

Get-RASClientPolicyAssignment

SYNOPSIS

Retrieves information about a client policy assignment.

SYNTAX

Get-RASClientPolicyAssignment [-] <uint> [<>] Get-RASClientPolicyAssignment [-] <string> [<>]

DESCRIPTION

Retrieves information about a client policy assignment.

PARAMETERS

-Name <string> Name of the client policy for which to retrieve the information.

-Id <uint> The ID of the client policy for which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASClientPolicyAssignment -Name PDFPolicy Retrieves information about the assignment from a client policy named PDFPolicy.

Get-RASClientPolicyConnection

NAME

Get-RASClientPolicyConnection

SYNOPSIS

Retrieves the connection list

SYNTAX

Get-RASClientPolicyConnection [-Id] <uint> [<CommonParameters>] Get-RASClientPolicyConnection [[-Name] <string>] [<CommonParameters>]

DESCRIPTION

Retrieves the connection list

PARAMETERS

-Name <string> Name of the client policy for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of the client policy for which to retrieve the information.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

SecondaryConnection[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASClientPolicyConnection -Id 1 Retrieves the following client policy connection with Id=1.

Get-RASClientSettings

NAME

Get-RASClientSettings

SYNOPSIS

Retrieves the Parallels RAS client settings.

SYNTAX

Get-RASClientSettings [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Parallels RAS client settings.

PARAMETERS

-SiteId <uint> The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

RASClientSettings

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASClientSettings Retrieves the RAS Farm client settings. ---------- EXAMPLE 2 ---------- Get-RASClientSettings | Format-List Retrieves the RAS client settings.

Get-RASCPUOptimizationSettings

NAME

Get-RASCPUOptimizationSettings

SYNOPSIS

Obtains Parallels RAS CPU Optimization settings.

SYNTAX

Get-RASCPUOptimizationSettings [- <uint>] [<>]

DESCRIPTION

The Get-RASCPUOptimizationSettings cmdlet obtains the complete set of CPU optimization settings for the current session.

PARAMETERS

-SiteId <uint> The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCPUOptimizationSettings Obtains Parallels RAS CPU optimization settings for the current session.

Get-RASCurrentAdminPermissions

NAME

Get-RASCurrentAdminPermissions

SYNOPSIS

Retrieve information about the current admin permissions.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the current admin permissions.

PARAMETERS

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASCurrentAdminPermissions Retrieves information about the current admin permissions.

Get-RASEnrollmentServer

NAME

Get-RASEnrollmentServer

SYNOPSIS

Retrieves information about one or multiple Enrollment servers.

SYNTAX

Get-RASEnrollmentServer [[-] <uint>] [<>] Get-RASEnrollmentServer [[-] <string>] [[-] <uint>] [<>]

DESCRIPTION

Retrieves information about one or multiple Enrollment servers.

PARAMETERS

-Server <string> The name of the enrollment server for which to retrieve the information. This must be the actual enrollment server name used in the RAS farm.

-SiteId <uint> Site ID from which to retrieve the enrollment server If the parameter is omitted, the licensing server site ID will be used.

-Id <uint> ID of an enrollment server for which to retrieve the information.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASEnrollmentServer -Id 10 Retrieves information about the Enrollment server specified by its ID

Get-RASFarmSettings

NAME

Get-RASFarmSettings

SYNOPSIS

Retrieves the Parallels RAS Farm settings.

SYNTAX

Get-RASFarmSettings [- <uint>] [<>]

DESCRIPTION

Retrieves the Parallels RAS Farm settings. To see the complete list of farm properties, use the Format-List cmdlet (see examples).

PARAMETERS

-SiteId <uint> The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASFarmSettings Retrieves the RAS Farm settings. ---------- EXAMPLE 2 ---------- Get-RASFarmSettings | Format-List Retrieves the RAS Farm settings. The Format-List cmdlet formats the display output to include all available farm properties.

Add-RASCriteriaDevice

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

        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.

Add-RASCriteriaIP

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

        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.

Add-RASCriteriaTheme

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.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to modify the Criteria settings. If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        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-RASCriteriaTheme -Id 1 -ObjType LogonHours -ThemeName "Theme1" Adds the Theme specified by Name to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ---------- Add-RASCriteriaTheme -Name "Logon1" -ObjType LogonHours -ThemeId 1 Adds the Theme specified by ID to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by Name.

Add-RASPubRDSAppServerAttr

NAME

Add-RASPubRDSAppServerAttr

SYNOPSIS

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

SYNTAX

Add-RASPubRDSAppServerAttr [-Id] <uint> -ServerID <uint> [-Parameters <string>] [-SiteId <uint>] [-StartIn <string>] [-Target <string>] [<CommonParameters>] Add-RASPubRDSAppServerAttr [-InputObject] <PubItem> -ServerID <uint> [-Parameters <string>] [-SiteId <uint>] [-StartIn <string>] [-Target <string>] [<CommonParameters>]

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.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-StartIn <string> Application working directory.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Parameters <string> Application parameters.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <PubItem> An object specifying the published resource. To obtain the object, use the Get-PubItem cmdlet.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-SiteId <uint> Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

PubItem

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.

Add-RASImageOptimizationWindowsService

NAME

Add-RASImageOptimizationWindowsService

SYNOPSIS

Adds Windows Custom Services.

SYNTAX

Add-RASImageOptimizationWindowsService -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [-SiteId <uint>] [<CommonParameters>] Add-RASImageOptimizationWindowsService [-Id] <uint> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>] Add-RASImageOptimizationWindowsService [-InputObject] <RASSerilazableObj> [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>] Add-RASImageOptimizationWindowsService [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [-Aliases <string>] [-DisplayName <string>] [-ServiceName <string>] [<CommonParameters>]

DESCRIPTION

Adds Windows Custom Service 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

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

        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-RASImageOptimizationWindowsService -Id 30 -ObjType RDS -DisplayName Name -Aliases alias -ServiceName "Service Name" Adds the Windows Custom Services to the object type RDS.

Add-RASMFARadiusAttr

NAME

Add-RASMFARadiusAttr

SYNOPSIS

Adds attribute settings to Radius provider settings.

SYNTAX

Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-Id] <uint> -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>] Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-InputObject] <MFA> -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>] Add-RASMFARadiusAttr [-AttributeType] {Number | String | IP | Time} [-Name] <string> [[-SiteId] <uint>] -AttributeID <uint> -RadiusAttrName <string> -Value <string> -Vendor <string> -VendorID <uint> [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-VendorID <uint> RADIUS attribute vendor ID

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AttributeID <uint> RADIUS attribute ID

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Value <string> RADIUS attribute value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RadiusAttrName <string> RADIUS attribute name

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Vendor <string> RADIUS attribute vendor name

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AttributeType <RadiusAttrType> RADIUS attribute type. IP, string, number, or time Possible values: Number, String, IP, Time

        Required?                    true

        Position?                    0

        Default value                String

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target multi-factor authentication . This must be the actual multi-factor authentication 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 multi-factor authentication . 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

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <MFA> The multi factor authentication to modify. To obtain an object of type MFA, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

MFA

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASMFARadiusAttr -AttributeType IP -VendorID 1 -AttributeID 1 -Value 127.0.0.1 -Name AttrName -Vendor VendorName Adds a new entry to Radius attributes of type IP. The "Value" parameter must be in a valid IP format (IPv4 only). ---------- EXAMPLE 2 ---------- Add-RASMFARadiusAttr -AttributeType String -VendorID 1 -AttributeID 1 -Value "This is a string" -Name AttrName -Vendor VendorName Adds a new entry to Radius attributes of type String. The "Value" parameter can contain a character of any type, but cannot be empty. ---------- EXAMPLE 3 ---------- Add-RASMFARadiusAttr -AttributeType Number -VendorID 1 -AttributeID 1 -Value 42 -Name AttrName -Vendor VendorName Adds a new entry to Radius attributes of type Number. The "Value" parameter must contain numbers. The input can also be a string but must contain numbers only. ---------- EXAMPLE 4 ---------- Add-RASMFARadiusAttr -AttributeType Time -VendorID 1 -AttributeID 1 -Value 1500892318 -Name AttrName -Vendor VendorName Adds a new entry to Radius attributes of type Time. The "Value" parameter represents the date using the epoch time format.

Add-RASMFARadiusAuto

NAME

Add-RASMFARadiusAuto

SYNOPSIS

Adds automation settings to Radius provider settings.

SYNTAX

Add-RASMFARadiusAuto [-Id] <uint> -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>] Add-RASMFARadiusAuto [-InputObject] <MFA> -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>] Add-RASMFARadiusAuto [-Name] <string> [[-SiteId] <uint>] -Command <string> -Title <string> [-ActionMessage <string>] [-Description <string>] [-Enabled <bool>] [-Image {Alert | Message | Email | Call | Chat | Flag}] [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

-Command <string> RADIUS Automation command

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Whether the RADIUS Automation is enabled/disabled

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Image <ImageType> RADIUS Automation image Possible values: Alert, Message, Email, Call, Chat, Flag

        Required?                    false

        Position?                    named

        Default value                Alert

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Title <string> RADIUS Automation title

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ActionMessage <string> RADIUS Automation action message

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> RADIUS Automation description

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target multi-factor authentication . This must be the actual multi-factor authentication 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 multi-factor authentication . 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

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <MFA> The multi factor authentication to modify. To obtain an object of type MFA, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

MFA

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASMFARadiusAuto -SiteId 2 -Command Test -Title Test Adds a new entry to the Radius automation list on Site 2. [Radius Setting]

Add-RASScheduleMessage

NAME

Add-RASScheduleMessage

SYNOPSIS

Adds schedule message information for a Schedule.

SYNTAX

Add-RASScheduleMessage [-Id] <uint> -Message <string> -MessageTitle <string> -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [-TargetType {Host | HostPool}] [<CommonParameters>] Add-RASScheduleMessage [-Name] <string> [[-SiteId] <uint>] -Message <string> -MessageTitle <string> -ObjType {RDS | VDI | AVD} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Adds schedule message information for a Schedule.

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 schedule 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> Scheduler job name.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID to modify the schedule job.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <ScheduleObjType> Schedule message object type. Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TargetType <ScheduleTargetType> Schedule target type. Possible values: Host, HostPool

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

ScheduleMessage

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASScheduleMessage -ObjType VDI -Name "SchedItem" -Enabled 0 -SendMsgSecs 60 -MessageTitle "messageTitle" -Message "messageBody" Adds a Message to the schedule item specified by name, set to send 1 minute after schedule trigger. ---------- EXAMPLE 2 ---------- Add-RASScheduleMessage -ObjType VDI -Id 2 -Enabled 1 -SendMsgSecs 120 -MessageTitle "messageTitle" -Message "messageBody" Adds a Message to the schedule item specified by id, set to send 2 minutes after schedule trigger.

Add-RASScheduleTarget

NAME

Add-RASScheduleTarget

SYNOPSIS

Adds a new Schedule target.

SYNTAX

Add-RASScheduleTarget [-Id] <uint> -ObjType {RDS | VDI | AVD} -TargetID <uint> [-TargetType {Host | HostPool}] [<CommonParameters>] Add-RASScheduleTarget [-Id] <uint> -ObjType {RDS | VDI | AVD} -PoolId <uint> [-GuestName <string>] [-GUID <string>] [-HostAzureID <string>] [-TargetType {Host | HostPool}] [<CommonParameters>] Add-RASScheduleTarget [-Name] <string> [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} -TargetID <uint> [-TargetType {Host | HostPool}] [<CommonParameters>] Add-RASScheduleTarget [-Name] <string> [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} -PoolId <uint> [-GuestName <string>] [-GUID <string>] [-HostAzureID <string>] [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Creates a new Schedule property.

PARAMETERS

-Name <string> Scheduler job name.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID to modify the schedule job.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <ScheduleObjType> Schedule object type. Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TargetType <ScheduleTargetType> Schedule target type. Possible values: Host, HostPool

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TargetID <uint> The target RD Session Host server or server group Ids depending on the TargetType parameter.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PoolId <uint>

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GUID <string>

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GuestName <string>

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HostAzureID <string>

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

Schedule

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASScheduleTarget -ObjType VDI -Id 1 -TargetID 1 Adds a schedule target id to the schedule item specified by id. ---------- EXAMPLE 2 ---------- Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -TargetID 1 Adds a schedule target id to the schedule item specified by name. ---------- EXAMPLE 3 ---------- Add-RASScheduleTarget -ObjType VDI -Id 1 -PoolID 1 -GUID "SampleGUID" -GuestName "SampleGuestName" Adds a schedule target native host to the schedule item specified by id. ---------- EXAMPLE 4 ---------- Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -PoolID 1 -HostAzureID "SampleAzureID" Adds a schedule target native host to the schedule item specified by name.

Add-RASFSLogixVHDLocation

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

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

Add-RASImageOptimizationRegistry

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASImageOptimizationRegistry -Id 30 -ObjType RDS -Action Add -RegistryName "Name" -DWORDValue 1 -DisplayName HKEY_test -HiveType HKEY_CURRENT_CONFIG -Path System\CurrentControlSet\Services\Disk -RegType REG_SZ Adds the Image Optimization Registry of the Object Type 'RDS'.

Add-RASFSLogixFolder

NAME

Add-RASFSLogixFolder

SYNOPSIS

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

SYNTAX

Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>] Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>] Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>] Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>] Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]

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 <ExcludeFolderCopy> Specifies the 'Exclude Folder Copy', in case of adding to the Exclude Folder List. Possible values: None, CopyBase, CopyBack

        Required?                    false

        Position?                    named

        Default value                CopyBase, CopyBack

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FolderListType <FSLogixListType> Specifies the 'Folder List Type'. Possible values: Inclusion, Exclusion

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to modify the FSLogix settings. If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

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.

Parallels PowerShell RAS

Parallels RAS PowerShell

Organization of This Guide

Additional Resources

Getting Started

Parallels Remote Application Server Requirements

Microsoft Windows Component Requirements

Basic Concepts

Parallels RAS Powershell Admin Module

Commands

Add-RASThemeCustomImage

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

Add-RASTOTPUsers

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Find-RASTOTPUsers

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Get-RASADIntegrationSettings

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

Get-RASAdminAccount

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

Get-RASAdminSession

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

Get-RASAllowedDevicesSetting

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

Get-RASAppPackage

NAME

SYNOPSIS

SYNTAX

DESCRIPTION