Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 1127 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

Parallels RAS PowerShell API

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Commands

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

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

Parallels RAS Powershell Admin Module

Getting Started

Parallels RAS PowerShell - Getting Started

Parallels Remote Application Server Requirements

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

Microsoft Windows Component Requirements

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

  • Windows PowerShell 3.0 or higher

  • Microsoft .NET Framework 4.5.2 or higher

Basic Concepts

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

  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 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 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 cmdlet:

    Invoke-RASApply

    To activate a Parallels RAS license, use :

    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.

New-RASSession
Get-RASGateway
Invoke-RASApply
Invoke-RASLicenseActivate

Get-RASAVDPredefinedImages

NAME

Get-RASAVDPredefinedImages

SYNOPSIS

Retrieves the predefined Azure Virtual Desktop VM images.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the predefined Azure Virtual Desktop VM images.

To retrieve the AzureId of the Latest Predefined Image, use the Get-RASAVDVersion command and pass along the respective data.

PARAMETERS

<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

AVDPredefinedVMImage

EXAMPLES

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

Get-RASAVDPredefinedImages

Retrieves information about the predefined AVD VM images.

RELATED LINKS

  • Get-RASAVDVersion

Get-RASAVDSettings

NAME

Get-RASAVDSettings

SYNOPSIS

Retrieves the Azure Virtual Desktop Features settings.

SYNTAX

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

DESCRIPTION

Retrieves the Azure Virtual Desktop Features settings.

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.

        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

AVDFeaturesSettings

EXAMPLES

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

Get-RASAVDSettings

Retrieves the AVD Features Settings.

RELATED LINKS

  • Set-RASAVDSettings

Get-RASBrokerAutoPromotionSettings

NAME

Get-RASBrokerAutoPromotionSettings

SYNOPSIS

Obtains Parallels RAS Broker Auto Promotion settings.

SYNTAX

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

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.

        Required?                    false

        Position?                    1

        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

BrokerAutoPromotion

EXAMPLES

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

Get-RASBrokerAutoPromotionSettings

Obtains Parallels RAS Auto Promote settings for the current session.

RELATED LINKS

  • Set-RASBrokerAutoPromotionSettings

Add-RASExcludeADGroup

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

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.

<CommonParameters>

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.

RELATED LINKS

Get-RASAppPackageAvailVersions

NAME

Get-RASAppPackageAvailVersions

SYNOPSIS

Retrieves the application package version.

SYNTAX

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

DESCRIPTION

Retrieves the application package version.

PARAMETERS

-Name <string> The name of the application package for which to retrieve the available versions.

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 available application package versions.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAppPackageAvailVersions

Retrieves the list of application package versions. ---------- EXAMPLE 2 ----------

Get-RASAppPackageAvailVersions -Name "MSIX_APP_PACKAGE"

Retrieves the version of the application package named AppPackage1.

RELATED LINKS

-none-

Get-RASAppPackageSettings

NAME

Get-RASAppPackageSettings

SYNOPSIS

Retrieves Application Package settings.

SYNTAX

Get-RASAppPackageSettings [- <uint>] [<>]

DESCRIPTION

Retrieves the active Application Package settings for the current site.

PARAMETERS

-SiteId <uint> The ID of the Site from which to retrieve the application package settings.

To obtain the ID of the desired Site, use the Get-Sites cmdlet.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAppPackageSettings

Obtains the active Application package settings for the current site.

RELATED LINKS

Get-RASAVDCustomHost

NAME

Get-RASAVDCustomHost

SYNOPSIS

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

SYNTAX

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

DESCRIPTION

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

PARAMETERS

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

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDCustomHost -ProviderId 2 | Format-List

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

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

RELATED LINKS

-none-

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDGallery -ProviderId 2

Retrieves a list of Galleries which fall under the Provider specified.

RELATED LINKS

-none-

Get-RASAVDLocation

NAME

Get-RASAVDLocation

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Locations.

SYNTAX

Get-RASAVDLocation - <uint> [<>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Locations.

PARAMETERS

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDLocation -ProviderId 2 | Format-List

Retrieves all the Locations under the Provider with ID 2.

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

RELATED LINKS

-none-

Get-RASCurrentAdminPermissions

NAME

Get-RASCurrentAdminPermissions

SYNOPSIS

Retrieve information about the current admin permissions.

SYNTAX

-none-

DESCRIPTION

The cmdlet returns the current admin permissions.

PARAMETERS

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCurrentAdminPermissions

Retrieves information about the current admin permissions.

RELATED LINKS

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Account
SID
SiteId
CommonParameters
Remove-RASExcludeADGroup
Get-RASExcludeADGroup
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
SiteId
CommonParameters
RASAllowedDevicesSetting
Set-RASAllowedDevicesSetting
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Name
SiteId
CommonParameters
AppPackageVersion
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
SiteId
CommonParameters
AppPackageSettings
Set-RASAppPackageSettings
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
ProviderId
ShowHostsInHostPool
CommonParameters
AVDCustomHost
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
ProviderId
CommonParameters
AVDGallery
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
ProviderId
CommonParameters
AVDLocation
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
CurrentAdminPermissions
New-RASSession
Remove-RASSession

Get-RASADIntegrationSettings

NAME

Get-RASADIntegrationSettings

SYNOPSIS

Obtains AD integration settings.

SYNTAX

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

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.

        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

ADIntegrationSettings

EXAMPLES

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

Get-RASADIntegrationSettings

Obtains the active AD integration settings for the current site.

RELATED LINKS

  • Set-RASADIntegrationSettings

  • Invoke-RASADIntegrationSettings

Get-RASAppPackage

NAME

Get-RASAppPackage

SYNOPSIS

Retrieves the application package settings.

SYNTAX

Get-RASAppPackage [-Id] <uint> [<CommonParameters>]

Get-RASAppPackage [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

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.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        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

AppPackage

EXAMPLES

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

Get-RASAppPackage

Retrieves the list of Application Packages. ---------- EXAMPLE 2 ----------

Get-RASAppPackage -Id 1

Retrieves the Application Package with Id 1.

RELATED LINKS

  • New-RASAppPackage

  • Remove-RASAppPackage

  • Set-RASAppPackage

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

<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

RASAuthSettings

EXAMPLES

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

Get-RASAuthSettings

Retrieves RAS authentication settings.

RELATED LINKS

  • Set-RASAuthSettings

Get-RASAVDGalleryImage

NAME

Get-RASAVDGalleryImage

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Gallery Images.

SYNTAX

Get-RASAVDGalleryImage -Location <string> -Name <string> -ProviderId <uint> -ResourceGroup <string> [<CommonParameters>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Gallery Images.

PARAMETERS

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> Name of the Azure Virtual Desktop Gallery.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ResourceGroup <string> Resource Group of the Azure Virtual Desktop Gallery Image.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Location <string> Location of the Azure Virtual Desktop Gallery Image.

        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

AVDGalleryImage

EXAMPLES

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

Get-RASAVDGalleryImage -ProviderId 2 -Location "westeurope" -Name "myGalleryImage" -ResourceGroup "myResourceGroup"

Retrieves a list of Gallery Images which fall under the Provider, Location, ProviderId and ResourceGroup specified.

RELATED LINKS

-none-

Get-RASAVDOffer

NAME

Get-RASAVDOffer

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Offers.

SYNTAX

Get-RASAVDOffer -Location <string> -ProviderId <uint> -Publisher <string> [<CommonParameters>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Offers.

PARAMETERS

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Publisher <string> The Azure Virtual Desktop Publisher.

        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

AVDOffer

EXAMPLES

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

Get-RASAVDOffer -ProviderId 2 -Location "westeurope" -Publisher "publisher-server"

Retrieves a list of Offers which fall under the Provider, Location and Publisher specified.

RELATED LINKS

-none-

Get-RASAVDPublisher

NAME

Get-RASAVDPublisher

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Publishers.

SYNTAX

Get-RASAVDPublisher -Location <string> -ProviderId <uint> [<CommonParameters>]

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Publishers.

PARAMETERS

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

AVDPublisher

EXAMPLES

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

Get-RASAVDPublisher -ProviderId 2 -Location "westeurope"

Retrieves a list of Publishers which fall under the Provider and Location specified.

RELATED LINKS

-none-

Get-RASAVDVirtualNetwork

NAME

Get-RASAVDVirtualNetwork

SYNOPSIS

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

SYNTAX

Get-RASAVDVirtualNetwork -Location <string> -ProviderId <uint> [<CommonParameters>]

DESCRIPTION

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

PARAMETERS

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

AVDVirtualNetwork

EXAMPLES

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

Get-RASAVDVirtualNetwork -ProviderId 2 -Location "westeurope" | Format-List

Retrieves all the Virtual Networks found under the Provider with ID 2 and Location westeurope.

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

RELATED LINKS

-none-

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

<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

RASClientSettings

EXAMPLES

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

Get-RASClientSettings

Retrieves the RAS Farm client settings. ---------- EXAMPLE 2 ----------

Get-RASClientSettings | Format-List

Retrieves the RAS client settings.

RELATED LINKS

  • Get-RASHelpDeskEmailSettings

  • Get-RASProxySettings

  • Get-RASSystemSettings

  • Set-RASClientSettings

  • Get-RASFarmSettings

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

<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

SecondaryConnection

EXAMPLES

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

Get-RASClientPolicyConnection -Id 1

Retrieves the following client policy connection with Id=1.

RELATED LINKS

  • Set-RASClientPolicy

  • Get-RASClientPolicy

  • Add-RASClientPolicyConnection

  • Remove-RASClientPolicyConnection

Get-RASAVDResourceGroup

NAME

Get-RASAVDResourceGroup

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Resource Groups.

SYNTAX

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

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Resource Groups.

PARAMETERS

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

        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

AVDResourceGroup

EXAMPLES

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

Get-RASAVDResourceGroup -ProviderId 2 | Format-List

Retrieves all the Resource Groups under the Provider with ID 2.

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

RELATED LINKS

  • New-RASAVDResourceGroup

Get-RASCPUOptimizationSettings

NAME

Get-RASCPUOptimizationSettings

SYNOPSIS

Obtains Parallels RAS CPU Optimization settings.

SYNTAX

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

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.

        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

CPUOptimizationSettings

EXAMPLES

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

Get-RASCPUOptimizationSettings

Obtains Parallels RAS CPU optimization settings for the current session.

RELATED LINKS

  • Set-RASCPUOptimizationSettings

Add-RASAVDHostPoolAssignment

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.

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

-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

Add-RASPrintingAutoInstallFont

NAME

Add-RASPrintingAutoInstallFont

SYNOPSIS

Adds an Auto install font to Parallels RAS Universal Printing settings.

SYNTAX

Add-RASPrintingAutoInstallFont - <string> [- <SwitchParameter>] [- <uint>] [<>]

DESCRIPTION

Adds an Auto install font to Parallels RAS Universal Printing settings.

PARAMETERS

-SiteId <uint> The site ID.

To obtain the ID of a desired site, use the Get-Sites cmdlet.

-FontFilePath <string> Auto Install Font Path.

-ExcludeFont <SwitchParameter> Automatically Exclude Font from embedding.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf"

Adds the font to RAS Universal Printing Auto install fonts settings. ---------- EXAMPLE 2 ----------

Add-RASPrintingAutoInstallFont -FontFilePath "C:\Windows\Fonts\arialbd.ttf" -ExcludeFont

Adds the font to RAS Universal Printing Auto install fonts settings and adds the font to the embedding exclusion list.

RELATED LINKS

Add-RASPubAppFileExt

NAME

Add-RASPubAppFileExt

SYNOPSIS

Adds a file extension for the specified published application.

SYNTAX

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

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

DESCRIPTION

This cmdlet only allows you to add a file extension.

To modify other file extensions, use the Set-RASPubAppFileExt cmdlet.

PARAMETERS

-Extension <string> The file extension that will be added/modified.

-Id <uint> Published resource ID.

-InputObject <> An object specifying the published resource.

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

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubAppFileExt -Id 3 -Extension "txt"

Adds the specified file extension for the resource specified by ID.

RELATED LINKS

Add-RASThemeCustomImage

NAME

Add-RASThemeCustomImage

SYNOPSIS

Add a theme custom image.

SYNTAX

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

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASThemeCustomImage -ImageFile "C:\temp\image.png"

Add a theme custom image to the list of theme custome images of the Licensing site.

RELATED LINKS

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.

<CommonParameters>

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.

RELATED LINKS

Get-RASAgentDiagnostic

NAME

Get-RASAgentDiagnostic

SYNOPSIS

Retrieves RAS Agent Diagnostic information.

SYNTAX

Get-RASAgentDiagnostic - {RDS | Provider | Gateway | Guest | Broker | PA | HALBDevice | EnrollmentServer} - <string> [- <uint>] [<>]

DESCRIPTION

Retrieves the diagnostic information about the RAS Agent installed on a specific server, for diagnostic purposes, with a specific type, such as

RD Session Host, Provider, Gateway, Guest, Broker, HALB Device.

PARAMETERS

-Server <string> The name of server from which to retrieve Agent information.

This must be the actual server name used in the RAS farm.

-SiteId <uint> Site ID from which to retrieve the specified Agent information.

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

-AgentDiagnosticType <> Specifies the server type for which to retrieve the information.

Possible values: RDS, Provider, Gateway, Guest, Broker, PA, HALBDevice, EnrollmentServer

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAgentDiagnostic -Server test.domain -ServerType RDS

Retrieves the information about the RDS Agent installed on the server 'test.domain'. ---------- EXAMPLE 2 ----------

Get-RASAgentDiagnostic -Server test.domain -ServerType Provider

Retrieves the information about the Provider Agent installed on the server 'test.domain'.

RELATED LINKS

Get-RASAVDDefaultSettings

NAME

Get-RASAVDDefaultSettings

SYNOPSIS

Retrieves default settings used to configure an Azure Virtual Desktop.

SYNTAX

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

DESCRIPTION

Retrieves default settings used to configure an Azure Virtual Desktop.

Default settings are defined on a site level and are applied to an Azure Virtual Desktop when it is initially created.

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

<CommonParameters>

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.

RELATED LINKS

Get-RASAVDHost

NAME

Get-RASAVDHost

SYNOPSIS

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

SYNTAX

Get-RASAVDHost [[-] <uint>] [- <uint>] [<>]

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

DESCRIPTION

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 group; it does not include the complete list of settings supported in RAS.

PARAMETERS

-VMId <string> The ID of the VM for which to retrieve the information.

-ProviderId <uint> Provider Id from which to retrieve the AVD Host.

-SiteId <uint> Site ID from which to retrieve the AVD Host.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 | Format-List

Retrieves information about the AVD Host properties specified by the VMId and ProviderId.

To retrieve the info from a specific site, specify the -SiteId parameter.

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

Get-RASAVDHost -ProviderID 1

Retrieves all the AVD Hosts found within the Provider with Id 1.

RELATED LINKS

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.

<CommonParameters>

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.

RELATED LINKS

Get-RASAVDHostPoolAssignment

NAME

Get-RASAVDHostPoolAssignment

SYNOPSIS

Retrieves the Azure Virtual Desktop Host Pool Assignment List.

SYNTAX

Get-RASAVDHostPoolAssignment [[-] <uint>] [<>]

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

DESCRIPTION

Retrieves the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.

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.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDHostPoolAssignment -Id 1 -ObjType MFA

Retrieves the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by ID. ---------- EXAMPLE 2 ----------

Get-RASAVDHostPoolAssignment -Name "Logon1" -ObjType MFA

Retrieves the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Name.

RELATED LINKS

Get-RASAVDSKU

NAME

Get-RASAVDSKU

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.

SYNTAX

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

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.

PARAMETERS

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

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

-Publisher <string> The Azure Virtual Desktop Publisher.

-Offer <string> The Azure Virtual Desktop Offer.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDSKU -ProviderId 2 -Location "westeurope" -Publisher "my-publisher" -Offer "my-offer"

Retrieves a list of Stock Keeping Units which fall under the Provider, Location, Publisher and Offer specified.

RELATED LINKS

-none-

Get-RASAVDVMSize

NAME

Get-RASAVDVMSize

SYNOPSIS

The cmdlet returns a list of Azure Virtual Desktop VM Sizes.

SYNTAX

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

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

DESCRIPTION

The cmdlet returns a list of Azure Virtual Desktop VM Sizes.

PARAMETERS

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

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

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

-VMAzureId <string> Azure Virtual Desktop VM Id.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAVDVMSize -ProviderId 2 -Location westeurope | Format-List

Retrieves all the VM Sizes which fall under the AVD Provider and Location specified.

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

Get-RASAVDVMSize -WorkspaceId 2 -VMAzureId "/subscriptions/w7647456-39g5-113d-pe43-34le8xwj92tn/resourceGroups/My-Resource-Group/providers/Microsoft.Compute/virtualMachines/My-Host"

Retrieves all the VM Sizes which fall under the AVD Workspace and VMAzure specified.

RELATED LINKS

-none-

Get-RASAVDWorkspaceStatus

NAME

Get-RASAVDWorkspaceStatus

SYNOPSIS

Retrieves the status of one or multiple Azure Virtual Desktop Workspaces.

SYNTAX

Get-RASAVDWorkspaceStatus [[-] <uint>] [<>]

Get-RASAVDWorkspaceStatus [[-] <>] [<>]

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

DESCRIPTION

Retrieves information about the status of one or multiple Azure Virtual Desktop Workspaces.

The cmdlet returns an object of type AVDWorkspaceStatus.

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 group; it does not include the complete list of settings supported in RAS.

PARAMETERS

-InputObject <> An object of type AVDWorkspace representing the AVD Workspace.

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

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

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

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

<CommonParameters>

INPUTS

OUTPUTS

EXAMPLES

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

Get-RASAVDWorkspaceStatus -ID 1 | Format-List

Retrieves the status of the AVD Workspace specified by Id.

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

RELATED LINKS

Get-RASCertificate

NAME

Get-RASCertificate

SYNOPSIS

Retrieves information about one or multiple Certificates.

SYNTAX

Get-RASCertificate [[-] <uint>] [<>]

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

DESCRIPTION

Retrieves information about one or multiple Certificates.

PARAMETERS

-Name <string> The name of the Certificate for which to retrieve the information.

-SiteId <uint> Site ID from which to retrieve the Certificate information.

-Id <uint> The ID of a Certificate for which to retrieve the information.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCertificate

Retrieves information about all the Certificates from the Licensing Server site. ---------- EXAMPLE 2 ----------

Get-RASCertificate -Name "Cert"

Retrieves information about the Certificate specified by Name from the Licensing Server site. ---------- EXAMPLE 3 ----------

Get-RASCertificate -Id 1

Retrieves information about the Certificate specified by ID from the Licensing Server site.

RELATED LINKS

Get-RASCustomPermission

NAME

Get-RASCustomPermission

SYNOPSIS

Retrieves the permissions of a RAS custom admin account.

SYNTAX

Get-RASCustomPermission [-] <uint> [<>]

DESCRIPTION

Retrieves the permissions of a RAS custom admin account.

PARAMETERS

-AdminId <uint> Admin ID to retrieve the specified RAS Custom Administrator Account.

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCustomPermission -AdminId 100

Retrieves the permissions of a custom administrator specified by ID.

RELATED LINKS

Get-RASAdminSession

NAME

Get-RASAdminSession

SYNOPSIS

Retrieves information about RAS Admin sessions.

SYNTAX

-none-

DESCRIPTION

Retrieves information about RAS Admin sessions.

PARAMETERS

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAdminSession

Retrieves information about RAS Admin sessions.

RELATED LINKS

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
Account
SID
CommonParameters
InputObject
AVDHostPool
Account
SID
CommonParameters
Name
SiteId
Account
SID
CommonParameters
AVDHostPool
Get-RASAVDHostPool
Set-RASAVDHostPool
Get-RASAVDHostPoolAssignment
Remove-RASAVDHostPoolAssignment
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
FontFilePath
ExcludeFont
SiteId
CommonParameters
Get-RASPrintingSettings
Set-RASPrintingSettings
Get-RASPrintingAutoInstallFont
Remove-RASPrintingAutoInstallFont
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
Extension
SiteId
CommonParameters
InputObject
PubItem
Extension
SiteId
CommonParameters
PubItem
PubItem
Get-RASPubItem
Get-RASPubAppFileExt
Set-RASPubAppFileExt
Remove-RASPubAppFileExt
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        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 documentation. 
ImageFile
Name
SiteId
CommonParameters
Get-RASTheme
Get-RASThemeCustomImage
Set-RASThemeCustomImage
Remove-RASThemeCustomImage
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
CommonParameters
Name
CommonParameters
AdminAccount
New-RASAdminAccount
Set-RASAdminAccount
Remove-RASAdminAccount
Get-RASCustomPermission
Set-RASCustomPermission
Get-RASPowerPermission
Set-RASPowerPermission
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        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 documentation. 
AgentDiagnosticType
Server
SiteId
CommonParameters
RASAgentDiagnosticType
BrokerAgentDiagnostic
EnrollmentServerAgentDiagnostic
GatewayAgentDiagnostic
GuestAgentDiagnostic
HALBDeviceAgentDiagnostic
ProviderAgentDiagnostic
RDSAgentDiagnostic
Get-RASAgent
Update-RASAgent
Remove-RASAgent
        Required?                    false

        Position?                    0

        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 documentation. 
SiteId
DefObjType
CommonParameters
AVDDefObjType
AVDDefaultSettings
Set-RASAVDDefaultSettings
        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?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
SiteId
ProviderId
CommonParameters
VMId
SiteId
ProviderId
CommonParameters
AVDHost
New-RASAVDHost
Remove-RASAVDHost
Invoke-RASAVDHost
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
CommonParameters
Name
SiteId
CommonParameters
AVDHostPool
New-RASAVDHostPool
Remove-RASAVDHostPool
Set-RASAVDHostPool
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
CommonParameters
Name
SiteId
CommonParameters
Assignment
Get-RASAVDHostPool
Set-RASAVDHostPool
Add-RASAVDHostPoolAssignment
Remove-RASAVDHostPoolAssignment
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        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 documentation. 
Location
Offer
ProviderId
Publisher
CommonParameters
AVDSKU
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        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                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Location
ProviderId
CommonParameters
VMAzureId
WorkspaceId
CommonParameters
AVDVMSize
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
CommonParameters
InputObject
AVDWorkspace
CommonParameters
Name
SiteId
CommonParameters
AVDWorkspace
AVDWorkspace
AVDWorkspaceStatus
New-RASAVDWorkspace
Get-RASAVDWorkspace
Set-RASAVDWorkspace
Remove-RASAVDWorkspace
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
CommonParameters
Name
SiteId
CommonParameters
Certificate
New-RASCertificate
Remove-RASCertificate
Set-RASCertificate
Invoke-RASExportCertificate
Invoke-RASCertificateCmd
        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 documentation. 
AdminId
CommonParameters
CustomPermission
Set-RASCustomPermission
Get-RASAdminAccount
New-RASAdminAccount
Set-RASAdminAccount
Remove-RASAdminAccount
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
AdminSession
Invoke-RASAdminSessionCmd

Add-RASAppPackageAssigned

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

Add-RASMFAUsers

NAME

Add-RASMFAUsers

SYNOPSIS

Import MFA TOTP/EmailOTP users from a CSV file.

SYNTAX

Add-RASMFAUsers -FilePath <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

DESCRIPTION

Import MFA TOTP/EmailOTP users from a CSV file.

PARAMETERS

-FilePath <string> File path to CSV containing user and secret.

Must be in the format "user,secret".

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> The MFA Provider Type to be modified.

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

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

        Required?                    false

        Position?                    named

        Default value                TOTP

        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-RASMFAUsers -FilePath "users.csv" -Type TOTP

Imports MFA TOTP users from file. Operation is done on licensing site. ---------- EXAMPLE 2 ----------

Add-RASMFAUsers -FilePath "users.csv" -Type EmailOTP -MFAId 1

Imports MFA EmailOTP users from file in MFA with Id 1. ---------- EXAMPLE 3 ----------

Add-RASMFAUsers -FilePath "users.csv" -SiteId 2 -Type TOTP

Imports MFA TOTP users from file. Operation is done on site 2.

RELATED LINKS

  • Find-RASMFAUsers

  • Reset-RASMFAUsers

Add-RASTemplateLicenseKey

NAME

Add-RASTemplateLicenseKey

SYNOPSIS

Modifies properties of a RAS Template license key.

SYNTAX

Add-RASTemplateLicenseKey [-Id] <uint> -Key <string> -KeyLimit <uint> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>]

Add-RASTemplateLicenseKey [-InputObject] <Template> -Key <string> -KeyLimit <uint> [<CommonParameters>]

DESCRIPTION

Modifies properties of a license key used by a RAS Template.

PARAMETERS

-Id <uint> The ID of a RAS Template to modify.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <TemplateObjType> The Object Type for which to add Template License Key.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <Template> An object of type Template representing a RAS Template.

The object is obtained using the Get-Template cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Key <string> The license key.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-KeyLimit <uint> The max limit for the license key.

        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

Template

OUTPUTS

-none-

EXAMPLES

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

Add-RASTemplateLicenseKey -ObjType VDITemplate -Id 1 -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template specified by ObjType and ID. ---------- EXAMPLE 2 ----------

Add-RASTemplateLicenseKey -InputObject $Template -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template specified by the Object Type variable. ---------- EXAMPLE 3 ----------

Get-RASTemplate -ObjType VDITemplate -Id 1 | Add-RASTemplateLicenseKey -Key abcd1234 -KeyLimit 25

Modifies the specified license key properties for a RAS Template obtained from the pipeline output.

RELATED LINKS

  • Set-RASTemplate

  • Get-RASTemplateLicenseKey

  • Remove-RASTemplateLicenseKey

Add-RASThemeFooterURL

NAME

Add-RASThemeFooterURL

SYNOPSIS

Adds a new footer URL to the footer URLs list.

SYNTAX

Add-RASThemeFooterURL [-Id] <uint> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]

Add-RASThemeFooterURL [-Name] <string> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]

DESCRIPTION

Adds a new footer URL to the footer URLs list.

PARAMETERS

-URL <string> The URL

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Text <string> The text

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Tooltip <string> The tooltip

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

This must be the actual Theme 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 Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.

        Required?                    true

        Position?                    0

        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-RASThemeFooterURL -Id 1 -URL link -Text text -Tooltip tooltip

Adds a footer URL to theme with Id 1.

RELATED LINKS

  • Get-RASTheme

  • Get-RASThemeFooterURL

  • Remove-RASThemeFooterURL

Add-RASThemeGroupFilter

NAME

Add-RASThemeGroupFilter

SYNOPSIS

Adds a new group filter to the theme group filters.

SYNTAX

Add-RASThemeGroupFilter [-Id] <uint> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]

Add-RASThemeGroupFilter [-Name] <string> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]

DESCRIPTION

Adds a new group filter to the theme group filters.

PARAMETERS

-GroupName <string> The name of the group list

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GroupSID <string> The group SID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

This must be the actual Theme 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 Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.

        Required?                    true

        Position?                    0

        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-RASThemeGroupFilter -Id 1 -GroupName GroupListName

Adds a group filter with name GroupListName for theme with Id 1.

RELATED LINKS

  • Get-RASThemeGroupFilter

  • Remove-RASThemeGroupFilter

Add-RASURLRedirectionEntry

NAME

Add-RASURLRedirectionEntry

SYNOPSIS

Adds a URL redirection entry.

SYNTAX

Add-RASURLRedirectionEntry -URL <string> [-Action {DoNotRedirect | Redirect}] [-Enabled <bool>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Adds a URL redirection to the URL redirection settings list for the current site.

PARAMETERS

-Enabled <bool> Whether the URL redirection will be enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-URL <string> The URL to redirect or not.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Action <RedirectActionType> The redirect action type.

Possible values: DoNotRedirect, Redirect

        Required?                    false

        Position?                    named

        Default value                DoNotRedirect

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified URL redirection settings.

        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-RASURLRedirectionEntry -URL test.com

Adds a URL redirection for test.com to the URL redirection settings list for the current site.

RELATED LINKS

  • Get-RASURLRedirectionSettings

  • Set-RASURLRedirectionSettings

  • Remove-RASURLRedirectionEntry

  • Set-RASURLRedirectionEntry

  • Get-RASURLRedirectionEntry

Find-RASMFAUsers

NAME

Find-RASMFAUsers

SYNOPSIS

Find MFA TOTP/EmailOTP users by matching substring.

SYNTAX

Find-RASMFAUsers -Like <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

DESCRIPTION

Find MFA TOTP/EmailOTP users by matching substring.

PARAMETERS

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Like <string> Find users matching this pattern.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> The MFA Provider Type to be modified.

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

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

        Required?                    false

        Position?                    named

        Default value                TOTP

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

Find-RASMFAUsers -Like "@my.domain.local" -Type TOTP

Find MFA TOTP users matching the pattern "@my.domain.local". ---------- EXAMPLE 2 ----------

Find-RASMFAUsers -Like "@my.domain.local" -Type EmailOTP -MFAId 1

Find MFA EmailOTP users matching the pattern "@my.domain.local".

RELATED LINKS

  • Add-RASMFAUsers

  • Reset-RASMFAUsers

Get-RASAgent

NAME

Get-RASAgent

SYNOPSIS

Retrieves RAS Agent information by server type or server name.

SYNTAX

Get-RASAgent [-Server] <string> [-SiteId <uint>] [<CommonParameters>]

Get-RASAgent [[-ServerType] {RDSHost | RDS | Provider | Gateway | Guest | VDITemplate | RDSTemplate | AVDTemplate | VDITemplateVersion | AVDTemplateVersion | RDSTemplateVersion | Broker | PA | Site | VDIHostPool | RDSHostPool | RDSGroup | HALBDevice | HALB | Enrollment | TenantBroker | VDIHost | AVDHost | AVDHostPool | AVDWorkspace | All}] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the information about RAS Agent(s) installed on a specific server or on servers of a specific type, such as.

Connection Broker, RD Session Host, RAS Secure Gateway, Provider, VDI Desktop, VDI Template.

PARAMETERS

-Server <string> The name of server from which to retrieve Agent information.

This must be the actual server name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the specified Agent information.

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServerType <RASServerType> Specifies the server type for which to retrieve the information.

Possible values: RDSHost, RDS, Provider, Gateway, Guest, VDITemplate, RDSTemplate, AVDTemplate, VDITemplateVersion, AVDTemplateVersion, RDSTemplateVersion, Broker, PA, Site, VDIHostPool, RDSHostPool, RDSGroup, HALBDevice, HALB, Enrollment, TenantBroker, VDIHost, AVDHost, AVDHostPool, AVDWorkspace, All

        Required?                    false

        Position?                    0

        Default value                All

        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

AVDHostPoolStatus

AVDWorkspaceStatus

AVDHostSysInfo

BrokerSysInfo

GatewaySysInfo

GuestAgentInfo

HALBDeviceStatus

HALBVirtualServerStatus

ProviderSysInfo

RDSHostPoolStatus

RDSHostSysInfo

SiteSysInfo

TemplateStatus

VDIHostPoolStatus

VDIHostSysInfo

EXAMPLES

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

Get-RASAgent -Server MyRASserver

Retrieves the information about Agent(s) installed on the server named 'MyRASserver'. ---------- EXAMPLE 2 ----------

Get-RASAgent

Retrieves the information about all Agents from all servers in the farm. ---------- EXAMPLE 3 ----------

Get-RASAgent -ServerType RDS

Retrieves the information about the Agents installed on all RD Sessions Host servers in the farm. ---------- EXAMPLE 4 ----------

Get-RASAgent -SiteId 3 -ServerType RDS

Retrieves the information about the Agents installed on all RD Sessions Host servers in the farm of a specific site. ---------- EXAMPLE 5 ----------

Get-RASAgent -SiteId 3 -Server MyRASserver

Retrieves the information about Agent(s) installed on the server named 'MyRASserver' from a specific site.

RELATED LINKS

  • Get-RASAgentDiagnostic

  • Update-RASAgent

  • Remove-RASAgent

Get-RASAppPackageAssigned

NAME

Get-RASAppPackageAssigned

SYNOPSIS

Retrieves the assigned application package settings.

SYNTAX

Get-RASAppPackageAssigned -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-SiteId <uint>] [<CommonParameters>]

Get-RASAppPackageAssigned [-Id] <uint> -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<CommonParameters>]

Get-RASAppPackageAssigned [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<CommonParameters>]

DESCRIPTION

Retrieves the assigned application package settings.

PARAMETERS

-Name <string> The name of the application package for which to retrieve the information.

This must be the actual application package name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID from which to retrieve the assigned application package.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <AppPackageAssignedObjType> The Object Type for which to retrieve 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 retrieve 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

<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

AppPackageAssigned

EXAMPLES

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

Get-RASAppPackageAssigned -Id 1 -ObjType RDS

Retrieves the assigned application package settings for the object type RDS.

RELATED LINKS

  • Add-RASAppPackageAssigned

  • Remove-RASAppPackageAssigned

  • Set-RASAppPackageAssigned

  • Invoke-RASAppPackageAssigned

Get-RASAVDHostPoolStatus

NAME

Get-RASAVDHostPoolStatus

SYNOPSIS

Retrieves the status of one or multiple Azure Virtual Desktop Host Pools.

SYNTAX

Get-RASAVDHostPoolStatus [[-Id] <uint>] [<CommonParameters>]

Get-RASAVDHostPoolStatus [[-InputObject] <AVDHostPool>] [<CommonParameters>]

Get-RASAVDHostPoolStatus [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about the status of one or multiple Azure Virtual Desktop Host Pools.

The cmdlet returns an object of type AVDHostPoolStatus.

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 group; it does not include the complete list of settings supported in RAS.

PARAMETERS

-Name <string> The name of the AVD Host Pool for which to retrieve the status.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the specified RDS Host Pool Name.

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 AVD Host Pool. To obtain the ID, use the Get-RASAVDHostPool cmdlet.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHostPool> An object of type AVDHostPool representing the AVD Host Pool.

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

        Required?                    false

        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

AVDHostPool

OUTPUTS

AVDHostPoolStatus

EXAMPLES

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

Get-RASAVDHostPoolStatus "My AVD Host Pool" | Format-List

Retrieves the status of the AVD Host Pool specified by name 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 pool properties. ---------- EXAMPLE 2 ----------

Get-RASAVDHostPoolStatus -Id 10

Retrieves the status information about the AVD Host Pool specified by Id from the Licensing Server site.

RELATED LINKS

  • New-RASAVDHostPool

  • Get-RASAVDHostPool

  • Set-RASAVDHostPool

  • Remove-RASAVDHostPool

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.

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

<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

AVDWorkspace

EXAMPLES

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

Get-RASAVDWorkspace -SiteId 1

Retrieves information about all the AVD Workspaces found withing the site with ID 1. ---------- EXAMPLE 2 ----------

Get-RASAVDWorkspace "My AVDWorkspace" -SiteId 1 | Format-List

Retrieves information about the AVD 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 AVD Workspace specified by ID from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter.

RELATED LINKS

  • New-RASAVDWorkspace

  • Remove-RASAVDWorkspace

  • Set-RASAVDWorkspace

Get-RASBroker

NAME

Get-RASBroker

SYNOPSIS

Retrieves information about one or multiple RAS Connection Broker servers.

SYNTAX

Get-RASBroker [[-Id] <uint>] [<CommonParameters>]

Get-RASBroker [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the information about one or multiple RAS Connection Broker servers.

It returns an array of objects of type Broker, each containing properties of a RAS Connection Broker server.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

Note: the result set contains only the major server properties; it does not include all of the settings supported in RAS.

PARAMETERS

-Server <string> The name of the RAS Connection Broker server for which to retrieve the information.

This must be the actual server name used in the Parallels RAS farm.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the RAS Connection Broker server 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 the RAS Connection Broker server for which to retrieve the information.

        Required?                    false

        Position?                    0

        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

Broker

EXAMPLES

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

Get-RASBroker "server.company.dom" | Format-List

Retrieves properties of the specified RAS Connection Broker server.

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

Get-RASBroker -Id 5

Retrieves properties of the RAS Connection Broker server specified by ID.

RELATED LINKS

  • New-RASBroker

  • Set-RASBroker

  • Remove-RASBroker

Get-RASClientPolicyAssignment

NAME

Get-RASClientPolicyAssignment

SYNOPSIS

Retrieves information about a client policy assignment.

SYNTAX

Get-RASClientPolicyAssignment [-Id] <uint> [<CommonParameters>]

Get-RASClientPolicyAssignment [-Name] <string> [<CommonParameters>]

DESCRIPTION

Retrieves information about a client policy assignment.

PARAMETERS

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

        Required?                    true

        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

<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

ClientPolicyAssignment

EXAMPLES

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

Get-RASClientPolicyAssignment -Name PDFPolicy

Retrieves information about the assignment from a client policy named PDFPolicy.

RELATED LINKS

  • New-RASClientPolicy

  • Get-RASClientPolicy

  • Remove-RASClientPolicy

  • Set-RASClientPolicy

  • Invoke-RASClientPolicy

  • Get-RASRule

  • Get-RASCriteria

Get-RASAVDVersion

NAME

Get-RASAVDVersion

SYNOPSIS

The cmdlet retrieves a list or the latest Azure Virtual Desktop Version.

SYNTAX

Get-RASAVDVersion -Location <string> -Offer <string> -ProviderId <uint> -Publisher <string> -RequestType {All | Latest} -SKU <string> [<CommonParameters>]

DESCRIPTION

The cmdlet retrieves a list or the latest Azure Virtual Desktop Version.

PARAMETERS

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

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Publisher <string> The Azure Virtual Desktop Publisher.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Offer <string> The Azure Virtual Desktop Offer.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SKU <string> The Azure Virtual Desktop SKU.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RequestType <RequestType> Whether to retrieve a list of all available versions or just the latest version.

Possible values: All, Latest

        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

AVDMarketplaceVersion

EXAMPLES

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

Get-RASAVDVersion -ProviderId 2 -Location "westeurope" -Publisher "my-publisher" -Offer "my-offer" -SKU "my-sku" -RequestType All

Retrieves a list of Versions which fall under the Provider, Location, Publisher, Offer and SKU specified. ---------- EXAMPLE 2 ----------

Get-RASAVDVersion -ProviderId 2 -Location "westeurope" -Publisher "my-publisher" -Offer "my-offer" -SKU "my-sku" -RequestType Latest

Retrieves only the latest Version which falls under the Provider, Location, Publisher, Offer and SKU specified.

RELATED LINKS

-none-

Get-RASClientPolicy

NAME

Get-RASClientPolicy

SYNOPSIS

Retrieves information about one or all the client policies.

SYNTAX

Get-RASClientPolicy [-Id] <uint> [<CommonParameters>]

Get-RASClientPolicy [[-Name] <string>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or all the client policies.

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

<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

ClientRules

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.

RELATED LINKS

  • New-RASClientPolicy

  • Remove-RASClientPolicy

  • Set-RASClientPolicy

  • Invoke-RASClientPolicy

  • Get-RASClientPolicyAssignment

Get-RASCustomRoute

NAME

Get-RASCustomRoute

SYNOPSIS

Retrieves information about one or multiple custom routes.

SYNTAX

Get-RASCustomRoute [[-Id] <uint>] [<CommonParameters>]

Get-RASCustomRoute [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or multiple custom routes.

The cmdlet returns an object of type CustomRoute.

Custom routes are used within published item preferred routing settings.

PARAMETERS

-Name <string> The name of the Custom Route for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the Custom Route 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 Custom Route for which to retrieve the information.

        Required?                    false

        Position?                    0

        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

CustomRoute

EXAMPLES

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

Get-RASCustomRoute -Name "My Custom Route"

Retrieves information about the Custom Route specified by name from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter. ---------- EXAMPLE 2 ----------

Get-RASCustomRoute -Id 10

Retrieves information about the Custom Route specified by ID from the Licensing Server site.

RELATED LINKS

  • New-RASCustomRoute

  • Set-RASCustomRoute

  • Remove-RASCustomRoute

  • Add-RASPubItemPreferredRoute

  • Get-RASPubItemPreferredRoute

  • Set-RASPubItemPreferredRoute

  • Remove-RASPubItemPreferredRoute

Add-RASClientPolicyConnection

NAME

Add-RASClientPolicyConnection

SYNOPSIS

Adds a new connection to the Connection List.

SYNTAX

Add-RASClientPolicyConnection [-] <uint> - {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} - <string> - <uint> [<>]

Add-RASClientPolicyConnection [-] <> - {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} - <string> - <uint> [<>]

Add-RASClientPolicyConnection [-] <string> - {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} - <string> - <uint> [<>]

DESCRIPTION

Adds a new connection to the Connection List

PARAMETERS

-Mode <> The mode type of connection.

Possible values: GatewayMode, GatewaySSLMode, DirectMode, DirectSSLMode

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

-ServerPort <uint> The port of the Server.

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

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

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

-InputObject <> The client policy object to modify.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

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

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

RELATED LINKS

Add-RASProviderAdminCredentials

NAME

Add-RASProviderAdminCredentials

SYNOPSIS

Adds Admin Credential property to the list.

SYNTAX

Add-RASProviderAdminCredentials [-] <uint> [- <bool>] [- <string>] [- <string>] [<>]

Add-RASProviderAdminCredentials [-] <string> [[-] <uint>] [- <bool>] [- <string>] [- <string>] [<>]

DESCRIPTION

Adds Admin Credential to the following list.

PARAMETERS

-Name <string> The name of the Provider.

-SiteId <uint> Site ID in which to modify the specified Provider server.

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

-Id <uint> The ID of the Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

-Enabled <bool> Whether credentials are enabled or not

-Username <string> Username

-Password <string> Password

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASProviderAdminCredential -Id 1 -Enabled $true -Username "Administrator"

Adds the Admin Credentials to the property list

RELATED LINKS

Copy-RASPubItem

NAME

Copy-RASPubItem

SYNOPSIS

Copy a Published item.

SYNTAX

Copy-RASPubItem - <uint> [- <uint>] [- <uint>] [<>]

Copy-RASPubItem [-] <> [- <uint>] [- <uint>] [<>]

DESCRIPTION

Copy (duplicate) a published item.

PARAMETERS

-Id <uint> ID of Pub item to duplicate.

To obtain the pub item ID, use the Get-PubItem command.

-InputObject <> The published item object.

To obtain a PubItem object representing a published item, use the Get-PubItem command.

-ParentId <uint> ID of a new parent published item.

To obtain the published item ID, use the Get-PubItem command.

-PreviousId <uint> ID of a sibling item after which to place the specified published item.

To obtain the sibling item ID, use the Get-PubItem command.

<CommonParameters>

INPUTS

OUTPUTS

EXAMPLES

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

Copy-RASPubItem -Id 5 -ParentId 12

Duplicate the specified published item and it under the specified parent (ParentId).

To obtain the parent item ID, use the Get-RASPubItem cmdlet. ---------- EXAMPLE 2 ----------

Copy-RASPubItem -Id 10 -ParentId 12 -PreviousId 22

Duplicate a published item and place it under the specified parent (ParentId) and after the specified sibling item (PreviousId).

To obtain the parent item ID, use the Get-RASPubItem cmdlet. ---------- EXAMPLE 3 ----------

$PubItem | Copy-RASPubItem -ParentId 12

Invoke the duplicate pub item command, which is identified by an object obtained from the pipeline output.

To obtain the parent item ID, use the Get-RASPubItem cmdlet.

RELATED LINKS

Get-RASAutoUpgrade

NAME

Get-RASAutoUpgrade

SYNOPSIS

Retrieves the Auto-upgrade settings.

SYNTAX

Get-RASAutoUpgrade - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <uint>] [<>]

Get-RASAutoUpgrade [-] <uint> - {RDSHostPool | VDIHostPool | AVDHostPool} [<>]

Get-RASAutoUpgrade [-] <string> [[-] <uint>] - {RDSHostPool | VDIHostPool | AVDHostPool} [<>]

DESCRIPTION

Retrieves the Auto-upgrade settings from RDSHostPool, RDSDefaults, VDIHostPool, VDIDefaults, AVDHostPool or AVDDefaults (Single-Session/Multi-Session).

PARAMETERS

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

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

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

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

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

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

-DefObjType <> The Default Object Type for which to retrieve the Auto-upgrade settings.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAutoUpgrade -DefObjType RDSDef

Retrieves the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Get-RASAutoUpgrade -Name "VDIHostPool1" -ObjType VDIHostPool

Retrieves the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------

Get-RASAutoUpgrade -Id 1 -ObjType AVDHostPool

Retrieves the Auto-upgrade settings of the specified AVDHostPool by Id.

RELATED LINKS

Get-RASAutoUpgradeMessage

NAME

Get-RASAutoUpgradeMessage

SYNOPSIS

Retrieves schedule message information from Auto-upgrade settings.

SYNTAX

Get-RASAutoUpgradeMessage - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <uint>] [- <uint>] [<>]

Get-RASAutoUpgradeMessage [-] <uint> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <uint>] [<>]

Get-RASAutoUpgradeMessage [-] <string> [[-] <uint>] - {RDSHostPool | VDIHostPool | AVDHostPool} [- <uint>] [<>]

DESCRIPTION

Retrieves schedule message information from Auto-upgrade settings.

PARAMETERS

-MessageId <uint> Auto-upgrade job message ID.

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

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

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

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

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

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

-DefObjType <> The Default Object Type for which to retrieve the Auto-upgrade settings.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASAutoUpgradeMessage -DefObjType RDSDef

Retrieves the list of Messages from the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Get-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool

Retrieves the list of Messages from the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------

Get-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool

Retrieves the list of Messages from the Auto-upgrade settings of the specified AVDHostPool by Id.

RELATED LINKS

Get-RASDayPlan

NAME

Get-RASDayPlan

SYNOPSIS

Retrieves information about day plan properties.

SYNTAX

Get-RASDayPlan [[-] <uint>] - {LogonHours} [<>]

Get-RASDayPlan [[-] <string>] [[-] <uint>] - {LogonHours} [<>]

DESCRIPTION

Retrieves information about day plan properties.

The cmdlet returns an object of type day plan properties.

PARAMETERS

-Name <string> Name of the object to retrieve the day plan from.

-SiteId <uint> Site ID for which to retrieve the specified day plan of the object type specified.

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

-Id <uint> The ID of the object to retrieve the day plan from.

-ObjType <> The Object Type for which to retrieve the Day Plan settings from.

Possible values: LogonHours

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASDayPlan -Name "My Logon Hours" -ObjType LogonHours | Format-List

Retrieves information about the day plan properties specified by name from the Licensing Server Site. ---------- EXAMPLE 2 ----------

Get-RASDayPlan -Id 1 -ObjType LogonHours

Retrieves information about the day plan properties specified by ID from the Licensing Server Site.

RELATED LINKS

Get-RASCriteriaGatewayIP

NAME

Get-RASCriteriaGatewayIP

SYNOPSIS

Retrieves the Criteria Gateway List.

SYNTAX

Get-RASCriteriaGatewayIP - {} [- <uint>] [<>]

Get-RASCriteriaGatewayIP [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

Get-RASCriteriaGatewayIP [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

DESCRIPTION

Retrieves the Criteria Gateway List within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

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

-ObjType <> The Object Type for which to retrieve the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to retrieve the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCriteriaGatewayIP -Id 1 -ObjType MFA

Retrieves the Criteria Gateway List within the Criteria settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaGatewayIP -Name "Logon1" -ObjType MFA

Retrieves the Criteria Gateway List within the Criteria settings of the specified MFA by Name.

RELATED LINKS

Get-RASBrokerStatus

NAME

Get-RASBrokerStatus

SYNOPSIS

Retrieves the RAS Connection Broker status information.

SYNTAX

Get-RASBrokerStatus [[-] <uint>] [<>]

Get-RASBrokerStatus [[-] <>] [<>]

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

DESCRIPTION

Retrieves the RAS Connection Broker status information.

PARAMETERS

-Server <string> The name of the server for which to retrieve the information.

This must be the actual server name used in the RAS farm.

-SiteId <uint> Site ID from which to retrieve the specified RAS Connection Broker info.

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

-Id <uint> The ID of the server for which to retrieve the information. To obtain the ID, use the Get-RASBroker cmdlet.

-InputObject <> An object of type Broker representing a server for which to retrieve the information.

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

<CommonParameters>

INPUTS

OUTPUTS

EXAMPLES

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

Get-RASBrokerStatus -Id 15

Retrieves the RAS Connection Broker status information for the server with ID 15. ---------- EXAMPLE 2 ----------

Get-RASBrokerStatus -Server MyBroker

Retrieves the RAS Connection Broker status information for the server named "MyBroker". ---------- EXAMPLE 3 ----------

Get-RASBrokerStatus -InputObject $Broker

Retrieves the RAS Connection Broker status information for the server represented by the $Broker object. ---------- EXAMPLE 4 ----------

Get-RASBroker -Id 15 | Get-RASBrokerStatus

Retrieves the RAS Connection Broker status information for the server represented by the $Broker object obtained from pipeline output.

RELATED LINKS

        Required?                    true

        Position?                    named

        Default value                GatewayMode

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        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?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
Mode
Server
ServerPort
CommonParameters
InputObject
ClientRules
Mode
Server
ServerPort
CommonParameters
Name
Mode
Server
ServerPort
CommonParameters
Mode
ClientRules
ClientRules
Set-RASClientPolicy
Get-RASClientPolicy
Get-RASClientPolicyConnection
Remove-RASClientPolicyConnection
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
Id
Enabled
Password
Username
CommonParameters
Name
SiteId
Enabled
Password
Username
CommonParameters
Get-RASProviderAdminCredentials
Set-RASProviderAdminCredentials
Remove-RASProviderAdminCredentials
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                4294967295

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                4294967295

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
ParentId
PreviousId
CommonParameters
InputObject
PubItem
ParentId
PreviousId
CommonParameters
PubItem
PubItem
PubAVDApp
PubFolder
PubPCApp
PubRDSApp
PubVDIApp
Get-RASPubItem
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
CommonParameters
Id
ObjType
CommonParameters
Name
SiteId
ObjType
CommonParameters
HostPoolObjType
ServerDefObjType
AutoUpgradeSettings
Set-RASAutoUpgrade
Add-RASAutoUpgradeMessage
Get-RASAutoUpgradeMessage
Set-RASAutoUpgradeMessage
Remove-RASAutoUpgradeMessage
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
MessageId
SiteId
CommonParameters
Id
ObjType
MessageId
CommonParameters
Name
SiteId
ObjType
MessageId
CommonParameters
HostPoolObjType
ServerDefObjType
ScheduleMessage
Get-RASAutoUpgrade
Add-RASAutoUpgradeMessage
Set-RASAutoUpgradeMessage
Remove-RASAutoUpgradeMessage
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    0

        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 documentation. 
Id
ObjType
CommonParameters
Name
SiteId
ObjType
CommonParameters
DayPlanObjType
PermittedHourPlan
Set-RASDayPlan
Get-RASLogonHours
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
MFA
SiteId
CommonParameters
Id
ObjType
RuleId
CommonParameters
Name
SiteId
ObjType
RuleId
CommonParameters
CriteriaObjType
CriteriaDefObjType
GatewayCriteriaEntry
Get-RASCriteria
Set-RASCriteria
Add-RASCriteriaGatewayIP
Remove-RASCriteriaGatewayIP
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
CommonParameters
InputObject
Broker
CommonParameters
Server
SiteId
CommonParameters
Broker
Broker
BrokerSysInfo
New-RASBroker
Get-RASBroker

Add-RASImageOptimizationWindowsComponent

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

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

<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-RASImageOptimizationWindowsService -Id 30 -ObjType RDS -DisplayName Name -Aliases alias -ServiceName "Service Name"

Adds the Windows Custom Services to the object type RDS.

RELATED LINKS

  • Remove-RASImageOptimizationWindowsService

  • Get-RASImageOptimizationWindowsService

Add-RASProviderRemotePCStatic

NAME

Add-RASProviderRemotePCStatic

SYNOPSIS

Adds a Remote PC Static to a Provider.

SYNTAX

Add-RASProviderRemotePCStatic [-Id] <uint> -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

Add-RASProviderRemotePCStatic [-InputObject] <RemotePCStaticProvider> -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

Add-RASProviderRemotePCStatic [-Server] <string> [[-SiteId] <uint>] -MAC <string> -RemotePCStaticName <string> [-Subnet <string>] [<CommonParameters>]

DESCRIPTION

Adds a Remote PC Static to a Provider.

PARAMETERS

-RemotePCStaticName <string> Remote PC Static Name.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MAC <string> Remote PC Static MAC Address.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Subnet <string> Remote PC Static Subnet. Default: 0.0.0.0

        Required?                    false

        Position?                    named

        Default value                0.0.0.0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Server <string> The name of the target Provider server.

This must be the actual server 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 Provider server.

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 Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RemotePCStaticProvider> An object representing the Provider server to modify.

To obtain the object, use the Get-RASProvider 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

RemotePCStaticProvider

OUTPUTS

-none-

EXAMPLES

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

Add-RASProviderRemotePCStatic -Id 1 -RemotePCStaticName Test0 -MAC 00-11-22-33-44-00

Adds a Remote PC Static Test0 to the Remote PC Static List of the Provider with Id 1.

RELATED LINKS

  • Get-RASProvider

  • Set-RASProvider

  • Get-RASProviderRemotePCStatic

  • Set-RASProviderRemotePCStatic

  • Remove-RASProviderRemotePCStatic

  • Invoke-RASImportProviderRemotePCStatic

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

<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

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.

RELATED LINKS

  • Get-RASPubRDSAppServerAttr

  • Set-RASPubRDSAppServerAttr

  • Remove-RASPubRDSAppServerAttr

  • Get-RASRDSHost

  • Get-RASPubRDSApp

Add-RASRule

NAME

Add-RASRule

SYNOPSIS

Adds a Rule to the Rule List.

SYNTAX

Add-RASRule [-Id] <uint> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem} -RuleName <string> [-Description <string>] [-Enabled <bool>] [<CommonParameters>]

Add-RASRule [-InputObject] <RASListObj> [[-SiteId] <uint>] -RuleName <string> [-Description <string>] [-Enabled <bool>] [<CommonParameters>]

Add-RASRule [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem} -RuleName <string> [-Description <string>] [-Enabled <bool>] [<CommonParameters>]

DESCRIPTION

Adds a Rule to the Rule List within Published Items.

PARAMETERS

-Enabled <bool> Whether the new rule will be enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RuleName <string> The name of the rule to add to the Criteria.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> Description for the new rule.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <RuleObjType> The Object Type for which to modify the Rule settings.

Possible values: ClientPolicy, PubItem

        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-RASRule -Id 1 -ObjType ClientPolicy -RuleName Rule1

Add a rule with name Rule1 to the Rule List within the Client Policy with Id 1.

RELATED LINKS

  • Get-RASRule

  • Remove-RASRule

  • Set-RASRule

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

<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

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.

RELATED LINKS

  • Remove-RASScheduleTarget

  • Get-RASScheduleTarget

Get-RASAVDHostStatus

NAME

Get-RASAVDHostStatus

SYNOPSIS

Retrieves the list of, or a specific, Azure Virtual Desktop Host status.

SYNTAX

Get-RASAVDHostStatus [-ProviderId] <uint> [[-SiteId] <uint>] -HostId <string> [-StatusLevel {Level1 | Level2 | Level3}] [-User <string>] [<CommonParameters>]

Get-RASAVDHostStatus [-InputObject] <AVDHost> [-ProviderId] <uint> [[-SiteId] <uint>] [-StatusLevel {Level1 | Level2 | Level3}] [-User <string>] [<CommonParameters>]

Get-RASAVDHostStatus [[-ProviderId] <uint>] [[-SiteId] <uint>] [-StatusLevel {Level1 | Level2 | Level3}] [-User <string>] [<CommonParameters>]

DESCRIPTION

Retrieves the list of, or a specific, Azure Virtual Desktop Host status.

PARAMETERS

-ProviderId <uint> The ID of a Provider server from which to obtain the AVD Host list.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the AVD Host list.

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

-HostId <string> The ID of the AVD Host. To obtain the ID, use the Get-RASAVDHost cmdlet.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHost> An object of type AVDHost representing a AVD Host for which to retrieve the information.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-User <string> The username assigned to AVD Host.

If empty square brackets ([]) are passed, the AVD Host list will be filtered with those with an assigned user.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-StatusLevel <StatusLevel> Specifies the level of detail that should be returned.

Acceptable values: Level1 (AVD Host status information only), Level2 (AVD Host status and Host VM info), Level3 (AVD Host status, Host VMs, Applications).

Possible values: Level1, Level2, Level3

        Required?                    false

        Position?                    named

        Default value                Level1

        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

AVDHost

OUTPUTS

AVDHostSysInfo

EXAMPLES

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

Get-RASAVDHostStatus | Format-List

Retrieves the list of AVD Host statuses ---------- EXAMPLE 2 ----------

Get-RASAVDHostStatus -ProviderId 1

Retrieves the list of AVD Host statuses from the specified Provider server ---------- EXAMPLE 3 ----------

Get-RASAVDHostStatus -ProviderId 1 -SiteId 1

Retrieves the list of AVD Host statuses from the specified Provider server from the specified site. ---------- EXAMPLE 4 ----------

Get-RASAVDHostStatus -ProviderId 1 -SiteId 1 -HostId "1" | Format-List

Retrieves the specified AVD Host status from the specified Provider server from the specified site.

RELATED LINKS

  • New-RASAVDHost

  • Get-RASAVDHost

  • Remove-RASAVDHost

Get-RASCriteriaOS

NAME

Get-RASCriteriaOS

SYNOPSIS

Retrieves the Operating System Criteria.

SYNTAX

Get-RASCriteriaOS -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]

Get-RASCriteriaOS [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Get-RASCriteriaOS [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Operating System Criteria within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to retrieve 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 retrieve the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

AllowedOperatingSystems

EXAMPLES

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

Get-RASCriteriaOS -Id 1 -ObjType MFA

Retrieves the Allowed Operating Systems within the Criteria settings of the specified LogonHour by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaOS -Name "Logon1" -ObjType MFA

Retrieves the Allowed Operating Systems within the Criteria settings of the specified LogonHour by Name.

RELATED LINKS

  • Get-RASCriteria

  • Set-RASCriteria

  • Set-RASCriteriaOS

Get-RASCriteriaDevice

NAME

Get-RASCriteriaDevice

SYNOPSIS

Retrieves the Criteria Device List.

SYNTAX

Get-RASCriteriaDevice -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]

Get-RASCriteriaDevice [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Get-RASCriteriaDevice [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Criteria Device List within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to retrieve 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 retrieve the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

ClientDeviceCriteriaEntry

EXAMPLES

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

Get-RASCriteriaDevice -Id 1 -ObjType LogonHours

Retrieves the Criteria Device List within the Criteria settings of the specified LogonHour by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaDevice -Name "Logon1" -ObjType LogonHours

Retrieves the Criteria Device List within the Criteria settings of the specified LogonHour by Name.

RELATED LINKS

  • Get-RASCriteria

  • Set-RASCriteria

  • Add-RASCriteriaDevice

  • Remove-RASCriteriaDevice

Get-RASCriteriaTheme

NAME

Get-RASCriteriaTheme

SYNOPSIS

Retrieves the Criteria Theme List.

SYNTAX

Get-RASCriteriaTheme -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]

Get-RASCriteriaTheme [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Get-RASCriteriaTheme [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Criteria Theme List within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to retrieve 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 retrieve the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

UInt32

EXAMPLES

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

Get-RASCriteriaTheme -Id 1 -ObjType LogonHours

Retrieves the Criteria Theme List within the Criteria settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaTheme -Name "Logon1" -ObjType LogonHours

Retrieves the Criteria Theme List within the Criteria settings of the specified Logon Hours by Name.

RELATED LINKS

  • Get-RASCriteria

  • Set-RASCriteria

  • Add-RASCriteriaTheme

  • Remove-RASCriteriaTheme

Get-RASCriteriaSecurityPrincipal

NAME

Get-RASCriteriaSecurityPrincipal

SYNOPSIS

Retrieves the Criteria Security Principal List.

SYNTAX

Get-RASCriteriaSecurityPrincipal -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]

Get-RASCriteriaSecurityPrincipal [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Get-RASCriteriaSecurityPrincipal [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Criteria Security Principal List within the Criteof MFAria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to retrieve 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 retrieve the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

SecurityPrincipalCriteriaEntry

EXAMPLES

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

Get-RASCriteriaSecurityPrincipal -Id 1 -ObjType MFA

Retrieves the Criteria Security Principal List within the Criteria settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaSecurityPrincipal -Name "Logon1" -ObjType MFA

Retrieves the Criteria Security Principal List within the Criteria settings of the specified MFA by Name.

RELATED LINKS

  • Get-RASCriteria

  • Set-RASCriteria

  • Add-RASCriteriaSecurityPrincipal

  • Remove-RASCriteriaSecurityPrincipal

Get-RASCriteriaIP

NAME

Get-RASCriteriaIP

SYNOPSIS

Retrieves the Criteria IP List.

SYNTAX

Get-RASCriteriaIP -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]

Get-RASCriteriaIP [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

Get-RASCriteriaIP [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the Criteria IP List within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ObjType <CriteriaObjType> The Object Type for which to retrieve 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 retrieve the Criteria settings.

Possible values: MFA

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        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

AllowedIPsCriteria

EXAMPLES

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

Get-RASCriteriaIP -Id 1 -ObjType MFA

Retrieves the Criteria IP List within the Criteria settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaIP -Name "Logon1" -ObjType MFA

Retrieves the Criteria IP List within the Criteria settings of the specified MFA by Name.

RELATED LINKS

  • Get-RASCriteria

  • Set-RASCriteria

  • Add-RASCriteriaIP

  • Remove-RASCriteriaIP

Add-RASCriteriaDevice

NAME

Add-RASCriteriaDevice

SYNOPSIS

Adds a Client Device to the Criteria Device List.

SYNTAX

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

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

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

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

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.

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

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

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

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

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

Add-RASCriteriaGatewayIP

NAME

Add-RASCriteriaGatewayIP

SYNOPSIS

Adds a Gateway IP to the Criteria Gateway List.

SYNTAX

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

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

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

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

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.

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

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

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

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

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

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

Add-RASCriteriaHardwareID

NAME

Add-RASCriteriaHardwareID

SYNOPSIS

Adds a Hardware ID to the Criteria Hardware ID List.

SYNTAX

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

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

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

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

DESCRIPTION

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

PARAMETERS

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

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

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

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

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

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

RELATED LINKS

Add-RASCriteriaIP

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

-IPType <> Represents the type of 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.

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

Add-RASCriteriaSecurityPrincipal

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.

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

RELATED LINKS

Add-RASCriteriaTheme

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.

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

-ObjType <> The Object Type for which to modify the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to modify the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

RELATED LINKS

Add-RASImageOptimizationWindowsScheduledTask

NAME

Add-RASImageOptimizationWindowsScheduledTask

SYNOPSIS

Adds Windows Schedule Task.

SYNTAX

Add-RASImageOptimizationWindowsScheduledTask - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <string> - <string> [- <uint>] [<>]

Add-RASImageOptimizationWindowsScheduledTask [-] <uint> - <string> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - <string> [<>]

Add-RASImageOptimizationWindowsScheduledTask [-] <> - <string> - <string> [<>]

Add-RASImageOptimizationWindowsScheduledTask [-] <string> [[-] <uint>] - <string> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} - <string> [<>]

DESCRIPTION

Adds Windows Schedule Task to the following list.

PARAMETERS

-Task <string>

-Location <string>

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

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

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

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

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

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

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

-DefObjType <> The Default Object Type for which to modify the Image Optimization settings.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASImageOptimizationWindowsScheduledTask -Id 30 -ObjType RDS -Path System\CurrentControlSet\Services\Disk -Type Folder

Adds the Windows Schedule Task List to the object type RDS.

RELATED LINKS

Add-RASMFARadiusAttr

NAME

Add-RASMFARadiusAttr

SYNOPSIS

Adds attribute settings to Radius provider settings.

SYNTAX

Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [-] <uint> - <uint> - <string> - <string> - <string> - <uint> [<>]

Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [-] <> - <uint> - <string> - <string> - <string> - <uint> [<>]

Add-RASMFARadiusAttr [-] {Number | String | IP | Time} [-] <string> [[-] <uint>] - <uint> - <string> - <string> - <string> - <uint> [<>]

DESCRIPTION

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

PARAMETERS

-VendorID <uint> RADIUS attribute vendor ID

-AttributeID <uint> RADIUS attribute ID

-Value <string> RADIUS attribute value

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

-RadiusAttrName <string> RADIUS attribute name

-Vendor <string> RADIUS attribute vendor name

-AttributeType <> RADIUS attribute type. IP, string, number, or time

Possible values: Number, String, IP, Time

-Name <string> The name of the target multi-factor authentication .

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

-SiteId <uint> Site ID in which to modify the specified multi-factor authentication .

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

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

-InputObject <> The multi factor authentication to modify.

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

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

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

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

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

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

RELATED LINKS

Add-RASPubItemPreferredRoute

NAME

Add-RASPubItemPreferredRoute

SYNOPSIS

Adds a preferred route to the specified published resource.

SYNTAX

Add-RASPubItemPreferredRoute [-] <uint> - <string> - <uint> - {Gateway | HALB | Custom} [- <string>] [- <bool>] [- <uint>] [<>]

Add-RASPubItemPreferredRoute [-] <> - <string> - <uint> - {Gateway | HALB | Custom} [- <string>] [- <bool>] [- <uint>] [<>]

DESCRIPTION

This cmdlet allows you to add a preferred route to the specified published resource.

To modify preferred route options, use the Set-RASPubItemPreferredRoute cmdlet.

PARAMETERS

-Name <string> The Name of the Preferred Route

-Description <string> Description of the Preferred Route

-Enabled <bool> Whether the Preferred Route is enabled or not

-ReferenceType <> Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

-ReferenceId <uint> Reference ID of the Preferred Route

-Id <uint> Published resource ID.

-InputObject <> An object specifying the published resource.

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

-SiteId <uint> Site ID.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

Add-RASPubItemPreferredRoute -Id 12 -Name Route1 -ReferenceType Gateway -ReferenceId 1

Adds a preferred route with Name Route1 that routes connections through the Gateway with ID 1.

The target published resource is specified by ID 12. ---------- EXAMPLE 2 ----------

Add-RASPubItemPreferredRoute -Id 12 -Name Route2 -ReferenceType HALB -ReferenceId 1

Adds a preferred route with Name Route2 that routes connections through the HALB with ID 1.

The target published resource is specified by ID 12.

RELATED LINKS

Add-RASScheduleMessage

NAME

Add-RASScheduleMessage

SYNOPSIS

Adds schedule message information for a Schedule.

SYNTAX

Add-RASScheduleMessage [-] <uint> - <string> - <string> - {RDS | VDI | AVD} [- <bool>] [- <uint>] [- {Before | After}] [<>]

Add-RASScheduleMessage [-] <string> [[-] <uint>] - <string> - <string> - {RDS | VDI | AVD} [- <bool>] [- <uint>] [- {Before | After}] [<>]

DESCRIPTION

Adds schedule message information for a Schedule.

PARAMETERS

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

-MessageTitle <string> The title of the message.

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

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

-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

-Name <string> Scheduler job name.

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

-Id <uint> Scheduler job ID.

-ObjType <> Schedule message object type.

Possible values: RDS, VDI, AVD

<CommonParameters>

INPUTS

-none-

OUTPUTS

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 before 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 before schedule trigger.

RELATED LINKS

Add-RASWinDeviceGroupInboundPort

NAME

Add-RASWinDeviceGroupInboundPort

SYNOPSIS

Adds the Windows device group Inbound ports.

SYNTAX

Add-RASWinDeviceGroupInboundPort [-] <uint> - <uint> - {Domain | Private | Public | All} - {TCP | UDP} [<>]

Add-RASWinDeviceGroupInboundPort [[-] <>] - <uint> - {Domain | Private | Public | All} - {TCP | UDP} [<>]

Add-RASWinDeviceGroupInboundPort [-] <string> - <uint> - {Domain | Private | Public | All} - {TCP | UDP} [- <uint>] [<>]

DESCRIPTION

Adds the Windows device group Inbound ports.

PARAMETERS

-Port <uint> The Port to add to the windows device group.

-Protocol <> The Protocol to add to the windows device group.

Possible values: TCP, UDP

-Profile <> The Profile to add to the windows device group.

Possible values: Domain, Private, Public, All

-Name <string> The name of the windows device group from which to add the Inbound Port.

This must be the actual windows device group name used in the RAS farm.

-SiteId <uint> The ID of the Site from which from which to add the Inbound Port.

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

-Id <uint> The ID of a windows device group from which to add the Inbound Port.

-InputObject <> The Windows Device Group to modify.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

Add-RASWinDeviceGroupInboundPort -Name "WinDeviceGroup" -Port 50005 -Protocol TCP -Profile All

Adds an Inbound port to the list of Inbound ports of the Windows device group with name WinDeviceGroup. ---------- EXAMPLE 2 ----------

Add-RASWinDeviceGroupInboundPort -Id 1 -Port 50005 -Protocol TCP -Profile All

Adds an Inbound port to the list of Inbound ports of the Windows device group with Id 1.

RELATED LINKS

Get-RASCriteria

NAME

Get-RASCriteria

SYNOPSIS

Retrieves the Criteria settings.

SYNTAX

Get-RASCriteria - {} [- <uint>] [<>]

Get-RASCriteria [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

Get-RASCriteria [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

DESCRIPTION

Retrieves the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

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

-ObjType <> The Object Type for which to retrieve the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to retrieve the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCriteria -Id 1 -ObjType MFA

Retrieves the Criteria Settings of the MFA with Id 1. ---------- EXAMPLE 2 ----------

Get-RASCriteria -Id 1 -ObjType PubItem -RuleId 1

Retrieves the Criteria Settings of the Published Item with Id 1.

RELATED LINKS

Get-RASCriteriaHardwareID

NAME

Get-RASCriteriaHardwareID

SYNOPSIS

Retrieves the Criteria Hardware ID List.

SYNTAX

Get-RASCriteriaHardwareID - {} [- <uint>] [<>]

Get-RASCriteriaHardwareID [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

Get-RASCriteriaHardwareID [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]

DESCRIPTION

Retrieves the Criteria Hardware ID List within the Criteria settings from a ClientPolicy, MFA or PubItem.

PARAMETERS

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

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

-ObjType <> The Object Type for which to retrieve the Criteria settings.

Possible values: ClientPolicy, PubItem, MFA, LogonHours

-DefObjType <> The Default Object Type for which to retrieve the Criteria settings.

Possible values: MFA

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

EXAMPLES

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

Get-RASCriteriaHardwareID -Id 1 -ObjType MFA

Retrieves the Criteria Hardware ID List within the Criteria settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------

Get-RASCriteriaHardwareID -Name "Logon1" -ObjType MFA

Retrieves the Criteria Hardware ID List within the Criteria settings of the specified MFA by Name.

RELATED LINKS

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
ClientDeviceName
CommonParameters
Id
ClientDeviceName
ObjType
RuleId
CommonParameters
InputObject
RASListObj
ClientDeviceName
RuleId
CommonParameters
Name
SiteId
ClientDeviceName
ObjType
RuleId
CommonParameters
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaDevice
Remove-RASCriteriaDevice
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
GatewayId
IP
CommonParameters
Id
ObjType
GatewayId
IP
RuleId
CommonParameters
InputObject
RASListObj
GatewayId
IP
RuleId
CommonParameters
Name
SiteId
ObjType
GatewayId
IP
RuleId
CommonParameters
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaGatewayIP
Remove-RASCriteriaGatewayIP
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
HardwareID
CommonParameters
Id
HardwareID
ObjType
RuleId
CommonParameters
InputObject
RASListObj
HardwareID
RuleId
CommonParameters
Name
SiteId
HardwareID
ObjType
RuleId
CommonParameters
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaHardwareID
Remove-RASCriteriaHardwareID
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                Version4

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
IP
IPType
CommonParameters
Id
IP
IPType
ObjType
RuleId
CommonParameters
InputObject
RASListObj
IP
IPType
RuleId
CommonParameters
Name
SiteId
IP
IPType
ObjType
RuleId
CommonParameters
IPVersion
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaIP
Remove-RASCriteriaIP
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
Account
SID
CommonParameters
Id
ObjType
Account
RuleId
SID
CommonParameters
InputObject
RASListObj
Account
RuleId
SID
CommonParameters
Name
SiteId
ObjType
Account
RuleId
SID
CommonParameters
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaSecurityPrincipal
Remove-RASCriteriaSecurityPrincipal
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
SiteId
ThemeId
ThemeName
CommonParameters
Id
ObjType
RuleId
ThemeId
ThemeName
CommonParameters
InputObject
RASListObj
RuleId
ThemeId
ThemeName
CommonParameters
Name
SiteId
ObjType
RuleId
ThemeId
ThemeName
CommonParameters
RASListObj
CriteriaObjType
CriteriaDefObjType
Get-RASCriteria
Set-RASCriteria
Get-RASCriteriaTheme
Remove-RASCriteriaTheme
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
DefObjType
Location
Task
SiteId
CommonParameters
Id
Location
ObjType
Task
CommonParameters
InputObject
RASSerilazableObj
Location
Task
CommonParameters
Name
SiteId
Location
ObjType
Task
CommonParameters
RASSerilazableObj
OptimizationServerObjType
ServerDefObjType
Remove-RASImageOptimizationWindowsScheduledTask
Get-RASImageOptimizationWindowsScheduledTask
        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
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                String

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
AttributeType
Id
AttributeID
RadiusAttrName
Value
Vendor
VendorID
CommonParameters
AttributeType
InputObject
MFA
AttributeID
RadiusAttrName
Value
Vendor
VendorID
CommonParameters
AttributeType
Name
SiteId
AttributeID
RadiusAttrName
Value
Vendor
VendorID
CommonParameters
RadiusAttrType
MFA
MFA
Get-RASMFARadiusAttr
Remove-RASMFARadiusAttr
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                True

        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
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
Name
ReferenceId
ReferenceType
Description
Enabled
SiteId
CommonParameters
InputObject
PubItem
Name
ReferenceId
ReferenceType
Description
Enabled
SiteId
CommonParameters
RoutingType
PubItem
PubItem
Get-RASPubItem
Get-RASPubItemPreferredRoute
Set-RASPubItemPreferredRoute
Remove-RASPubItemPreferredRoute
New-RASCustomRoute
Get-RASCustomRoute
Set-RASCustomRoute
Remove-RASCustomRoute
Get-RASGateway
Get-RASHALB
        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                900

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                Before

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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 documentation. 
Id
Message
MessageTitle
ObjType
Enabled
SendMsgSecs
SendMsgWhen
CommonParameters
Name
SiteId
Message
MessageTitle
ObjType
Enabled
SendMsgSecs
SendMsgWhen
CommonParameters
SendMsgWhen
ScheduleObjType
ScheduleMessage
Get-RASSchedule
Get-RASScheduleMessage
Set-RASScheduleMessage
Remove-RASScheduleMessage
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                TCP

        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?                    1

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
Id
Port
Profile
Protocol
CommonParameters
InputObject
WinDeviceGroup
Port
Profile
Protocol
CommonParameters
Name
Port
Profile
Protocol
SiteId
CommonParameters
Protocol
Profile
WinDeviceGroup
WinDeviceGroup
New-RASWinDeviceGroup
Get-RASWinDeviceGroup
Set-RASWinDeviceGroup
Remove-RASWinDeviceGroup
Get-RASWinDeviceGroupInboundPort
Remove-RASWinDeviceGroupInboundPort
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
MFA
SiteId
CommonParameters
Id
ObjType
RuleId
CommonParameters
Name
SiteId
ObjType
RuleId
CommonParameters
CriteriaObjType
CriteriaDefObjType
ClientPolicyCriteria
MFACriteria
PubItemCriteria
Set-RASCriteria
Get-RASCriteriaGatewayIP
Get-RASCriteriaDevice
Get-RASCriteriaHardwareID
Get-RASCriteriaIP
Get-RASCriteriaOS
Get-RASCriteriaSecurityPrincipal
Get-RASCriteriaTheme
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        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
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
MFA
SiteId
CommonParameters
Id
ObjType
RuleId
CommonParameters
Name
SiteId
ObjType
RuleId
CommonParameters
CriteriaObjType
CriteriaDefObjType
HardwareIDCriteriaEntry
Get-RASCriteria
Set-RASCriteria
Add-RASCriteriaHardwareID
Remove-RASCriteriaHardwareID

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

<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

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]

RELATED LINKS

  • Get-RASMFARadiusAuto

  • Set-RASMFARadiusAuto

  • Remove-RASMFARadiusAuto

Add-RASHALBDevice

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

Add-RASImageOptimizationRegistry

NAME

Add-RASImageOptimizationRegistry

SYNOPSIS

Adds Registry property to the list.

SYNTAX

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

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

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

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

DESCRIPTION

Adds Registry to the following list.

PARAMETERS

-Action <>

Possible values: Add, Modify, Delete

-RegistryName <string>

-DWORDValue <uint>

-DisplayName <string>

-HiveType <>

Possible values: HKEY_CURRENT_CONFIG, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT

-Path <string>

-RegType <>

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

-StringValue <string>

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

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

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

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

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

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

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

-DefObjType <> The Default Object Type for which to modify the Image Optimization settings.

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

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

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

RELATED LINKS

Add-RASAutoUpgradeMessage

NAME

Add-RASAutoUpgradeMessage

SYNOPSIS

Adds schedule message information within Auto-upgrade settings.

SYNTAX

Add-RASAutoUpgradeMessage - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <string> - <string> [- <bool>] [- <uint>] [- {Before | After}] [- <uint>] [<>]

Add-RASAutoUpgradeMessage [-] <uint> - <string> - <string> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <bool>] [- <uint>] [- {Before | After}] [<>]

Add-RASAutoUpgradeMessage [-] <> - <string> - <string> [- <bool>] [- <uint>] [- {Before | After}] [<>]

Add-RASAutoUpgradeMessage [-] <string> [[-] <uint>] - <string> - <string> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <bool>] [- <uint>] [- {Before | After}] [<>]

DESCRIPTION

Adds schedule message information within Auto-upgrade settings.

PARAMETERS

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

-MessageTitle <string> The title of the message.

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

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

-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

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

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

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

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

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

Possible values: RDSHostPool, VDIHostPool, AVDHostPool

-DefObjType <> The Default Object Type for which to modify the Auto-upgrade settings.

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

<CommonParameters>

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

        Required?                    false

        Position?                    named

        Default value                Add

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                HKEY_CURRENT_CONFIG

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                REG_SZ

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
DefObjType
DisplayName
Path
Action
DWORDValue
HiveType
RegistryName
RegType
SiteId
StringValue
CommonParameters
Id
DisplayName
ObjType
Path
Action
DWORDValue
HiveType
RegistryName
RegType
StringValue
CommonParameters
InputObject
RASSerilazableObj
DisplayName
Path
Action
DWORDValue
HiveType
RegistryName
RegType
StringValue
CommonParameters
Name
SiteId
DisplayName
ObjType
Path
Action
DWORDValue
HiveType
RegistryName
RegType
StringValue
CommonParameters
ActionType
HiveType
ValueType
RASSerilazableObj
OptimizationServerObjType
ServerDefObjType
Get-RASImageOptimizationRegistry
Remove-RASImageOptimizationRegistry
        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                900

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                Before

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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 documentation. 
DefObjType
Message
MessageTitle
Enabled
SendMsgSecs
SendMsgWhen
SiteId
CommonParameters
Id
Message
MessageTitle
ObjType
Enabled
SendMsgSecs
SendMsgWhen
CommonParameters
InputObject
RASSerilazableObj
Message
MessageTitle
Enabled
SendMsgSecs
SendMsgWhen
CommonParameters
Name
SiteId
Message
MessageTitle
ObjType
Enabled
SendMsgSecs
SendMsgWhen
CommonParameters
SendMsgWhen
RASSerilazableObj
HostPoolObjType
ServerDefObjType
Get-RASAutoUpgrade
Get-RASAutoUpgradeMessage
Set-RASAutoUpgradeMessage
Remove-RASAutoUpgradeMessage

Add-RASFSLogixCCDLocation

NAME

Add-RASFSLogixCCDLocation

SYNOPSIS

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

SYNTAX

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

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

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

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

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

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

Add-RASFSLogixCCDLocation [-InputObject] <RASSerilazableObj> -CCDLocation <string> -GeneralSettings <SwitchParameter> [<CommonParameters>]

Add-RASFSLogixCCDLocation [-InputObject] <RASSerilazableObj> -CCDLocation <string> -OfficeContainer <SwitchParameter> [<CommonParameters>]

Add-RASFSLogixCCDLocation [-InputObject] <RASSerilazableObj> -CCDLocation <string> -ProfileContainer <SwitchParameter> [<CommonParameters>]

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

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

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

DESCRIPTION

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

PARAMETERS

-CCDLocation <string> Specifies the 'CCDLocation' path to add to the CCDLocation List.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

  • Get-RASFSLogix

  • Set-RASFSLogix

  • Get-RASFSLogixCCDLocation

  • Remove-RASFSLogixCCDLocation

Add-RASFSLogixFolder

NAME

Add-RASFSLogixFolder

SYNOPSIS

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

SYNTAX

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

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

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

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

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

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

Add-RASFSLogixFolder [-] <> - <string> - {Inclusion | Exclusion} [- {None | CopyBase | CopyBack}] [<>]

Add-RASFSLogixFolder [-] <> - <string> - {Inclusion | Exclusion} [- {None | CopyBase | CopyBack}] [<>]

Add-RASFSLogixFolder [-] <> - <string> - {Inclusion | Exclusion} - <SwitchParameter> [- {None | CopyBase | CopyBack}] [<>]

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

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

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

DESCRIPTION

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

PARAMETERS

-ExcludeFolderCopy <> Specifies the 'Exclude Folder Copy', in case of adding to the Exclude Folder List.

Possible values: None, CopyBase, CopyBack

-FolderListType <> Specifies the 'Folder List Type'.

Possible values: Inclusion, Exclusion

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

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

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

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

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

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

-ObjType <> The Object Type for which to modify the FSLogix settings.

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

-DefObjType <> The Default Object Type for which to modify the FSLogix settings.

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

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

RELATED LINKS

Add-RASFSLogixUser

NAME

Add-RASFSLogixUser

SYNOPSIS

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

SYNTAX

Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>]

Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>]

Add-RASFSLogixUser - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [- <uint>] [<>]

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

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

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

Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>]

Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>]

Add-RASFSLogixUser [-] <> - <SwitchParameter> - {Inclusion | Exclusion} [- <string>] [- <string>] [<>]

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

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

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

DESCRIPTION

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

PARAMETERS

-UserListType <> Specifies the 'User List Type'.

Possible values: Inclusion, Exclusion

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

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

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

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

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

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

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

-ObjType <> The Object Type for which to modify the FSLogix settings.

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

-DefObjType <> The Default Object Type for which to modify the FSLogix settings.

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

-ProfileContainer <SwitchParameter> Set the Profile Container settings.

-OfficeContainer <SwitchParameter> Sets the Office Container settings.

-GeneralSettings <SwitchParameter> Sets the General settings.

<CommonParameters>

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASFSLogixUser -DefObjType RDSDef -ContainerType Profile -UserListType Inclusion -Account "JaneDoe"

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

Add-RASFSLogixUser -Name "RDSHostPool1" -ObjType RDSHostPool -ContainerType Profile -UserListType Exclusion -Account "SID://DOMAIN/JaneDoe"

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

RELATED LINKS

Add-RASVDIHostPoolMember

NAME

Add-RASVDIHostPoolMember

SYNOPSIS

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

SYNTAX

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

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

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

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

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

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

DESCRIPTION

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

PARAMETERS

-VDIHostPoolName <string> The VDI Host Pool name.

-SiteId <uint> Site ID where the VDI Host Pool is located.

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

-VDIHostPoolId <uint> The VDI Host Pool ID.

-InputObject <> An object of type VDIHostPool identifying the target VDI Host Pool.

The object is obtained using the Get-RASVDIHostPool cmdlet.

-Type <> The VDI Host Pool Member Type.

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

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

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

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

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

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

This parameter is only accepted with Type: GUEST.

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

This parameter is only accepted with Type: NATIVEPOOL.

-NoInstall <SwitchParameter> Specifies not to install the RAS Guest Agent on the server.

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

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

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

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

-Username <string> An administrator account for push installing the RAS Guest Agent in the VM.

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

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

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

This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

<CommonParameters>

INPUTS

OUTPUTS

-none-

EXAMPLES

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

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

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

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

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

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

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

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

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

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

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

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

The Type TEMPLATEGUEST requires the VDITemplateId to be specified.

RELATED LINKS

        Required?                    false

        Position?                    named

        Default value                CopyBase, CopyBack

        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                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
Folder
FolderListType
ExcludeFolderCopy
SiteId
CommonParameters
DefObjType
Folder
FolderListType
ExcludeFolderCopy
SiteId
CommonParameters
DefObjType
Folder
FolderListType
ProfileContainer
ExcludeFolderCopy
SiteId
CommonParameters
Id
Folder
FolderListType
ObjType
ExcludeFolderCopy
CommonParameters
Id
Folder
FolderListType
ObjType
ExcludeFolderCopy
CommonParameters
Id
Folder
FolderListType
ObjType
ProfileContainer
ExcludeFolderCopy
CommonParameters
InputObject
RASSerilazableObj
Folder
FolderListType
ExcludeFolderCopy
CommonParameters
InputObject
RASSerilazableObj
Folder
FolderListType
ExcludeFolderCopy
CommonParameters
InputObject
RASSerilazableObj
Folder
FolderListType
ProfileContainer
ExcludeFolderCopy
CommonParameters
Name
SiteId
Folder
FolderListType
ObjType
ExcludeFolderCopy
CommonParameters
Name
SiteId
Folder
FolderListType
ObjType
ExcludeFolderCopy
CommonParameters
Name
SiteId
Folder
FolderListType
ObjType
ProfileContainer
ExcludeFolderCopy
CommonParameters
ExcludeFolderCopy
FSLogixListType
RASSerilazableObj
FSLogixServerObjType
ServerDefObjType
Get-RASFSLogix
Set-RASFSLogix
Get-RASFSLogixFolder
Remove-RASFSLogixFolder
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        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
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
DefObjType
GeneralSettings
UserListType
Account
SID
SiteId
CommonParameters
DefObjType
OfficeContainer
UserListType
Account
SID
SiteId
CommonParameters
DefObjType
ProfileContainer
UserListType
Account
SID
SiteId
CommonParameters
Id
GeneralSettings
ObjType
UserListType
Account
SID
CommonParameters
Id
ObjType
OfficeContainer
UserListType
Account
SID
CommonParameters
Id
ObjType
ProfileContainer
UserListType
Account
SID
CommonParameters
InputObject
RASSerilazableObj
GeneralSettings
UserListType
Account
SID
CommonParameters
InputObject
RASSerilazableObj
OfficeContainer
UserListType
Account
SID
CommonParameters
InputObject
RASSerilazableObj
ProfileContainer
UserListType
Account
SID
CommonParameters
Name
SiteId
GeneralSettings
ObjType
UserListType
Account
SID
CommonParameters
Name
SiteId
ObjType
OfficeContainer
UserListType
Account
SID
CommonParameters
Name
SiteId
ObjType
ProfileContainer
UserListType
Account
SID
CommonParameters
FSLogixListType
RASSerilazableObj
FSLogixServerObjType
ServerDefObjType
Get-RASFSLogix
Set-RASFSLogix
Get-RASFSLogixUser
Remove-RASFSLogixUser
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                AllGuestsInProvider

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

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

        Accept pipeline input?       false

        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 
VDIHostPoolId
Name
Type
NativePoolId
NoInstall
ProviderId
VMId
VMIds
CommonParameters
VDIHostPoolId
Name
Password
Type
Username
NativePoolId
ProviderId
VMId
VMIds
CommonParameters
InputObject
VDIHostPool
Name
Type
NativePoolId
NoInstall
ProviderId
VMId
VMIds
CommonParameters
InputObject
VDIHostPool
Name
Password
Type
Username
NativePoolId
ProviderId
VMId
VMIds
CommonParameters
VDIHostPoolName
SiteId
Name
Type
NativePoolId
NoInstall
ProviderId
VMId
VMIds
CommonParameters
VDIHostPoolName
SiteId
Name
Password
Type
Username
NativePoolId
ProviderId
VMId
VMIds
CommonParameters
VDIHostPool
VDIHostPool
VDIHostPool
New-RASVDIHostPool
Get-RASVDIHostPool
Set-RASVDIHostPool
Remove-RASVDIHostPool
Get-RASVDIHostPoolMember
Remove-RASVDIHostPoolMember

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

<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