Set-RASTheme
NAME
Set-RASTheme
SYNOPSIS
Modifies settings of a theme.
SYNTAX
Set-RASTheme [Id] (uint)** [AllowAppsInNewTab (bool)] [AllowCEPOptIn (bool)] [AllowCookieConsent (bool)] [AllowCORS (bool)] [-AllowedDomainsForCORS (List`1)] [AllowEmbed (bool)] [AllowEULA (bool)] [AllowLaunchMethod (bool)] [AllowTunneling (bool)] [ApplicationIconFile (string)] [ApplicationName (string)] [BrowserCacheTimeInMonths (uint)] [ButtonsBackgroundColor (uint)] [ButtonsTextColor (uint)] [ClientDetectionTimeout (uint)] [ClientIPPDetectionServiceURL (string)] [ClientPublicIPCustomURL (string)] [-ClientPublicIPDetectMode {Disabled | Parallels | Custom}] [-ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [Command (string)] [CompanyLogoFile (string)] [CompanyName (string)] [ConnectionBannerFile (string)] [-CustomWorkAreaImageFit {Fill | Tile | Center | Fit}] [CustomWorkAreaImageId (uint)] [-CustomWorkAreaImageType {URL | File}] [CustomWorkAreaImageURL (string)] [Description (string)] [-DetectClientMode {Automatic | Manual}] [Domain (string)] [Enabled (bool)] [FaviconIconFile (string)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [GroupEnabled (bool)] [HeaderBackgroundColor (uint)] [-HeaderOptions {Blurred | SolidColor}] [-LanguageBar_de_DE (bool)] [-LanguageBar_Default {Default | English | German | Japanese | French | Spanish | Italian | Portuguese | ChineseSimplified | ChineseTraditional | Korean | Dutch}] [-LanguageBar_en_US (bool)] [-LanguageBar_es_ES (bool)] [-LanguageBar_fr_FR (bool)] [-LanguageBar_it_IT (bool)] [-LanguageBar_ja_JP (bool)] [-LanguageBar_ko_KR (bool)] [-LanguageBar_nl_NL (bool)] [-LanguageBar_pt_BR (bool)] [-LanguageBar_zh_CN (bool)] [-LanguageBar_zh_TW (bool)] [-LaunchMethod {Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5 | Launch_Applications_with_Parallels_Client_Fallback_to_WebClient | Launch_Applications_with_Parallels_Client | Launch_Applications_with_Browser_HTML5 | Launch_Applications_with_WebClient}] [-LoginHint_de_DE (string)] [-LoginHint_en_US (string)] [-LoginHint_es_ES (string)] [-LoginHint_fr_FR (string)] [-LoginHint_it_IT (string)] [-LoginHint_ja_JP (string)] [-LoginHint_ko_KR (string)] [-LoginHint_nl_NL (string)] [-LoginHint_pt_BR (string)] [-LoginHint_zh_CN (string)] [-LoginHint_zh_TW (string)] [LoginPageURLPath (string)] [LoginTo (string)] [MenuItem (string)] [MFAId (uint)] [NewName (string)] [OverrideAuthenticationDomain (bool)] [OverrideGatewaySettings (bool)] [OverridePostLogonMessage (bool)] [OverrideWindowsClientDownloadURL (string)] [-PasswordHint_de_DE (string)] [-PasswordHint_en_US (string)] [-PasswordHint_es_ES (string)] [-PasswordHint_fr_FR (string)] [-PasswordHint_it_IT (string)] [-PasswordHint_ja_JP (string)] [-PasswordHint_ko_KR (string)] [-PasswordHint_nl_NL (string)] [-PasswordHint_pt_BR (string)] [-PasswordHint_zh_CN (string)] [-PasswordHint_zh_TW (string)] [PostLogonMessage (string)] [Pre2000Cred (bool)] [PreLogonMessage (string)] [ProgressBarColor (uint)] [ShowDownloadURL (bool)] [UseClientIPDetectionService (bool)] [UserPortalPostLogonMessage (string)] [WebpageTitle (string)] [WindowsClientOverridePostLogonMessage (bool)] [WindowsClientPostLogonMessage (string)] [WorkAreaBackgroundColor (uint)] [-WorkAreaImage {SolidColor | Image1 | Image2 | Image3 | Image4 | Image5 | Custom}] [WorkAreaTextColor (uint)] [(CommonParameters)]
Set-RASTheme [Name] (string)** [[-SiteId] (uint)] [AllowAppsInNewTab (bool)] [AllowCEPOptIn (bool)] [AllowCookieConsent (bool)] [AllowCORS (bool)] [-AllowedDomainsForCORS (List`1)] [AllowEmbed (bool)] [AllowEULA (bool)] [AllowLaunchMethod (bool)] [AllowTunneling (bool)] [ApplicationIconFile (string)] [ApplicationName (string)] [BrowserCacheTimeInMonths (uint)] [ButtonsBackgroundColor (uint)] [ButtonsTextColor (uint)] [ClientDetectionTimeout (uint)] [ClientIPPDetectionServiceURL (string)] [ClientPublicIPCustomURL (string)] [-ClientPublicIPDetectMode {Disabled | Parallels | Custom}] [-ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [Command (string)] [CompanyLogoFile (string)] [CompanyName (string)] [ConnectionBannerFile (string)] [-CustomWorkAreaImageFit {Fill | Tile | Center | Fit}] [CustomWorkAreaImageId (uint)] [-CustomWorkAreaImageType {URL | File}] [CustomWorkAreaImageURL (string)] [Description (string)] [-DetectClientMode {Automatic | Manual}] [Domain (string)] [Enabled (bool)] [FaviconIconFile (string)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [GroupEnabled (bool)] [HeaderBackgroundColor (uint)] [-HeaderOptions {Blurred | SolidColor}] [-LanguageBar_de_DE (bool)] [-LanguageBar_Default {Default | English | German | Japanese | French | Spanish | Italian | Portuguese | ChineseSimplified | ChineseTraditional | Korean | Dutch}] [-LanguageBar_en_US (bool)] [-LanguageBar_es_ES (bool)] [-LanguageBar_fr_FR (bool)] [-LanguageBar_it_IT (bool)] [-LanguageBar_ja_JP (bool)] [-LanguageBar_ko_KR (bool)] [-LanguageBar_nl_NL (bool)] [-LanguageBar_pt_BR (bool)] [-LanguageBar_zh_CN (bool)] [-LanguageBar_zh_TW (bool)] [-LaunchMethod {Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5 | Launch_Applications_with_Parallels_Client_Fallback_to_WebClient | Launch_Applications_with_Parallels_Client | Launch_Applications_with_Browser_HTML5 | Launch_Applications_with_WebClient}] [-LoginHint_de_DE (string)] [-LoginHint_en_US (string)] [-LoginHint_es_ES (string)] [-LoginHint_fr_FR (string)] [-LoginHint_it_IT (string)] [-LoginHint_ja_JP (string)] [-LoginHint_ko_KR (string)] [-LoginHint_nl_NL (string)] [-LoginHint_pt_BR (string)] [-LoginHint_zh_CN (string)] [-LoginHint_zh_TW (string)] [LoginPageURLPath (string)] [LoginTo (string)] [MenuItem (string)] [MFAId (uint)] [NewName (string)] [OverrideAuthenticationDomain (bool)] [OverrideGatewaySettings (bool)] [OverridePostLogonMessage (bool)] [OverrideWindowsClientDownloadURL (string)] [-PasswordHint_de_DE (string)] [-PasswordHint_en_US (string)] [-PasswordHint_es_ES (string)] [-PasswordHint_fr_FR (string)] [-PasswordHint_it_IT (string)] [-PasswordHint_ja_JP (string)] [-PasswordHint_ko_KR (string)] [-PasswordHint_nl_NL (string)] [-PasswordHint_pt_BR (string)] [-PasswordHint_zh_CN (string)] [-PasswordHint_zh_TW (string)] [PostLogonMessage (string)] [Pre2000Cred (bool)] [PreLogonMessage (string)] [ProgressBarColor (uint)] [ShowDownloadURL (bool)] [UseClientIPDetectionService (bool)] [UserPortalPostLogonMessage (string)] [WebpageTitle (string)] [WindowsClientOverridePostLogonMessage (bool)] [WindowsClientPostLogonMessage (string)] [WorkAreaBackgroundColor (uint)] [-WorkAreaImage {SolidColor | Image1 | Image2 | Image3 | Image4 | Image5 | Custom}] [WorkAreaTextColor (uint)] [(CommonParameters)]
DESCRIPTION
Modifies settings of a theme.
PARAMETERS
NewName (string)
General: The new name of the specified Theme
Description (string)
General: Description of the Theme
Enabled (bool)
General: Whether Theme is enabled or not
MFAId (uint)
General: The MFA Provider Id. One can set MFAId as 0 to unassign MFA from a theme.
OverrideAuthenticationDomain (bool)
General: Whether to override the authentication domain
Domain (string)
General: The domain used
GroupEnabled (bool)
General: Whether to limit Themes to a certain group
PostLogonMessage (string)
Messages: The post-logon message
LoginPageURLPath (string)
User Portal - URLs: The Theme login page URL Path following protocol and domain such as 'https://FQDN/path'.
ShowDownloadURL (bool)
User Portal - URLs: Whether to show the download URL
OverrideWindowsClientDownloadURL (string)
User Portal - URLs: The Override download URL for branded Parallels Client (Windows)
WebpageTitle (string)
User Portal - Branding: The Webpage Title
LoginTo (string)
User Portal - Branding: Change the Login To message in the User Portal login screen.
The message can consist of any text and may include RAS variables: %FARM%, %SITE% or %THEME%.
CompanyLogoFile (string)
User Portal - Branding: The Company Logo File path
Suggested resolution: 225 x 50 pixels
If empty, the Company Logo is reset to default.
FaviconIconFile (string)
User Portal - Branding: The Favicon Image File path
If empty, the Favicon Icon is reset to default.
HeaderOptions (HeaderOptions)
User Portal - Colors: The header options.
Possible values: Blurred, SolidColor
WorkAreaImage (WorkAreaImage)
User Portal - Colors: The work area image.
Possible values: SolidColor, Image1, Image2, Image3, Image4, Image5, Custom
CustomWorkAreaImageType
(CustomWorkAreaImageType) User Portal - Colors: The custom work area image type.
Possible values: URL, File
CustomWorkAreaImageURL (string)
User Portal - Colors: The custom work area image URL.
CustomWorkAreaImageId (uint)
User Portal - Colors: The custom work area image Id.
CustomWorkAreaImageFit
(CustomWorkAreaImageFit) User Portal - Colors: The custom work area image fit.
Possible values: Fill, Tile, Center, Fit
HeaderBackgroundColor (uint)
User Portal - Colors: The header background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
WorkAreaBackgroundColor (uint)
User Portal - Colors: The work area background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
WorkAreaTextColor (uint)
User Portal - Colors: The work area text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
ButtonsBackgroundColor (uint)
User Portal - Colors: The buttons background and link color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
ButtonsTextColor (uint)
User Portal - Colors: The buttons text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
LanguageBar_Default
(LanguageType) User Portal - Language bar: The Default Language Bar Type
Possible values: Default, English, German, Japanese, French, Spanish, Italian, Portuguese, ChineseSimplified, ChineseTraditional, Korean, Dutch
LanguageBar_de_DE (bool)
User Portal - Language bar: Whether to enable the German Language Bar or not
LanguageBar_en_US (bool)
User Portal - Language bar: Whether to enable the English (US) Language Bar or not
LanguageBar_es_ES (bool)
User Portal - Language bar: Whether to enable the Spanish Language Bar or not
LanguageBar_fr_FR (bool)
User Portal - Language bar: Whether to enable the French Language Bar or not
LanguageBar_it_IT (bool)
User Portal - Language bar: Whether to enable the Italian Language Bar or not
LanguageBar_ja_JP (bool)
User Portal - Language bar: Whether to enable the Japanese Language Bar or not
LanguageBar_ko_KR (bool)
User Portal - Language bar: Whether to enable the Korean Language Bar or not
LanguageBar_nl_NL (bool)
User Portal - Language bar: Whether to enable the Dutch Language Bar or not
LanguageBar_pt_BR (bool)
User Portal - Language bar: Whether to enable the Portuguese Language Bar or not
LanguageBar_zh_CN (bool)
User Portal - Language bar: Whether to enable the Chinese Simplified Language Bar or not
LanguageBar_zh_TW (bool)
User Portal - Language bar: Whether to enable the Chinese Traditional Language Bar or not
PreLogonMessage (string)
User Portal - Messages: The Pre-Logon message
UserPortalPostLogonMessage (string)
User Portal - Messages: The Post-Logon message
OverridePostLogonMessage (bool)
User Portal - Messages: Whether to override the post-logon message
LoginHint_de_DE (string)
User Portal - Input prompt: The User Prompt: German
PasswordHint_de_DE (string)
User Portal - Input prompt: The Password Prompt: German
LoginHint_en_US (string)
User Portal - Input prompt: The User Prompt: English (US)
PasswordHint_en_US (string)
User Portal - Input prompt: The Password Prompt: English (US)
LoginHint_es_ES (string)
User Portal - Input prompt: The User Prompt: Spanish
PasswordHint_es_ES (string)
User Portal - Input prompt: The Password Prompt: Spanish
LoginHint_fr_FR (string)
User Portal - Input prompt: The User Prompt: French
PasswordHint_fr_FR (string)
User Portal - Input prompt: The Password Prompt: French
LoginHint_it_IT (string)
User Portal - Input prompt: The User Prompt: Italian
PasswordHint_it_IT (string)
User Portal - Input prompt: The Password Prompt: Italian
LoginHint_ja_JP (string)
User Portal - Input prompt: The User Prompt: Japanese
PasswordHint_ja_JP (string)
User Portal - Input prompt: The Password Prompt: Japanese
LoginHint_ko_KR (string)
User Portal - Input prompt: The User Prompt: Korean
PasswordHint_ko_KR (string)
User Portal - Input prompt: The Password Prompt: Korean
LoginHint_nl_NL (string)
User Portal - Input prompt: The User Prompt: Dutch
PasswordHint_nl_NL (string)
User Portal - Input prompt: The Password Prompt: Dutch
LoginHint_pt_BR (string)
User Portal - Input prompt: The User Prompt: Portuguese
PasswordHint_pt_BR (string)
User Portal - Input prompt: The Password Prompt: Portuguese
LoginHint_zh_CN (string)
User Portal - Input prompt: The User Prompt: Chinese Simplified
PasswordHint_zh_CN (string)
User Portal - Input prompt: The Password Prompt: Chinese Simplified
LoginHint_zh_TW (string)
User Portal - Input prompt: The User Prompt: Chinese Traditional
PasswordHint_zh_TW (string)
User Portal - Input prompt: The Password Prompt: Chinese Traditional
OverrideGatewaySettings (bool)
User Portal - Gateway: Whether to override the gateway settings for the Theme
LaunchMethod (LaunchSession)
User Portal - Gateway: The Launch session method
Possible values: Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5, Launch_Applications_with_Parallels_Client_Fallback_to_WebClient, Launch_Applications_with_Parallels_Client, Launch_Applications_with_Browser_HTML5, Launch_Applications_with_WebClient
AllowLaunchMethod (bool)
User Portal - Gateway: Whether to allow the user to launch session using a particular method
AllowAppsInNewTab (bool)
User Portal - Gateway: Whether to allow applications in a new tab
Pre2000Cred (bool)
User Portal - Gateway: Whether to use the pre windows 2000 format
AllowEmbed (bool)
User Portal - Gateway: Whether to allow embed
FileTransferMode
(FileTransferControlMode) User Portal - Gateway: Specifies if File Transfer option is allowed and if yes, which directions are allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
ClipboardDirection
(ClipboardDirections) User Portal - Gateway: Specifies if Clipboard Direction option is allowed and if yes, which directions are allowed.
Possible values: None, ClientToServer, ServerToClient, Bidirectional
AllowCORS (bool)
User Portal - Gateway: Whether to allow cross-origin resource sharing
AllowedDomainsForCORS (List`1)
User Portal - Gateway: Allowed domains for cross-origin resource sharing.
BrowserCacheTimeInMonths (uint)
User Portal - Gateway: How long should the browser preserve the cache (in months).
UseClientIPDetectionService (bool)
Use Client Private IP detection service.
ClientIPPDetectionServiceURL (string)
Client Private IP detection service URL.
DetectClientMode
(DetectClientMode) Detection mode.
Automatically on sign in
Manually on user prompt (Default)
Possible values: Automatic, Manual
ClientDetectionTimeout (uint)
Client detection timeout in seconds.
AllowCookieConsent (bool)
User Portal - Legal policies: Whether to allow cookies or not
AllowEULA (bool)
User Portal - Legal policies: Whether to allow EULA
AllowCEPOptIn (bool)
User Portal - Legal policies: Whether to allow CEP opt-in or not
CompanyName (string)
Windows client - Branding: The Company Name
ApplicationName (string)
Windows client - Branding: The Application Name
ConnectionBannerFile (string)
Windows client - Branding: The Connection Banner File path
Suggested resolution: 479 x 75 pixels
If empty, the Connection Banner is reset to default.
ProgressBarColor (uint)
Windows client - Branding: The progress bar color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
ApplicationIconFile (string)
Windows client - Branding: The Application Icon File path
If empty, the Application Icon is reset to default.
WindowsClientOverridePostLogonMessage (bool)
Windows client - Messages: Whether to allow the override post-logon message
WindowsClientPostLogonMessage (string)
Windows client - Messages: The post-logon message
MenuItem (string)
Windows client - Custom menu: The Menu Item
Command (string)
Windows client - Custom menu: The Command
AllowTunneling (bool)
Access: If tunneling should be enabled on theme
ClientPublicIPDetectMode
(ClientPublicIPDetectMode) The Client Public IP Detect Mode
Possible values: Disabled, Parallels, Custom
ClientPublicIPCustomURL (string)
The Client Public IP Custom URL
Name (string)
Name of the Theme policy to modify.
This must be the actual Theme policy name used in the RAS farm.
SiteId (uint)
The site ID to which to add the specified server.
If the parameter is omitted, the Licensing Server site ID will be used.
Id (uint)
The ID of the Theme policy to modify. To obtain the ID, use the Get-RASTheme cmdlet.
(CommonParameters)
INPUTS
-none-
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASTheme -Name NewTheme -NewName EditedTheme
Changes the name of the theme from NewTheme to EditedTheme.
RELATED LINKS
Last updated