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...
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.
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.
includes cmdlet examples demonstrating how to perform the most common Parallels RAS management tasks.
For additional Parallels RAS documentation and resources, please visit
© 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 requires 'Connection Broker' component of a matching version to communicate with.
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
To get started with Parallels RAS PowerShell, complete thefollowing steps:
Open the Windows PowerShell console.
In the console, type the following command to import the Parallels RAS PowerShell module:
Import-Module RASAdmin
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"
© 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.
Execute the following cmdlet to see the list of cmdlets included in the Parallels RAS PowerShell module:
Get-Command -Module RASAdmin
Execute other cmdlets. For example, try executing the Get-RASGateway cmdlet to retrieve information about RAS Secure Gateway(s). The example below returns information about all RAS Secure Gateways available in the RAS Licensing Server site:
Get-RASGateway
To see help for a cmdlet, execute Get-Help passing a cmdlet name:
Get-Help Get-RASGateway
To apply changes you've made to the farm configuration, use the Invoke-RASApply cmdlet:
Invoke-RASApply
To activate a Parallels RAS license, use Invoke-RASLicenseActivate:
Invoke-RASLicenseActivate
When executing the cmdlet above, you'll be prompted to enter your Parallels My Account email address and password. Passing a license key (the -Key parameter) is optional. If omitted (as in the example above), Parallels RAS is activated as a trial.
Add-RASExcludeADGroup [-Account <string>] [-SID <string>] [-SiteId <uint>] [<CommonParameters>]
Adds an Exclude AD group to the Exclude AD group settings list.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASExcludeADGroup -Account Guests
Adds an Exclude AD group to the Exclude AD group settings list for the current site.
Get-RASADIntegrationSettings [-SiteId <uint>] [<CommonParameters>]
Obtains the active AD integration settings for the current site.
-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.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASADIntegrationSettings
Obtains the active AD integration settings for the current site.
-none-
Retrieves information about RAS Admin sessions.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAdminSession
Retrieves information about RAS Admin sessions.
Get-RASAVDCustomHost -ProviderId <uint> [-ShowHostsInHostPool <SwitchParameter>] [<CommonParameters>]
The cmdlet returns a list of Azure Virtual Desktop Custom Hosts.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information.
-ShowHostsInHostPool <SwitchParameter> Show Hosts in existing host pools.
<CommonParameters>
-none-
---------- 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.
-none-
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. 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. This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. Get-RASAppPackageAvailVersions
Retrieves the application package version.
Get-RASAppPackageAvailVersions [-] <string> [[-] <uint>] [<>]
Retrieves the application package version.
-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>
-none-
---------- 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.
-none-
Get-RASAppPackageSettings
Retrieves Application Package settings.
Get-RASAppPackageSettings [- <uint>] [<>]
Retrieves the active Application Package settings for the current site.
-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>
-none-
---------- EXAMPLE 1 ----------
Get-RASAppPackageSettings
Obtains the active Application package settings for the current site.
Get-RASAVDVirtualNetwork
The cmdlet returns a list of Azure Virtual Desktop Virtual Networks.
Get-RASAVDVirtualNetwork - <string> - <uint> [<>]
The cmdlet returns a list of Azure Virtual Desktop Virtual Networks.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Virtual Network information.
-Location <string> Location of the Azure Virtual Desktop Provider.
<CommonParameters>
-none-
---------- 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.
-none-
Get-RASAVDPredefinedImages
Retrieves the predefined Azure Virtual Desktop VM images.
-none-
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.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAVDPredefinedImages
Retrieves information about the predefined AVD VM images.
Get-RASBrokerAutoPromotionSettings
Obtains Parallels RAS Broker Auto Promotion settings.
Get-RASBrokerAutoPromotionSettings [[-] <uint>] [<>]
The Get-RASBrokerAutoPromotionSettings cmdlet obtains the complete set of Parallels RAS Broker Auto Promotion settings for the current session.
-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.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASBrokerAutoPromotionSettings
Obtains Parallels RAS Auto Promote settings for the current session.
Get-RASAVDLocation
The cmdlet returns a list of Azure Virtual Desktop Locations.
Get-RASAVDLocation - <uint> [<>]
The cmdlet returns a list of Azure Virtual Desktop Locations.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Location information.
<CommonParameters>
-none-
---------- 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.
-none-
Get-RASClientSettings
Retrieves the Parallels RAS client settings.
Get-RASClientSettings [- <uint>] [<>]
Retrieves the Parallels RAS client settings.
-SiteId <uint> The site ID.
To obtain the ID of a desired site, use the Get-Sites cmdlet.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASClientSettings
Retrieves the RAS Farm client settings. ---------- EXAMPLE 2 ----------
Get-RASClientSettings | Format-List
Retrieves the RAS client settings.
Get-RASAVDGallery
The cmdlet returns a list of Azure Virtual Desktop Galleries.
Get-RASAVDGallery - <uint> [<>]
The cmdlet returns a list of Azure Virtual Desktop Galleries.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Gallery information.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAVDGallery -ProviderId 2
Retrieves a list of Galleries which fall under the Provider specified.
-none-
Get-RASAVDResourceGroup
The cmdlet returns a list of Azure Virtual Desktop Resource Groups.
Get-RASAVDResourceGroup - <uint> [<>]
The cmdlet returns a list of Azure Virtual Desktop Resource Groups.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop Resource Group information.
<CommonParameters>
-none-
---------- 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.
Get-RASCPUOptimizationSettings
Obtains Parallels RAS CPU Optimization settings.
Get-RASCPUOptimizationSettings [- <uint>] [<>]
The Get-RASCPUOptimizationSettings cmdlet obtains the complete set of CPU optimization settings for the current session.
-SiteId <uint> The site ID.
To obtain the ID of a desired site, use the Get-Sites cmdlet.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASCPUOptimizationSettings
Obtains Parallels RAS CPU optimization settings for the current session.
Add-RASThemeCustomImage -ImageFile <string> [-Name <string>] [-SiteId <uint>] [<CommonParameters>]
Add a theme custom image.
-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>
-none-
-none-
---------- 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.
Add-RASThemeFooterURL [-Id] <uint> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]
Add-RASThemeFooterURL [-Name] <string> -Text <string> -URL <string> [-Tooltip <string>] [<CommonParameters>]
Adds a new footer URL to the footer URLs list.
-URL <string> The URL
-Text <string> The text
-Tooltip <string> The tooltip
-Name <string> Name of the Theme policy to modify.
This must be the actual Theme policy name used in the RAS farm.
-Id <uint> The ID of the Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.
<CommonParameters>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASThemeFooterURL -Id 1 -URL link -Text text -Tooltip tooltip
Adds a footer URL to theme with Id 1.
Get-RASAVDDefaultSettings [[-SiteId] <uint>] -DefObjType {AVDMultiSessionDefaultSettings | AVDSingleSessionDefaultSettings} [<CommonParameters>]
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.
-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 <AVDDefObjType> The Default Object Type
Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAVDDefaultSettings -DefObjType AVDSingleSessionDefaultSettings
Retrieves default Personal AVD settings from the specified site. ---------- EXAMPLE 2 ----------
Get-RASAVDDefaultSettings -DefObjType AVDMultiSessionDefaultSettings
Retrieves default Pooled AVD settings from the specified site.
Get-RASAllowedDevicesSetting [-SiteId <uint>] [<CommonParameters>]
Returns settings for types of allowed clients.
-SiteId <uint> The site ID.
To obtain the ID of a desired site, use the Get-Sites cmdlet.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAllowedDevicesSetting
Retrieves settings for each of device types shown in 'Allowed Devices'. The permission of the device is represented as a boolean.
Get-RASAVDPublisher -Location <string> -ProviderId <uint> [<CommonParameters>]
The cmdlet returns a list of Azure Virtual Desktop Publishers.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.
-Location <string> Location of the Azure Virtual Desktop Provider.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAVDPublisher -ProviderId 2 -Location "westeurope"
Retrieves a list of Publishers which fall under the Provider and Location specified.
-none-
Get-RASClientPolicyConnection [-Id] <uint> [<CommonParameters>]
Get-RASClientPolicyConnection [[-Name] <string>] [<CommonParameters>]
Retrieves the connection list.
-Name <string> Name of the client policy for which to retrieve the information.
-Id <uint> The ID of the client policy for which to retrieve the information.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASClientPolicyConnection -Id 1
Retrieves the following client policy connection with Id=1.
Get-RASAVDSettings [-SiteId <uint>] [<CommonParameters>]
Retrieves the Azure Virtual Desktop Features settings.
-SiteId <uint> Site ID from which to retrieve the AVD settings.
If the parameter is omitted, the Licensing Server site ID will be used.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAVDSettings
Retrieves the AVD Features Settings.
Get-RASAuthSettings [-SiteId <uint>] [<CommonParameters>]
Retrieves all of the available connection settings for the Authentication category.
-SiteId <uint> The site ID.
To obtain the ID of a desired site, use the Get-Sites cmdlet.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAuthSettings
Retrieves RAS authentication settings.
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. 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. 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. This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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. 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. 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. 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. 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. 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. 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
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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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. 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. Required? false
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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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. Get-RASAdminAccount [[-Id] <uint>] [<CommonParameters>]
Get-RASAdminAccount [[-Name] <string>] [<CommonParameters>]
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).
-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>
-none-
---------- 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.
Add-RASAVDHostPoolAssignment
Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List.
Add-RASAVDHostPoolAssignment [-] <uint> [- <string>] [- <string>] [<>]
Add-RASAVDHostPoolAssignment [-] <> [- <string>] [- <string>] [<>]
Add-RASAVDHostPoolAssignment [-] <string> [[-] <uint>] [- <string>] [- <string>] [<>]
Adds a user or group to the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.
-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>
-none-
-none-
---------- 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.
Add-RASHALBDevice
Add a new HALB Device to the specific HALB Virtual Server instance.
Add-RASHALBDevice [[-] <uint>] [-] <string> [[-] <SwitchParameter>] [<>]
Add-RASHALBDevice [-] <> [-] <string> [[-] <SwitchParameter>] [<>]
Add-RASHALBDevice [-] <string> [[-] <uint>] [-] <string> [[-] <SwitchParameter>] [<>]
Add a new HALB Device to the specific HALB Virtual Server instance.
-HALBName <string>
-SiteId <uint>
-HALBId <uint>
-DeviceIP <string>
-NoInstall <SwitchParameter>
-InputObject <> An object of type HALBSettings.
The object is obtained using the Get-RASHALB cmdlet.
<CommonParameters>
-none-
---------- 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.
Add-RASProviderAdminCredentials
Adds Admin Credential property to the list.
Add-RASProviderAdminCredentials [-] <uint> [- <bool>] [- <string>] [- <string>] [<>]
Add-RASProviderAdminCredentials [-] <string> [[-] <uint>] [- <bool>] [- <string>] [- <string>] [<>]
Adds Admin Credential to the following list.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASProviderAdminCredential -Id 1 -Enabled $true -Username "Administrator"
Adds the Admin Credentials to the property list
Add-RASURLRedirectionEntry
Adds a URL redirection entry.
Add-RASURLRedirectionEntry - <string> [- {DoNotRedirect | Redirect}] [- <bool>] [- <uint>] [<>]
Adds a URL redirection to the URL redirection settings list for the current site.
-Enabled <bool> Whether the URL redirection will be enabled or disabled.
-URL <string> The URL to redirect or not.
-Action <> The redirect action type.
Possible values: DoNotRedirect, Redirect
-SiteId <uint> Site ID in which to modify the specified URL redirection settings.
<CommonParameters>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASURLRedirectionEntry -URL test.com
Adds a URL redirection for test.com to the URL redirection settings list for the current site.
Find-RASMFAUsers
Find MFA TOTP/EmailOTP users by matching substring.
Find-RASMFAUsers - <string> [- <uint>] [- <uint>] [- {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<>]
Find MFA TOTP/EmailOTP users by matching substring.
-SiteId <uint> Site ID where the users will be searched.
-Like <string> Find users matching this pattern.
-MFAId <uint> The ID of the MFA Provider to be modified.
In case of TOTP Provider, the ID will always be 0. Default: 0.
-Type <> 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
<CommonParameters>
-none-
-none-
---------- 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".
Get-RASAgentDiagnostic
Retrieves RAS Agent Diagnostic information.
Get-RASAgentDiagnostic - {RDS | Provider | Gateway | Guest | Broker | PA | HALBDevice | EnrollmentServer} - <string> [- <uint>] [<>]
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.
-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>
-none-
---------- 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'.
Get-RASAVDWorkspaceStatus
Retrieves the status of one or multiple Azure Virtual Desktop Workspaces.
Get-RASAVDWorkspaceStatus [[-] <uint>] [<>]
Get-RASAVDWorkspaceStatus [[-] <>] [<>]
Get-RASAVDWorkspaceStatus [[-] <string>] [[-] <uint>] [<>]
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.
-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>
---------- 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.
Get-RASAVDOffer
The cmdlet returns a list of Azure Virtual Desktop Offers.
Get-RASAVDOffer - <string> - <uint> - <string> [<>]
The cmdlet returns a list of Azure Virtual Desktop Offers.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.
-Location <string> Location of the Azure Virtual Desktop Provider.
-Publisher <string> The Azure Virtual Desktop Publisher.
<CommonParameters>
-none-
---------- 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.
-none-
Add-RASPubAppFileExt
Adds a file extension for the specified published application.
Add-RASPubAppFileExt [-] <uint> - <string> [- <uint>] [<>]
Add-RASPubAppFileExt [-] <> - <string> [- <uint>] [<>]
This cmdlet only allows you to add a file extension.
To modify other file extensions, use the Set-RASPubAppFileExt cmdlet.
-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>
-none-
---------- EXAMPLE 1 ----------
Add-RASPubAppFileExt -Id 3 -Extension "txt"
Adds the specified file extension for the resource specified by ID.
Add-RASPrintingAutoInstallFont
Adds an Auto install font to Parallels RAS Universal Printing settings.
Add-RASPrintingAutoInstallFont - <string> [- <SwitchParameter>] [- <uint>] [<>]
Adds an Auto install font to Parallels RAS Universal Printing settings.
-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>
-none-
-none-
---------- 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.
Get-RASAVDVersion
The cmdlet retrieves a list or the latest Azure Virtual Desktop Version.
Get-RASAVDVersion - <string> - <string> - <uint> - <string> - {All | Latest} - <string> [<>]
The cmdlet retrieves a list or the latest Azure Virtual Desktop Version.
-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.
-SKU <string> The Azure Virtual Desktop SKU.
-RequestType <> Whether to retrieve a list of all available versions or just the latest version.
Possible values: All, Latest
<CommonParameters>
-none-
---------- 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.
-none-
Get-RASClientPolicyAssignment
Retrieves information about a client policy assignment.
Get-RASClientPolicyAssignment [-] <uint> [<>]
Get-RASClientPolicyAssignment [-] <string> [<>]
Retrieves information about a client policy assignment.
-Name <string> Name of the client policy for which to retrieve the information.
-Id <uint> The ID of the client policy for which to retrieve the information.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASClientPolicyAssignment -Name PDFPolicy
Retrieves information about the assignment from a client policy named PDFPolicy.
Get-RASAVDVMSize
The cmdlet returns a list of Azure Virtual Desktop VM Sizes.
Get-RASAVDVMSize - <string> - <uint> [<>]
Get-RASAVDVMSize - <string> - <uint> [<>]
The cmdlet returns a list of Azure Virtual Desktop VM Sizes.
-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>
-none-
---------- 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.
-none-
Get-RASClientPolicy
Retrieves information about one or all the client policies.
Get-RASClientPolicy [-] <uint> [<>]
Get-RASClientPolicy [[-] <string>] [<>]
Retrieves information about one or all the client policies.
-Name <string> Name of the client policy for which to retrieve the information.
-Id <uint> The ID of the client policy for which to retrieve the information.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASClientPolicy -Name PDFPolicy
Retrieves information about the client policy named PDFPolicy. ---------- EXAMPLE 2 ----------
Get-RASClientPolicy
Retrieves information about all the client policies.
Get-RASCurrentAdminPermissions
Retrieve information about the current admin permissions.
-none-
The cmdlet returns the current admin permissions.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASCurrentAdminPermissions
Retrieves information about the current admin permissions.
Get-RASCustomPermission
Retrieves the permissions of a RAS custom admin account.
Get-RASCustomPermission [-] <uint> [<>]
Retrieves the permissions of a RAS custom admin account.
-AdminId <uint> Admin ID to retrieve the specified RAS Custom Administrator Account.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASCustomPermission -AdminId 100
Retrieves the permissions of a custom administrator specified by ID.
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. Add-RASClientPolicyConnection [-Id] <uint> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]
Add-RASClientPolicyConnection [-InputObject] <ClientRules> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]
Add-RASClientPolicyConnection [-Name] <string> -Mode {GatewayMode | GatewaySSLMode | DirectMode | DirectSSLMode} -Server <string> -ServerPort <uint> [<CommonParameters>]
Adds a new connection to the Connection List
-Mode <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 <ClientRules> The client policy object to modify.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Add-RASClientPolicyConnection -Id 1 -Mode "Gateway Mode" -Server "xyz" -ServerPort "80"
Adds the client policy connection with the following settings with Id=1.
Add-RASMFAUsers -FilePath <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]
Import MFA TOTP/EmailOTP users from a CSV file.
-FilePath <string> File path to CSV containing user and secret.
Must be in the format "user,secret".
-SiteId <uint> Site ID in where the users will be imported.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-MFAId <uint> The ID of the MFA Provider to be modified.
In case of TOTP Provider, the ID will always be 0. Default: 0.
-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
<CommonParameters>
-none-
-none-
---------- 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.
Copy-RASPubItem -Id <uint> [-ParentId <uint>] [-PreviousId <uint>] [<CommonParameters>]
Copy-RASPubItem [-InputObject] <PubItem> [-ParentId <uint>] [-PreviousId <uint>] [<CommonParameters>]
Copy (duplicate) a published item.
-Id <uint> ID of Pub item to duplicate.
To obtain the pub item ID, use the Get-PubItem command.
-InputObject <PubItem> 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>
---------- 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.
Get-RASAVDHostPoolAssignment [[-Id] <uint>] [<CommonParameters>]
Get-RASAVDHostPoolAssignment [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
Retrieves the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.
-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>
-none-
---------- 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.
Get-RASAVDHostPool [[-Id] <uint>] [<CommonParameters>]
Get-RASAVDHostPool [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
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.
-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>
-none-
---------- 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.
Add-RASTemplateLicenseKey [-Id] <uint> -Key <string> -KeyLimit <uint> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>]
Add-RASTemplateLicenseKey [-InputObject] <Template> -Key <string> -KeyLimit <uint> [<CommonParameters>]
Modifies properties of a license key used by a RAS Template.
-Id <uint> The ID of a RAS Template to modify.
-ObjType <TemplateObjType> The Object Type for which to add Template License Key.
Possible values: RDSTemplate, VDITemplate, AVDTemplate
-InputObject <Template> An object of type Template representing a RAS Template.
The object is obtained using the Get-Template cmdlet.
-Key <string> The license key.
-KeyLimit <uint> The max limit for the license key.
<CommonParameters>
-none-
---------- 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.
Get-RASAVDHost [[-SiteId] <uint>] [-ProviderId <uint>] [<CommonParameters>]
Get-RASAVDHost [-VMId] <string> [[-SiteId] <uint>] -ProviderId <uint> [<CommonParameters>]
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.
-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>
-none-
---------- 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.
Get-RASAppPackage [-Id] <uint> [<CommonParameters>]
Get-RASAppPackage [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
Retrieves the application package settings.
-Name <string> The name of the application package from which to retrieve the information.
This must be the actual application package name used in the RAS farm.
-SiteId <uint> The ID of the Site from which to retrieve the application package information.
If the parameter is omitted, the Licensing Server Site ID will be used.
-Id <uint> The ID of an application package from which to retrieve the information.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAppPackage
Retrieves the list of Application Packages. ---------- EXAMPLE 2 ----------
Get-RASAppPackage -Id 1
Retrieves the Application Package with Id 1.
Add-RASThemeGroupFilter [-Id] <uint> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]
Add-RASThemeGroupFilter [-Name] <string> [-GroupName <string>] [-GroupSID <string>] [<CommonParameters>]
Adds a new group filter to the theme group filters.
-GroupName <string> The name of the group list
-GroupSID <string> The group SID
-Name <string> Name of the Theme policy to modify.
This must be the actual Theme policy name used in the RAS farm.
-Id <uint> The ID of the Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.
<CommonParameters>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASThemeGroupFilter -Id 1 -GroupName GroupListName
Adds a group filter with name GroupListName for theme with Id 1.
Get-RASAVDSKU -Location <string> -Offer <string> -ProviderId <uint> -Publisher <string> [<CommonParameters>]
The cmdlet returns a list of Azure Virtual Desktop Stock Keeping Units.
-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>
-none-
---------- 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.
-none-
Get-RASAVDWorkspace [[-Id] <uint>] [<CommonParameters>]
Get-RASAVDWorkspace [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
Retrieves information about the specified Azure Virtual Desktop Workspace or all Azure Virtual Desktop Workspaces within a site.
-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>
-none-
---------- 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.
Get-RASCriteriaGatewayIP -DefObjType {MFA} [-SiteId <uint>] [<CommonParameters>]
Get-RASCriteriaGatewayIP [-Id] <uint> -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]
Get-RASCriteriaGatewayIP [-Name] <string> [[-SiteId] <uint>] -ObjType {ClientPolicy | PubItem | MFA | LogonHours} [-RuleId <uint>] [<CommonParameters>]
Retrieves the Criteria Gateway List within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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 <CriteriaObjType> The Object Type for which to retrieve the Criteria settings.
Possible values: ClientPolicy, PubItem, MFA, LogonHours
-DefObjType <CriteriaDefObjType> The Default Object Type for which to retrieve the Criteria settings.
Possible values: MFA
-RuleId <uint> The ID of the Rule to retrieve.
<CommonParameters>
-none-
---------- 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.
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>]
Retrieves the Criteria Theme List within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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 <CriteriaObjType> The Object Type for which to retrieve the Criteria settings.
Possible values: ClientPolicy, PubItem, MFA, LogonHours
-DefObjType <CriteriaDefObjType> The Default Object Type for which to retrieve the Criteria settings.
Possible values: MFA
-RuleId <uint> The ID of the Rule to retrieve.
<CommonParameters>
-none-
---------- 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.
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. 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? false
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? 3
Default value False
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. 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. 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? false
Position? named
Default value DoNotRedirect
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. 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 0
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value TOTP
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. 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. 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. 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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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. 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? 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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. Required? false
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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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. 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? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value TOTP
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. 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. 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. 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. 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? 0
Default value
Accept pipeline input? true (ByValue)
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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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. 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? 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. 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? 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. 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. 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. 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. 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. Get-RASCertificate [[-Id] <uint>] [<CommonParameters>]
Get-RASCertificate [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
Retrieves information about one or multiple Certificates.
-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>
-none-
---------- 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.
Get-RASCustomRoute [[-Id] <uint>] [<CommonParameters>]
Get-RASCustomRoute [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
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.
-Name <string> The name of the Custom Route for which to retrieve the information.
-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.
-Id <uint> The ID of a Custom Route for which to retrieve the information.
<CommonParameters>
-none-
---------- 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.
Add-RASAppPackageAssigned
Assigns an application package to an object type.
Add-RASAppPackageAssigned - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <string> - <string> [- <uint>] [<>]
Add-RASAppPackageAssigned [-] <uint> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <string> - <string> [<>]
Add-RASAppPackageAssigned [-] <> - <string> - <string> [<>]
Add-RASAppPackageAssigned [-] <string> [[-] <uint>] - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <string> - <string> [<>]
Adds assigned application package to an object type.
-Name <string> The name for which to modify the application package assigned settings.
-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.
-Id <uint> The ID for which to modify the Application Package assigned settings.
-ObjType <> The Object Type for which to modify the assigned application package settings.
Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool
-DefObjType <> The Default Object Type for which to modify the application package settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
-InputObject <> An object of type RDS, RDSHostPool or VDIHostPool for which to modify the Assigned Application settings.
-PackageName <string> The application package name.
This must be the actual application package name used in the RAS farm.
-Version <string> The version of the application package.
This must be the actual application package version used in the RAS farm.
<CommonParameters>
-none-
-none-
---------- 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.
Add-RASCriteriaGatewayIP
Adds a Gateway IP to the Criteria Gateway List.
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>] [<>]
Adds a Gateway IP to the Criteria Gateway List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaGatewayIP -Id 1 -ObjType MFA -IP "1.2.3.4"
Adds the specified Gateway IP to the Criteria Gateway List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaGatewayIP -Name "Logon1" -ObjType MFA -GatewayId 1
Adds the IP from the Gateway with specified ID to the Criteria Gateway List within the Criteria Settings of the specified MFA by Name.
Add-RASCriteriaHardwareID
Adds a Hardware ID to the Criteria Hardware ID List.
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>] [<>]
Adds a Hardware ID to the Criteria Hardware ID List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaHardwareID -Id 1 -ObjType MFA -HardwareID "D4-3D-7E-BF-4B-DC"
Adds the specified Hardware ID to the Criteria Hardware ID List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaHardwareID -Name "Logon1" -ObjType MFA -HardwareID "D4-3D-7E-BF-4B-DC"
Adds the specified Hardware ID to the Criteria Hardware ID List within the Criteria Settings of the specified MFA by Name.
Add-RASCriteriaSecurityPrincipal
Adds a user, group or machine to the Criteria Security Principal List.
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>] [<>]
Adds a user, group or machine to the Criteria Security Principal List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaSecurityPrincipal -Id 1 -ObjType MFA -Account "JaneDoe"
Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaSecurityPrincipal -Name "Logon1" -ObjType MFA -Account "SID://DOMAIN/JaneDoe"
Adds a user to the Criteria Security Principal List within the Criteria Settings of the specified MFA by Name.
Add-RASCriteriaTheme
Adds a Theme to the Criteria Theme List.
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>] [<>]
Adds a Theme to the Criteria Theme List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaTheme -Id 1 -ObjType LogonHours -ThemeName "Theme1"
Adds the Theme specified by Name to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaTheme -Name "Logon1" -ObjType LogonHours -ThemeId 1
Adds the Theme specified by ID to the Criteria Theme List within the Criteria Settings of the specified Logon Hours by Name.
Add-RASImageOptimizationWindowsScheduledTask
Adds Windows Schedule Task.
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> [<>]
Adds Windows Schedule Task to the following list.
-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>
-none-
-none-
---------- 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.
Add-RASImageOptimizationWindowsService
Adds Windows Custom Services.
Add-RASImageOptimizationWindowsService - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <string>] [- <string>] [- <string>] [- <uint>] [<>]
Add-RASImageOptimizationWindowsService [-] <uint> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [- <string>] [- <string>] [- <string>] [<>]
Add-RASImageOptimizationWindowsService [-] <> [- <string>] [- <string>] [- <string>] [<>]
Add-RASImageOptimizationWindowsService [-] <string> [[-] <uint>] - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [- <string>] [- <string>] [- <string>] [<>]
Adds Windows Custom Service to the following list.
-Aliases <string>
-DisplayName <string>
-ServiceName <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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASImageOptimizationWindowsService -Id 30 -ObjType RDS -DisplayName Name -Aliases alias -ServiceName "Service Name"
Adds the Windows Custom Services to the object type RDS.
Add-RASMFARadiusAttr
Adds attribute settings to Radius provider settings.
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> [<>]
The cmdlet appends new attribute settings to existing ones. All parameters are mandatory.
-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>
-none-
---------- EXAMPLE 1 ----------
Add-RASMFARadiusAttr -AttributeType IP -VendorID 1 -AttributeID 1 -Value 127.0.0.1 -Name AttrName -Vendor VendorName
Adds a new entry to Radius attributes of type IP. The "Value" parameter must be in a valid IP format (IPv4 only). ---------- EXAMPLE 2 ----------
Add-RASMFARadiusAttr -AttributeType String -VendorID 1 -AttributeID 1 -Value "This is a string" -Name AttrName -Vendor VendorName
Adds a new entry to Radius attributes of type String. The "Value" parameter can contain a character of any type, but cannot be empty. ---------- EXAMPLE 3 ----------
Add-RASMFARadiusAttr -AttributeType Number -VendorID 1 -AttributeID 1 -Value 42 -Name AttrName -Vendor VendorName
Adds a new entry to Radius attributes of type Number. The "Value" parameter must contain numbers. The input can also be a string but must contain numbers only. ---------- EXAMPLE 4 ----------
Add-RASMFARadiusAttr -AttributeType Time -VendorID 1 -AttributeID 1 -Value 1500892318 -Name AttrName -Vendor VendorName
Adds a new entry to Radius attributes of type Time. The "Value" parameter represents the date using the epoch time format.
Add-RASPubItemPreferredRoute
Adds a preferred route to the specified published resource.
Add-RASPubItemPreferredRoute [-] <uint> - <string> - <uint> - {Gateway | HALB | Custom} [- <string>] [- <bool>] [- <uint>] [<>]
Add-RASPubItemPreferredRoute [-] <> - <string> - <uint> - {Gateway | HALB | Custom} [- <string>] [- <bool>] [- <uint>] [<>]
This cmdlet allows you to add a preferred route to the specified published resource.
To modify preferred route options, use the Set-RASPubItemPreferredRoute cmdlet.
-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>
-none-
---------- 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.
Add-RASPubRDSAppServerAttr
Adds RDS application attributes to specific server from where the application is hosted.
Add-RASPubRDSAppServerAttr [-] <uint> - <uint> [- <string>] [- <uint>] [- <string>] [- <string>] [<>]
Add-RASPubRDSAppServerAttr [-] <> - <uint> [- <string>] [- <uint>] [- <string>] [- <string>] [<>]
Adds RDS application attributes to a specific server from where the application is hosted.
-ServerID <uint> RDS server ID on which the attributes will be updated.
-Target <string> Application target file. (i.e. calc.exe, file.txt, etc.)
-StartIn <string> Application working directory.
-Parameters <string> Application parameters.
-Id <uint> Published resource ID.
-InputObject <> An object specifying the published resource.
To obtain the object, use the Get-PubItem cmdlet.
-SiteId <uint> Site ID.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Add-RASPubRDSAppServerAtt -Id 2 -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"
Adds an existing per server application attribute settings by application Id. ---------- EXAMPLE 2 ----------
Add-RASPubRDSAppServerAtt -InputObject $RDSApp -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"
Adds an existing per server application attribute settings by input object. ---------- EXAMPLE 3 ----------
Get-RASPubRDSApp -Id 2 | Add-RASPubRDSAppServerAtt -ServerID 15 -Target cmd.exe -StartIn C:\Windows\ -Parameters "-param 1 -param 2"
Adds an existing per server application attribute settings by input object from pipeline.
Add-RASScheduleMessage
Adds schedule message information for a Schedule.
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}] [<>]
Adds schedule message information for a Schedule.
-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>
-none-
---------- 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.
Get-RASAVDHostStatus
Retrieves the list of, or a specific, Azure Virtual Desktop Host status.
Get-RASAVDHostStatus [-] <uint> [[-] <uint>] - <string> [- {Level1 | Level2 | Level3}] [- <string>] [<>]
Get-RASAVDHostStatus [-] <> [-] <uint> [[-] <uint>] [- {Level1 | Level2 | Level3}] [- <string>] [<>]
Get-RASAVDHostStatus [[-] <uint>] [[-] <uint>] [- {Level1 | Level2 | Level3}] [- <string>] [<>]
Retrieves the list of, or a specific, Azure Virtual Desktop Host status.
-ProviderId <uint> The ID of a Provider server from which to obtain the AVD Host list.
-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.
-HostId <string> The ID of the AVD Host. To obtain the ID, use the Get-RASAVDHost cmdlet.
-InputObject <> An object of type AVDHost representing a AVD Host for which to retrieve the information.
To obtain the object, use the Get-RASAVDHost cmdlet.
-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.
-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
<CommonParameters>
---------- 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.
Get-RASAVDHostPoolStatus
Retrieves the status of one or multiple Azure Virtual Desktop Host Pools.
Get-RASAVDHostPoolStatus [[-] <uint>] [<>]
Get-RASAVDHostPoolStatus [[-] <>] [<>]
Get-RASAVDHostPoolStatus [[-] <string>] [[-] <uint>] [<>]
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.
-Name <string> The name of the AVD Host Pool for which to retrieve the status.
-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.
-Id <uint> The ID of the AVD Host Pool. To obtain the ID, use the Get-RASAVDHostPool cmdlet.
-InputObject <> An object of type AVDHostPool representing the AVD Host Pool.
To obtain the object, use the Get-RASAVDHostPool cmdlet.
<CommonParameters>
---------- 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.
Get-RASAVDGalleryImage
The cmdlet returns a list of Azure Virtual Desktop Gallery Images.
Get-RASAVDGalleryImage - <string> - <string> - <uint> - <string> [<>]
The cmdlet returns a list of Azure Virtual Desktop Gallery Images.
-ProviderId <uint> Provider ID from which to retrieve the Azure Virtual Desktop VMSize information.
-Name <string> Name of the Azure Virtual Desktop Gallery.
-ResourceGroup <string> Resource Group of the Azure Virtual Desktop Gallery Image.
-Location <string> Location of the Azure Virtual Desktop Gallery Image.
<CommonParameters>
-none-
---------- 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.
-none-
Get-RASAppPackageAssigned
Retrieves the assigned application package settings.
Get-RASAppPackageAssigned - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <uint>] [<>]
Get-RASAppPackageAssigned [-] <uint> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<>]
Get-RASAppPackageAssigned [-] <string> [[-] <uint>] - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<>]
Retrieves the assigned application package settings.
-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.
-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.
-Id <uint> The ID from which to retrieve the assigned application package.
-ObjType <> The Object Type for which to retrieve the assigned application package settings.
Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool
-DefObjType <> The Default Object Type for which to retrieve the application package settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASAppPackageAssigned -Id 1 -ObjType RDS
Retrieves the assigned application package settings for the object type RDS.
Get-RASAutoUpgradeMessage
Retrieves schedule message information from Auto-upgrade settings.
Get-RASAutoUpgradeMessage - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <uint>] [- <uint>] [<>]
Get-RASAutoUpgradeMessage [-] <uint> - {RDSHostPool | VDIHostPool | AVDHostPool} [- <uint>] [<>]
Get-RASAutoUpgradeMessage [-] <string> [[-] <uint>] - {RDSHostPool | VDIHostPool | AVDHostPool} [- <uint>] [<>]
Retrieves schedule message information from Auto-upgrade settings.
-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>
-none-
---------- 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.
Get-RASBrokerStatus
Retrieves the RAS Connection Broker status information.
Get-RASBrokerStatus [[-] <uint>] [<>]
Get-RASBrokerStatus [[-] <>] [<>]
Get-RASBrokerStatus [[-] <string>] [[-] <uint>] [<>]
Retrieves the RAS Connection Broker status information.
-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>
---------- 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.
Get-RASCriteriaOS
Retrieves the Operating System Criteria.
Get-RASCriteriaOS - {} [- <uint>] [<>]
Get-RASCriteriaOS [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Get-RASCriteriaOS [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Retrieves the Operating System Criteria within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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>
-none-
---------- 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.
Get-RASCriteriaIP
Retrieves the Criteria IP List.
Get-RASCriteriaIP - {} [- <uint>] [<>]
Get-RASCriteriaIP [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Get-RASCriteriaIP [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Retrieves the Criteria IP List within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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>
-none-
---------- 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.
Get-RASCriteriaSecurityPrincipal
Retrieves the Criteria Security Principal List.
Get-RASCriteriaSecurityPrincipal - {} [- <uint>] [<>]
Get-RASCriteriaSecurityPrincipal [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Get-RASCriteriaSecurityPrincipal [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Retrieves the Criteria Security Principal List within the Criteof MFAria settings from a ClientPolicy, MFA or PubItem.
-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>
-none-
---------- 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.
Get-RASBroker
Retrieves information about one or multiple RAS Connection Broker servers.
Get-RASBroker [[-] <uint>] [<>]
Get-RASBroker [[-] <string>] [[-] <uint>] [<>]
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.
-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.
-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.
-Id <uint> The ID of the RAS Connection Broker server for which to retrieve the information.
<CommonParameters>
-none-
---------- 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.
Get-RASAgent
Retrieves RAS Agent information by server type or server name.
Get-RASAgent [-] <string> [- <uint>] [<>]
Get-RASAgent [[-] {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}] [- <uint>] [<>]
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.
-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.
-ServerType <> 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
<CommonParameters>
-none-
---------- 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.
Get-RASDayPlan
Retrieves information about day plan properties.
Get-RASDayPlan [[-] <uint>] - {LogonHours} [<>]
Get-RASDayPlan [[-] <string>] [[-] <uint>] - {LogonHours} [<>]
Retrieves information about day plan properties.
The cmdlet returns an object of type day plan properties.
-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>
-none-
---------- 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.
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. 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. 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>]
Adds a Rule to the Rule List within Published Items.
-Enabled <bool> Whether the new rule will be enabled or disabled.
-RuleName <string> The name of the rule to add to the Criteria.
-Description <string> Description for the new rule.
-Name <string> The name or server for which to modify the Rule settings.
-SiteId <uint> Site ID for which to modify the Rule 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 Rule settings.
-InputObject <RASListObj> An object of type ClientPolicy or PubItem for which to modify the Rule settings.
-ObjType <RuleObjType> The Object Type for which to modify the Rule settings.
Possible values: ClientPolicy, PubItem
<CommonParameters>
-none-
-none-
---------- 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.
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>]
Creates a new Schedule property.
-Name <string> Scheduler job name.
-SiteId <uint> Site ID to modify the schedule job.
-Id <uint> Scheduler job ID.
-ObjType <ScheduleObjType> Schedule object type.
Possible values: RDS, VDI, AVD
-TargetType <ScheduleTargetType> Schedule target type.
Possible values: Host, HostPool
-TargetID <uint> The target RD Session Host server or server group Ids depending on the TargetType parameter.
-PoolId <uint>
-GUID <string>
-GuestName <string>
-HostAzureID <string>
<CommonParameters>
-none-
---------- 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.
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>]
Retrieves the Criteria Device List within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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 <CriteriaObjType> The Object Type for which to retrieve the Criteria settings.
Possible values: ClientPolicy, PubItem, MFA, LogonHours
-DefObjType <CriteriaDefObjType> The Default Object Type for which to retrieve the Criteria settings.
Possible values: MFA
-RuleId <uint> The ID of the Rule to retrieve.
<CommonParameters>
-none-
---------- 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.
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? true
Position? 0
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. 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. 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. 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. 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. 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. 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? 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. 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. 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. 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? false
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. 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. 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? named
Default value
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
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value Level1
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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Required? true
Position? 0
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? false
Position? 0
Default value All
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. 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. 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? 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 This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. 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? false
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 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? 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. 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. 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>]
Adds a Remote PC Static to a Provider.
-RemotePCStaticName <string> Remote PC Static Name.
-MAC <string> Remote PC Static MAC Address.
-Subnet <string> Remote PC Static Subnet. Default: 0.0.0.0
-Server <string> The name of the target Provider server.
This must be the actual server name used in the RAS farm.
-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.
-InputObject <RemotePCStaticProvider> An object representing the Provider server to modify.
To obtain the object, use the Get-RASProvider cmdlet.
<CommonParameters>
-none-
---------- 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.
Add-RASWinDeviceGroupInboundPort [-Id] <uint> -Port <uint> -Profile {Domain | Private | Public | All} -Protocol {TCP | UDP} [<CommonParameters>]
Add-RASWinDeviceGroupInboundPort [[-InputObject] <WinDeviceGroup>] -Port <uint> -Profile {Domain | Private | Public | All} -Protocol {TCP | UDP} [<CommonParameters>]
Add-RASWinDeviceGroupInboundPort [-Name] <string> -Port <uint> -Profile {Domain | Private | Public | All} -Protocol {TCP | UDP} [-SiteId <uint>] [<CommonParameters>]
Adds the Windows device group Inbound ports.
-Port <uint> The Port to add to the windows device group.
-Protocol <Protocol> The Protocol to add to the windows device group.
Possible values: TCP, UDP
-Profile <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 <WinDeviceGroup> The Windows Device Group to modify.
<CommonParameters>
-none-
---------- 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.
Get-RASAutoUpgrade -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [-SiteId <uint>] [<CommonParameters>]
Get-RASAutoUpgrade [-Id] <uint> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [<CommonParameters>]
Get-RASAutoUpgrade [-Name] <string> [[-SiteId] <uint>] -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [<CommonParameters>]
Retrieves the Auto-upgrade settings from RDSHostPool, RDSDefaults, VDIHostPool, VDIDefaults, AVDHostPool or AVDDefaults (Single-Session/Multi-Session).
-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 <HostPoolObjType> The Object Type for which to retrieve the Auto-upgrade settings.
Possible values: RDSHostPool, VDIHostPool, AVDHostPool
-DefObjType <ServerDefObjType> The Default Object Type for which to retrieve the Auto-upgrade settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
<CommonParameters>
-none-
---------- 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.
Add-RASCriteriaDevice
Adds a Client Device to the Criteria Device List.
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>] [<>]
Adds a Client Device to the Criteria Device List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaDevice -Id 1 -ObjType LogonHours -ClientDeviceName "Device1"
Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaDevice -Name "Logon1" -ObjType LogonHours -ClientDeviceName "Device1"
Adds the Device specified by Name to the Criteria Device List within the Criteria Settings of the specified Logon Hours by Name.
Add-RASCriteriaIP
Adds an IP to the Criteria IP List.
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>] [<>]
Adds an IP to the Criteria IP List within the Criteria settings of a ClientPolicy, MFA or PubItem.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASCriteriaIP -Id 1 -ObjType MFA -IP "1.2.3.4" -IPType Version4
Adds the specified IPv4 to the Criteria IP List within the Criteria Settings of the specified MFA by ID. ---------- EXAMPLE 2 ----------
Add-RASCriteriaIP -Name "Logon1" -ObjType MFA -IP "1.2.3.4-1.2.3.5" -IPType Version4
Adds the IPv4 Range to the Criteria IP List within the Criteria Settings of the specified MFA by Name.
Add-RASMFARadiusAuto
Adds automation settings to Radius provider settings.
Add-RASMFARadiusAuto [-] <uint> - <string> - <string> [- <string>] [- <string>] [- <bool>] [- {Alert | Message | Email | Call | Chat | Flag}] [<>]
Add-RASMFARadiusAuto [-] <> - <string> - <string> [- <string>] [- <string>] [- <bool>] [- {Alert | Message | Email | Call | Chat | Flag}] [<>]
Add-RASMFARadiusAuto [-] <string> [[-] <uint>] - <string> - <string> [- <string>] [- <string>] [- <bool>] [- {Alert | Message | Email | Call | Chat | Flag}] [<>]
The cmdlet appends new attribute settings to existing ones. All parameters are mandatory.
-Command <string> RADIUS Automation command
-Enabled <bool> Whether the RADIUS Automation is enabled/disabled
-Image <> RADIUS Automation image
Possible values: Alert, Message, Email, Call, Chat, Flag
-Title <string> RADIUS Automation title
-ActionMessage <string> RADIUS Automation action message
-Description <string> RADIUS Automation description
-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>
-none-
---------- EXAMPLE 1 ----------
Add-RASMFARadiusAuto -SiteId 2 -Command Test -Title Test
Adds a new entry to the Radius automation list on Site 2. [Radius Setting]
Get-RASCriteria
Retrieves the Criteria settings.
Get-RASCriteria - {} [- <uint>] [<>]
Get-RASCriteria [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Get-RASCriteria [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Retrieves the Criteria settings from a ClientPolicy, MFA or PubItem.
-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>
-none-
---------- 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.
Get-RASCriteriaHardwareID
Retrieves the Criteria Hardware ID List.
Get-RASCriteriaHardwareID - {} [- <uint>] [<>]
Get-RASCriteriaHardwareID [-] <uint> - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Get-RASCriteriaHardwareID [-] <string> [[-] <uint>] - {ClientPolicy | PubItem | MFA | LogonHours} [- <uint>] [<>]
Retrieves the Criteria Hardware ID List within the Criteria settings from a ClientPolicy, MFA or PubItem.
-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>
-none-
---------- 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.
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 0.0.0.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? 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. 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. 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. Add-RASAutoUpgradeMessage -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Message <string> -MessageTitle <string> [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [-SiteId <uint>] [<CommonParameters>]
Add-RASAutoUpgradeMessage [-Id] <uint> -Message <string> -MessageTitle <string> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
Add-RASAutoUpgradeMessage [-InputObject] <RASSerilazableObj> -Message <string> -MessageTitle <string> [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
Add-RASAutoUpgradeMessage [-Name] <string> [[-SiteId] <uint>] -Message <string> -MessageTitle <string> -ObjType {RDSHostPool | VDIHostPool | AVDHostPool} [-Enabled <bool>] [-SendMsgSecs <uint>] [-SendMsgWhen {Before | After}] [<CommonParameters>]
Adds schedule message information within Auto-upgrade settings.
-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 <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 <RASSerilazableObj> An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the Auto-upgrade settings.
-ObjType <HostPoolObjType> The Object Type for which to modify the Auto-upgrade settings.
Possible values: RDSHostPool, VDIHostPool, AVDHostPool
-DefObjType <ServerDefObjType> The Default Object Type for which to modify the Auto-upgrade settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
<CommonParameters>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASAutoUpgradeMessage -DefObjType RDSDef -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Adds a message to the Auto-upgrade settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------
Add-RASAutoUpgradeMessage -Name "VDIHostPool1" -ObjType VDIHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Adds a message to the Auto-upgrade settings of the specified VDIHostPool by Name. ---------- EXAMPLE 3 ----------
Add-RASAutoUpgradeMessage -Id 1 -ObjType AVDHostPool -Enabled 0 -SendMsgSecs 60 -SendMsgWhen Before -MessageTitle "messageTitle" -Message "messageBody"
Adds a message to the Auto-upgrade settings of the specified AVDHostPool by Id.
Add-RASImageOptimizationRegistry -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -DisplayName <string> -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-SiteId <uint>] [-StringValue <string>] [<CommonParameters>]
Add-RASImageOptimizationRegistry [-Id] <uint> -DisplayName <string> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]
Add-RASImageOptimizationRegistry [-InputObject] <RASSerilazableObj> -DisplayName <string> -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]
Add-RASImageOptimizationRegistry [-Name] <string> [[-SiteId] <uint>] -DisplayName <string> -ObjType {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} -Path <string> [-Action {Add | Modify | Delete}] [-DWORDValue <uint>] [-HiveType {HKEY_CURRENT_CONFIG | HKEY_USERS | HKEY_LOCAL_MACHINE | HKEY_CLASSES_ROOT}] [-RegistryName <string>] [-RegType {REG_SZ | REG_DWORD | REG_QWORD | REG_MULTI_SZ | REG_EXPAND_SZ}] [-StringValue <string>] [<CommonParameters>]
Adds Registry to the following list.
-Action <ActionType>
Possible values: Add, Modify, Delete
-RegistryName <string>
-DWORDValue <uint>
-DisplayName <string>
-HiveType <HiveType>
Possible values: HKEY_CURRENT_CONFIG, HKEY_USERS, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT
-Path <string>
-RegType <ValueType>
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 <RASSerilazableObj> An object of type RDS, VDITemplate or VDIDesktop for which to modify the Image Optimization settings.
-ObjType <OptimizationServerObjType> The Object Type for which to modify the Image Optimization settings.
Possible values: RDSHost, RDS, VDIHostPool, AVDHostPool, RDSTemplate, VDITemplate, AVDTemplate
-DefObjType <ServerDefObjType> The Default Object Type for which to modify the Image Optimization settings.
Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef
<CommonParameters>
-none-
-none-
---------- 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'.
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. 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. Required? true
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? false
Position? named
Default value Alert
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? 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. 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. 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. 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. 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. Add-RASFSLogixCCDLocation
Adds a CCDLocation to a CCDLocation List of the Profile Container.
Add-RASFSLogixCCDLocation - <string> - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> [- <uint>] [<>]
Add-RASFSLogixCCDLocation - <string> - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> [- <uint>] [<>]
Add-RASFSLogixCCDLocation - <string> - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} - <SwitchParameter> [- <uint>] [<>]
Add-RASFSLogixCCDLocation [-] <uint> - <string> - <SwitchParameter> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<>]
Add-RASFSLogixCCDLocation [-] <uint> - <string> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <uint> - <string> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <> - <string> - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <> - <string> - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <> - <string> - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <string> [[-] <uint>] - <string> - <SwitchParameter> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [<>]
Add-RASFSLogixCCDLocation [-] <string> [[-] <uint>] - <string> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> [<>]
Add-RASFSLogixCCDLocation [-] <string> [[-] <uint>] - <string> - {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} - <SwitchParameter> [<>]
Adds a CCDLocation to a CCDLocation List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults
-CCDLocation <string> Specifies the 'CCDLocation' path to add to the CCDLocation List.
-Name <string> The name or server for which to modify the FSLogix settings.
-SiteId <uint> Site ID from which to modify the FSLogix settings.
If the parameter is omitted, the Licensing Server site ID will be used.
-Id <uint> The ID of a server for which to modify the FSLogix settings.
-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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASFSLogixCCDLocation -DefObjType RDSDef -ContainerType Profile -CCDLocation "type=smb,connectionString=Location1"
Adds a CCDLocation to the CCDLocation List of the Profile Container within the FSLogix Settings of the RDS Default Settings.
Add-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>]
Adds a VHDLocation to a VHDLocation List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults
-VHDLocation <string> Specifies the 'VHDLocation' path to add to the VHDLocation 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 <RASSerilazableObj> An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.
-ObjType <FSLogixServerObjType> The Object Type for which to modify the FSLogix settings.
Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool
-DefObjType <ServerDefObjType> 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>
-none-
-none-
---------- EXAMPLE 1 ----------
Add-RASFSLogixVHDLocation -DefObjType RDSDef -ContainerType Profile -VHDLocation "type=smb,connectionString=Location1"
Adds a VHDLocation to the VHDLocation List of the Profile Container within the FSLogix Settings of the RDS Default Settings.
Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>]
Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>]
Add-RASFSLogixFolder -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -Folder <string> -FolderListType {Inclusion | Exclusion} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [-SiteId <uint>] [<CommonParameters>]
Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-Id] <uint> -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-InputObject] <RASSerilazableObj> -Folder <string> -FolderListType {Inclusion | Exclusion} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Add-RASFSLogixFolder [-Name] <string> [[-SiteId] <uint>] -Folder <string> -FolderListType {Inclusion | Exclusion} -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer <SwitchParameter> [-ExcludeFolderCopy {None | CopyBase | CopyBack}] [<CommonParameters>]
Adds a folder to an Inclusion/Exclusion List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults.
-ExcludeFolderCopy <ExcludeFolderCopy> Specifies the 'Exclude Folder Copy', in case of adding to the Exclude Folder List.
Possible values: None, CopyBase, CopyBack
-FolderListType <FSLogixListType> 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 <RASSerilazableObj> An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.
-ObjType <FSLogixServerObjType> The Object Type for which to modify the FSLogix settings.
Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool
-DefObjType <ServerDefObjType> 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>
-none-
-none-
---------- 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.
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 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. 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 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. 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. Add-RASFSLogixUser
Adds a user to an Inclusion/Exclusion List of the Profile Container.
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>] [<>]
Adds a user to an Inclusion/Exclusion List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults
-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>
-none-
-none-
---------- 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.
Add-RASVDIHostPoolMember
Adds one or multiple VDI Host Pool Members to a VDI Host Pool.
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>] [<>]
Adds one or multiple VDI Host Pool Members to an existing VDI Host Pool.
-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>
-none-
---------- 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.
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. 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. Add-RASImageOptimizationWindowsComponent
Adds Windows Custom Component.
Add-RASImageOptimizationWindowsComponent - {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} [- <string>] [- <string>] [- <string>] [- <uint>] [<>]
Add-RASImageOptimizationWindowsComponent [-] <uint> - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [- <string>] [- <string>] [- <string>] [<>]
Add-RASImageOptimizationWindowsComponent [-] <> [- <string>] [- <string>] [- <string>] [<>]
Add-RASImageOptimizationWindowsComponent [-] <string> [[-] <uint>] - {RDSHost | RDS | VDIHostPool | AVDHostPool | RDSTemplate | VDITemplate | AVDTemplate} [- <string>] [- <string>] [- <string>] [<>]
Adds Windows Component to the following list.
-Aliases <string>
-DisplayName <string>
-ComponentName <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>
-none-
-none-
---------- 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.
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? 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.