Parallels RAS PowerShell API
  • Parallels RAS PowerShell
  • Getting Started
  • Parallels RAS Powershell Admin Module
    • Commands
      • Add-RASAppPackageAssigned
      • Add-RASAutoUpgradeMessage
      • Add-RASAVDHostPoolAssignment
      • Add-RASClientPolicyConnection
      • Add-RASCriteriaDevice
      • Add-RASCriteriaGatewayIP
      • Add-RASCriteriaHardwareID
      • Add-RASCriteriaIP
      • Add-RASCriteriaSecurityPrincipal
      • Add-RASCriteriaTheme
      • Add-RASExcludeADGroup
      • Add-RASFSLogixCCDLocation
      • Add-RASFSLogixFolder
      • Add-RASFSLogixUser
      • Add-RASFSLogixVHDLocation
      • Add-RASHALBDevice
      • Add-RASImageOptimizationRegistry
      • Add-RASImageOptimizationWindowsComponent
      • Add-RASImageOptimizationWindowsScheduledTask
      • Add-RASImageOptimizationWindowsService
      • Add-RASMFARadiusAttr
      • Add-RASMFARadiusAuto
      • Add-RASMFAUsers
      • Add-RASPrintingAutoInstallFont
      • Add-RASProviderAdminCredentials
      • Add-RASProviderRemotePCStatic
      • Add-RASPubAppFileExt
      • Add-RASPubItemPreferredRoute
      • Add-RASPubRDSAppServerAttr
      • Add-RASRule
      • Add-RASScheduleMessage
      • Add-RASScheduleTarget
      • Add-RASTemplateLicenseKey
      • Add-RASThemeCustomImage
      • Add-RASThemeFooterURL
      • Add-RASThemeGroupFilter
      • Add-RASURLRedirectionEntry
      • Add-RASVDIHostPoolMember
      • Add-RASWinDeviceGroupInboundPort
      • Copy-RASPubItem
      • Find-RASMFAUsers
      • Get-RASADIntegrationSettings
      • Get-RASAdminAccount
      • Get-RASAdminSession
      • Get-RASAgent
      • Get-RASAgentDiagnostic
      • Get-RASAllowedDevicesSetting
      • Get-RASAppPackage
      • Get-RASAppPackageAssigned
      • Get-RASAppPackageAvailVersions
      • Get-RASAppPackageSettings
      • Get-RASAuthSettings
      • Get-RASAutoUpgrade
      • Get-RASAutoUpgradeMessage
      • Get-RASAVDCustomHost
      • Get-RASAVDDefaultSettings
      • Get-RASAVDGallery
      • Get-RASAVDGalleryImage
      • Get-RASAVDHost
      • Get-RASAVDHostPool
      • Get-RASAVDHostPoolAssignment
      • Get-RASAVDHostPoolStatus
      • Get-RASAVDHostStatus
      • Get-RASAVDLocation
      • Get-RASAVDOffer
      • Get-RASAVDPredefinedImages
      • Get-RASAVDPublisher
      • Get-RASAVDResourceGroup
      • Get-RASAVDSettings
      • Get-RASAVDSKU
      • Get-RASAVDVersion
      • Get-RASAVDVirtualNetwork
      • Get-RASAVDVMSize
      • Get-RASAVDWorkspace
      • Get-RASAVDWorkspaceStatus
      • Get-RASBroker
      • Get-RASBrokerAutoPromotionSettings
      • Get-RASBrokerStatus
      • Get-RASCertificate
      • Get-RASClientPolicy
      • Get-RASClientPolicyAssignment
      • Get-RASClientPolicyConnection
      • Get-RASClientSettings
      • Get-RASCPUOptimizationSettings
      • Get-RASCriteria
      • Get-RASCriteriaDevice
      • Get-RASCriteriaGatewayIP
      • Get-RASCriteriaHardwareID
      • Get-RASCriteriaIP
      • Get-RASCriteriaOS
      • Get-RASCriteriaSecurityPrincipal
      • Get-RASCriteriaTheme
      • Get-RASCurrentAdminPermissions
      • Get-RASCustomPermission
      • Get-RASCustomRoute
      • Get-RASDayPlan
      • Get-RASEnrollmentServer
      • Get-RASEnrollmentServerStatus
      • Get-RASExcludeADGroup
      • Get-RASFarmSettings
      • Get-RASFSLogix
      • Get-RASFSLogixCCDLocation
      • Get-RASFSLogixFolder
      • Get-RASFSLogixSettings
      • Get-RASFSLogixUser
      • Get-RASFSLogixVHDLocation
      • Get-RASGateway
      • Get-RASGatewayDefaultSettings
      • Get-RASGatewayStatus
      • Get-RASHALB
      • Get-RASHALBDevice
      • Get-RASHALBStatus
      • Get-RASHelpdeskEmailSettings
      • Get-RASImageOptimization
      • Get-RASImageOptimizationPredefined
      • Get-RASImageOptimizationRegistry
      • Get-RASImageOptimizationWindowsComponent
      • Get-RASImageOptimizationWindowsScheduledTask
      • Get-RASImageOptimizationWindowsService
      • Get-RASInvitationEmailSettings
      • Get-RASJoinedBrokerStatus
      • Get-RASLBSettings
      • Get-RASLetsEncryptEULA
      • Get-RASLetsEncryptSettings
      • Get-RASLicenseDetails
      • Get-RASLogonHours
      • Get-RASMailboxSettings
      • Get-RASMFA
      • Get-RASMFACriteria
      • Get-RASMFADefaultSettings
      • Get-RASMFARadiusAttr
      • Get-RASMFARadiusAuto
      • Get-RASMSIXImageDetails
      • Get-RASNotification
      • Get-RASNotificationEvent
      • Get-RASNotificationResource
      • Get-RASNotificationScript
      • Get-RASOverwriteSupportActions
      • Get-RASPerformanceMonitorSettings
      • Get-RASPowerPermission
      • Get-RASPrintingAutoInstallFont
      • Get-RASPrintingSettings
      • Get-RASProvider
      • Get-RASProviderAdminCredentials
      • Get-RASProviderRemotePCStatic
      • Get-RASProviderStatus
      • Get-RASProxySettings
      • Get-RASPubAppFileExt
      • Get-RASPubAVDApp
      • Get-RASPubAVDDesktop
      • Get-RASPubDefaultSettings
      • Get-RASPubFolder
      • Get-RASPubItem
      • Get-RASPubItemFilter
      • Get-RASPubItemIcon
      • Get-RASPubItemPreferredRoute
      • Get-RASPubItemStatus
      • Get-RASPubRDSApp
      • Get-RASPubRDSAppServerAttr
      • Get-RASPubRDSDesktop
      • Get-RASPubVDIApp
      • Get-RASPubVDIDesktop
      • Get-RASRDSDefaultSettings
      • Get-RASRDSession
      • Get-RASRDSHost
      • Get-RASRDSHostPool
      • Get-RASRDSHostPoolMember
      • Get-RASRDSHostPoolStatus
      • Get-RASRDSHostStatus
      • Get-RASReportingSettings
      • Get-RASRule
      • Get-RASSAMLIDP
      • Get-RASScanningSettings
      • Get-RASSchedule
      • Get-RASScheduleMessage
      • Get-RASScheduleTarget
      • Get-RASSessionSetting
      • Get-RASSite
      • Get-RASSiteStatus
      • Get-RASSystemSettings
      • Get-RASTemplate
      • Get-RASTemplateLicenseKey
      • Get-RASTemplateStatus
      • Get-RASTemplateVersion
      • Get-RASTemplateVersionStatus
      • Get-RASTenant
      • Get-RASTenantBrokerSettings
      • Get-RASTheme
      • Get-RASThemeCustomImage
      • Get-RASThemeFooterURL
      • Get-RASThemeGroupFilter
      • Get-RASThemeImage
      • Get-RASTrustedDomain
      • Get-RASURLRedirectionEntry
      • Get-RASURLRedirectionSettings
      • Get-RASVDIDefaultSettings
      • Get-RASVDIHost
      • Get-RASVDIHostPool
      • Get-RASVDIHostPoolMember
      • Get-RASVDIHostPoolStatus
      • Get-RASVDIHostStatus
      • Get-RASVDIPersistentHost
      • Get-RASVersion
      • Get-RASVM
      • Get-RASWinDeviceGroup
      • Get-RASWinDeviceGroupInboundPort
      • Parallels RAS PowerShell
      • Invoke-RASADIntegrationSettings
      • Invoke-RASAdminSessionCmd
      • Invoke-RASApply
      • Invoke-RASAppPackageAssigned
      • Invoke-RASAVDHost
      • Invoke-RASBrokerPromoteToPrimary
      • Invoke-RASCertificateCmd
      • Invoke-RASCheckForUpdate
      • Invoke-RASClearAgentLogs
      • Invoke-RASClearSessionsIDCache
      • Invoke-RASClientPolicy
      • Invoke-RASExportCertificate
      • Invoke-RASExportSettings
      • Invoke-RASHostPool
      • Invoke-RASImportProviderRemotePCStatic
      • Invoke-RASImportSettings
      • Invoke-RASLicenseActivate
      • Invoke-RASLicenseDeactivate
      • Invoke-RASMFA
      • Invoke-RASPerformanceMonitor
      • Invoke-RASProviderCheckCredentials
      • Invoke-RASPubItemCmd
      • Invoke-RASRDSHostCmd
      • Invoke-RASRDSHostPoolCmd
      • Invoke-RASRDSHostProcessCmd
      • Invoke-RASRDSHostSessionCmd
      • Invoke-RASRepair
      • Invoke-RASRetrieveAgentLogs
      • Invoke-RASRetryLastAction
      • Invoke-RASSAMLIDP
      • Invoke-RASSitePromoteToLicensing
      • Invoke-RASStopOptimization
      • Invoke-RASTemplate
      • Invoke-RASTenant
      • Invoke-RASTenantBroker
      • Invoke-RASTenantBrokerSettings
      • Invoke-RASTestDetectClientIP
      • Invoke-RASVDIHost
      • Invoke-RASVDIProcessCmd
      • Invoke-RASVDISessionCmd
      • Move-RASPubItem
      • Move-RASRDSHostPoolMember
      • New-RASAdminAccount
      • New-RASAppPackage
      • New-RASAVDHost
      • New-RASAVDHostPool
      • New-RASAVDResourceGroup
      • New-RASAVDWorkspace
      • New-RASBroker
      • New-RASCertificate
      • New-RASClientPolicy
      • New-RASCustomRoute
      • New-RASEnrollmentServer
      • New-RASFarm
      • New-RASGateway
      • New-RASHALB
      • New-RASLogonHours
      • New-RASMFA
      • New-RASNotificationEvent
      • New-RASNotificationResource
      • New-RASNotificationScript
      • New-RASProvider
      • New-RASPubAVDApp
      • New-RASPubAVDDesktop
      • New-RASPubFolder
      • New-RASPubRDSApp
      • New-RASPubRDSDesktop
      • New-RASPubVDIApp
      • New-RASPubVDIDesktop
      • New-RASRDSHost
      • New-RASRDSHostPool
      • New-RASSAMLIDP
      • New-RASSchedule
      • New-RASSession
      • New-RASSite
      • New-RASTemplate
      • New-RASTenant
      • New-RASTheme
      • New-RASVDIHostPool
      • New-RASWinDeviceGroup
      • Remove-RASAdminAccount
      • Remove-RASAgent
      • Remove-RASAppPackage
      • Remove-RASAppPackageAssigned
      • Remove-RASAutoUpgradeMessage
      • Remove-RASAVDHost
      • Remove-RASAVDHostPool
      • Remove-RASAVDHostPoolAssignment
      • Remove-RASAVDWorkspace
      • Remove-RASBroker
      • Remove-RASCertificate
      • Remove-RASClientPolicy
      • Remove-RASClientPolicyConnection
      • Remove-RASCriteriaDevice
      • Remove-RASCriteriaGatewayIP
      • Remove-RASCriteriaHardwareID
      • Remove-RASCriteriaIP
      • Remove-RASCriteriaSecurityPrincipal
      • Remove-RASCriteriaTheme
      • Remove-RASCustomRoute
      • Remove-RASEnrollmentServer
      • Remove-RASExcludeADGroup
      • Remove-RASFarm
      • Remove-RASFSLogixCCDLocation
      • Remove-RASFSLogixFolder
      • Remove-RASFSLogixUser
      • Remove-RASFSLogixVHDLocation
      • Remove-RASGateway
      • Remove-RASHALB
      • Remove-RASHALBDevice
      • Remove-RASImageOptimizationRegistry
      • Remove-RASImageOptimizationWindowsComponent
      • Remove-RASImageOptimizationWindowsScheduledTask
      • Remove-RASImageOptimizationWindowsService
      • Remove-RASLogonHours
      • Remove-RASMFA
      • Remove-RASMFARadiusAttr
      • Remove-RASMFARadiusAuto
      • Remove-RASNotification
      • Remove-RASNotificationEvent
      • Remove-RASNotificationResource
      • Remove-RASNotificationScript
      • Remove-RASPrintingAutoInstallFont
      • Remove-RASProvider
      • Remove-RASProviderAdminCredentials
      • Remove-RASProviderRemotePCStatic
      • Remove-RASPubAppFileExt
      • Remove-RASPubAVDApp
      • Remove-RASPubAVDDesktop
      • Remove-RASPubFolder
      • Remove-RASPubItem
      • Remove-RASPubItemPreferredRoute
      • Remove-RASPubRDSApp
      • Remove-RASPubRDSAppServerAttr
      • Remove-RASPubRDSDesktop
      • Remove-RASPubVDIApp
      • Remove-RASPubVDIDesktop
      • Remove-RASRDSHost
      • Remove-RASRDSHostPool
      • Remove-RASRule
      • Remove-RASSAMLIDP
      • Remove-RASSchedule
      • Remove-RASScheduleMessage
      • Remove-RASScheduleTarget
      • Remove-RASSession
      • Remove-RASSite
      • Remove-RASTemplate
      • Remove-RASTemplateLicenseKey
      • Remove-RASTemplateVersion
      • Remove-RASTenant
      • Remove-RASTheme
      • Remove-RASThemeCustomImage
      • Remove-RASThemeFooterURL
      • Remove-RASThemeGroupFilter
      • Remove-RASURLRedirectionEntry
      • Remove-RASVDIHost
      • Remove-RASVDIHostPool
      • Remove-RASVDIHostPoolMember
      • Remove-RASVDIPersistentHost
      • Remove-RASWinDeviceGroup
      • Remove-RASWinDeviceGroupInboundPort
      • Reset-RASMFAUsers
      • Reset-RASVM
      • Restart-RASVM
      • Send-RASInvitationEmail
      • Send-RASSupportRequest
      • Send-RASTestEmail
      • Set-RASADIntegrationSettings
      • Set-RASAdminAccount
      • Set-RASAgentLogLevel
      • Set-RASAllowedDevicesSetting
      • Set-RASAppPackage
      • Set-RASAppPackageAssigned
      • Set-RASAppPackageSettings
      • Set-RASAppPackageSettingsTags
      • Set-RASAuthSettings
      • Set-RASAutoUpgrade
      • Set-RASAutoUpgradeMessage
      • Set-RASAVDDefaultSettings
      • Set-RASAVDHostPool
      • Set-RASAVDSettings
      • Set-RASAVDWorkspace
      • Set-RASBroker
      • Set-RASBrokerAutoPromotionSettings
      • Set-RASBrokerPriority
      • Set-RASCertificate
      • Set-RASClientPolicy
      • Set-RASClientPolicyAssignment
      • Set-RASClientPolicyOrder
      • Set-RASClientSettings
      • Set-RASCPUOptimizationSettings
      • Set-RASCriteria
      • Set-RASCriteriaOS
      • Set-RASCustomPermission
      • Set-RASCustomRoute
      • Set-RASDayPlan
      • Set-RASEnrollmentServer
      • Set-RASFarmSettings
      • Set-RASFSLogix
      • Set-RASFSLogixFolderExclusion
      • Set-RASFSLogixSettings
      • Set-RASGateway
      • Set-RASGatewayDefaultSettings
      • Set-RASHALB
      • Set-RASHALBDevicePriority
      • Set-RASHelpdeskEmailSettings
      • Set-RASImageOptimization
      • Set-RASInvitationEmailSettings
      • Set-RASLBSettings
      • Set-RASLetsEncryptSettings
      • Set-RASLogonHours
      • Set-RASLogonHoursOrder
      • Set-RASMailboxSettings
      • Set-RASMFA
      • Set-RASMFARadiusAuto
      • Set-RASNotificationEvent
      • Set-RASNotificationResource
      • Set-RASNotificationScript
      • Set-RASOverwriteSupportActions
      • Set-RASPerformanceMonitorSettings
      • Set-RASPowerPermission
      • Set-RASPrintingSettings
      • Set-RASProvider
      • Set-RASProviderAdminCredentials
      • Set-RASProviderRemotePCStatic
      • Set-RASProxySettings
      • Set-RASPubAppFileExt
      • Set-RASPubAVDApp
      • Set-RASPubAVDDesktop
      • Set-RASPubDefaultSettings
      • Set-RASPubFolder
      • Set-RASPubItem
      • Set-RASPubItemFilter
      • Set-RASPubItemPreferredRoute
      • Set-RASPubRDSApp
      • Set-RASPubRDSAppServerAttr
      • Set-RASPubRDSDesktop
      • Set-RASPubVDIApp
      • Set-RASPubVDIDesktop
      • Set-RASRDSDefaultSettings
      • Set-RASRDSHost
      • Set-RASRDSHostPool
      • Set-RASReportingSettings
      • Set-RASRule
      • Set-RASSAMLIDP
      • Set-RASScanningSettings
      • Set-RASSchedule
      • Set-RASScheduleMessage
      • Set-RASSessionSetting
      • Set-RASSite
      • Set-RASSystemSettings
      • Set-RASTemplate
      • Set-RASTemplateVersion
      • Set-RASTenant
      • Set-RASTenantBrokerSettings
      • Set-RASTheme
      • Set-RASThemeCustomImage
      • Set-RASURLRedirectionEntry
      • Set-RASURLRedirectionSettings
      • Set-RASVDIDefaultSettings
      • Set-RASVDIHostPool
      • Set-RASVDIPersistentHost
      • Set-RASWinDeviceGroup
      • Start-RASVM
      • Stop-RASVM
      • Suspend-RASVM
      • Update-RASAgent
    • Classes and enumerations
      • AccelerationMode
      • AcceptedSSLVersion
      • AccessType
      • AcmeCommand
      • AcmeRevokeReason
      • ActionSettings
      • ActionType
      • ADIntegrationSettings
      • AdminAccount
      • AdminCredential
      • AdminNotify
      • AdminSession
      • AdminType
      • ADType
      • AdvancedSettings
      • AgentSettings
      • AgentState
      • AllocationType
      • AllowClientMode
      • AllowedIPsCriteria
      • AllowedOperatingSystems
      • AllowMultiMonitor
      • AllowURLAndMailRedirection
      • Appearance
      • AppPackage
      • AppPackageAssigned
      • AppPackageAssignedObjType
      • AppPackageCertificate
      • AppPackageRegistrationStatus
      • AppPackagesAssigned
      • AppPackageSettings
      • AppPackageStatus
      • AppPackageVersion
      • AppServicesSettings
      • AppVersionTag
      • Assignment
      • AssignmentType
      • AttributeType
      • Audio
      • AudioMode
      • AudioQuality
      • AuthenticationTypes
      • AuthType
      • AutoScale
      • AutoUpgradeSettings
      • AVDBrokenReason
      • AVDCommand
      • AVDCustomHost
      • AVDDefaultSettings
      • AVDDefObjType
      • AVDFeaturesSettings
      • AVDGallery
      • AVDGalleryImage
      • AVDHost
      • AVDHostPool
      • AVDHostPoolStatus
      • AVDHostSysInfo
      • AVDHostSysSessionApp
      • AVDLicenseType
      • AVDLocation
      • AVDMarketplaceVersion
      • AVDMultimediaRedirection
      • AVDOffer
      • AVDPredefinedVMImage
      • AVDProvider
      • AVDProvisioningSettings
      • AVDPublisher
      • AVDResourceGroup
      • AVDSessionApp
      • AVDSKU
      • AVDSubnet
      • AVDVersion
      • AVDVirtualNetwork
      • AVDVMSize
      • AVDWorkspace
      • AVDWorkspaceStatus
      • AWSEC2Provider
      • AWSEC2Version
      • AzureProvider
      • AzureVersion
      • BaseProvisioningSettings
      • BinaryChoice
      • Broker
      • BrokerAgentDiagnostic
      • BrokerAutoPromotion
      • BrokerDiagnosticState
      • BrokerSysInfo
      • Browser
      • Certificate
      • CertificateKeySize
      • CertificateStatus
      • CertificateType
      • CertificateUsages
      • CheckForUpdate
      • CipherStrength
      • ClientDeviceCriteriaEntry
      • ClientFeatureSetType
      • ClientOptions
      • ClientOptionsAdvancedSettings
      • ClientOptionsPrinting
      • ClientPolicy
      • ClientPolicyAllowedOperatingSystems
      • ClientPolicyAssignment
      • ClientPolicyCriteria
      • ClientPolicyInputMethod
      • ClientPolicyRule
      • ClientPrinterPreference
      • ClientRules
      • Clipboard
      • ClipboardDirections
      • CloneMethod
      • CloudCacheGeneralSettings
      • CloudCacheSettings
      • ColorDepth
      • Colors
      • Compression
      • CompressionType
      • ComputerName
      • Configuration
      • Connection
      • ConnectionAdvancedSettings
      • ConnectionBannerType
      • ConnectionBar
      • ConnectionMode
      • Connections
      • ConnMode
      • ContainerAdvancedSettings
      • ContainerSettings
      • ControlSettings
      • CPUOptimizationSettings
      • Credentials
      • CriteriaDefObjType
      • CriteriaObjType
      • CurrentAdminPermissions
      • CustomerExperienceProgram
      • CustomMenu
      • CustomPermission
      • CustomRoute
      • CustomScript
      • CustomWorkAreaImageFit
      • CustomWorkAreaImageType
      • DayPlanObjType
      • DeepnetAuthMode
      • DefaultAssignmentType
      • DefaultPowerState
      • DefaultPrintingSettings
      • DesktopOptions
      • DesktopSize
      • DetailsType
      • DetectClientMode
      • Devices
      • DevicesCriteria
      • DiagnosticState
      • DiskCleanup
      • DiskDrives
      • DiskType
      • DisplayConfig
      • DistributionState
      • DragAndDropModeValue
      • DriveCacheMode
      • DummyVersion
      • EC2LocationType
      • EmailSupportRequest
      • EnableState
      • EnrollmentServer
      • EnrollmentServerAgentDiagnostic
      • EnrollmentServerStatus
      • ExcludeADGroupEntry
      • ExcludeADGroupsSettings
      • ExcludeCommonFolders
      • ExcludeFolderCopy
      • ExternalEmailStorage
      • FarmMode
      • FileTransfer
      • FileTransferControlMode
      • FIPSMode
      • FIPSModeSett
      • FolderExclusion
      • FooterURL
      • FSLogixFeaturesSettings
      • FSLogixGeneralSettings
      • FSLogixListType
      • FSLogixLogEnabled
      • FSLogixLoggingSettings
      • FSLogixLogLevel
      • FSLogixReasonCode
      • FSLogixServerObjType
      • FSLogixSettings
      • FSLogixStatusCode
      • Gateway
      • GatewayAgentDiagnostic
      • GatewayCriteriaEntry
      • GatewayDefaultSiteSettings
      • GatewayMode
      • GatewayRuleType
      • GatewaysCriteria
      • GatewaySecurityMode
      • GatewaySysInfo
      • GlobalPermission
      • GlobalPermissions
      • GlobalPolicy
      • GroupFilter
      • GuestAgentDiagnostic
      • GuestAgentInfo
      • HALBClientManagerConfigSettings
      • HALBDevice
      • HALBDeviceAgentDiagnostic
      • HALBDeviceStatus
      • HALBGatewayConfigSettings
      • HALBSettings
      • HALBSSLConfigSettings
      • HALBVirtualServerStatus
      • HAMode
      • HardwareIDCriteriaEntry
      • HardwareIDsCriteria
      • HeaderOptions
      • HighAvailabilityState
      • HiveType
      • HostAssignmentType
      • HostPoolAgentSettings
      • HostPoolCmd
      • HostPoolObjType
      • HostPowerState
      • HostSessionType
      • HourPlan
      • HyperVClusterProvider
      • HyperVFailoverClusterVersion
      • HyperVProvider
      • HyperVVersion
      • IconFormat
      • IconSizes
      • IfAuthenticationFail
      • IgnoreNonAVD
      • ImageFormatType
      • ImageOptimization
      • ImageOptimizationWindowsScheduledTask
      • ImagePrepTool
      • ImageType
      • ImportExport
      • Parallels RAS PowerShell
      • InputPrompt
      • InstallType
      • InvitationEmailSettings
      • InviteAuthType
      • InviteConnMode
      • InviteTargetDev
      • IP4Range
      • IP6Range
      • IPsCriteria
      • IPv4CriteriaEntry
      • IPv6CriteriaEntry
      • IPVersion
      • IRemoteSettings
      • JoinedBrokerStatus
      • JoinStatus
      • Keyboard
      • KeyboardLayout
      • KeyboardType
      • Language
      • LanguageBar
      • LanguageInputPrompt
      • Languages
      • LanguageType
      • LaunchMethod
      • LaunchSession
      • LBMethod
      • LBSettings
      • LegalPolicies
      • LetsEncryptSettings
      • License
      • LicenseKeyType
      • LicenseType
      • LimitClipboardToTextOnlyMode
      • LimitNotify
      • LoadBalancerType
      • LoadBalancingAlgorithm
      • LoadBalancingSSLMode
      • LocalProxyAddress
      • LocationType
      • Logging
      • LogLevelsType
      • LogonHours
      • LogonHoursCriteria
      • LogonStatus
      • LogSpecificComponents
      • MACAddressManagement
      • MACRuleType
      • MailboxTLS
      • MainAuthenticationMode
      • MaintenanceMessages
      • ManageRDPTransportProtocol
      • MatchingModeType
      • MembersSettings
      • MFA
      • MFACriteria
      • MFADeepnet
      • MFADefaultSiteSettings
      • MFAEmailOTP
      • MFARadius
      • MFARadiusAttr
      • MFARadiusAutoInfo
      • MFASafenet
      • MFATOTP
      • MFAType
      • MFAUsersType
      • MirrorLocalOSTToVHD
      • Mode
      • MoveDirection
      • MultiFactorAuthentication
      • MultiMonitor
      • Network
      • NetworkPerformance
      • NetworkType
      • Notification
      • NotificationEvent
      • NotificationEventCriteria
      • NotificationResource
      • NotificationScript
      • NotificationType
      • NutanixProvider
      • NutanixVersion
      • ObjectPermission
      • OfficeContainerAdvancedSettings
      • OfficeContainerSettings
      • OpenApplicationsIn
      • OptimizationFileType
      • OptimizationServerObjType
      • OptimizationTypeEnum
      • Options
      • OSsCriteria
      • OverlayIconType
      • OverwriteSupportActions
      • PackagedApp
      • PackageDetails
      • PasswordEncoding
      • PCKeyboard
      • PendingScheduleType
      • PerformAction
      • Performance
      • PerformanceMonitorSettings
      • Permission
      • PermissionFlags
      • PermissionObjectType
      • PermissionType
      • PermittedHourPlan
      • PoolType
      • Ports
      • PowerState
      • PredefinedComponent
      • PredefinedScheduledTask
      • PredefinedServerObjType
      • PredefinedService
      • PrimaryConnection
      • PrintingDataFormat
      • PrintingOptions
      • PrintingSettings
      • PrintingTechnologyUse
      • PrnDriverAllowMode
      • PrnNameFormat
      • Profile
      • ProfileContainerAdvancedSettings
      • ProfileContainerSettings
      • ProfileDiskFormat
      • ProfileType
      • Protocol
      • Provider
      • ProviderAgentDiagnostic
      • ProviderDiagnosticState
      • ProviderHost
      • ProviderHostApp
      • ProviderMajorType
      • ProviderSubType
      • ProviderSubTypeAll
      • ProviderSysInfo
      • ProviderSysInfoHost
      • ProviderSysInfoHostApp
      • ProviderType
      • ProvisioningSettings
      • ProvisioningType
      • ProxyMode
      • ProxyType
      • PubAppAttr
      • PubAVDApp
      • PubAVDDesktop
      • PubDefaultSettings
      • PubFileExtSettings
      • PubFolder
      • PubItem
      • PubItemCmd
      • PubItemCriteria
      • PubItemFilter
      • PubItemRule
      • PubItemStatus
      • PublishedApplications
      • PublishFrom
      • PublishingType
      • PubPCApp
      • PubPreferredRoute
      • PubRDSApp
      • PubRDSDesktop
      • PubResourceEnabledMode
      • PubVDIApp
      • PubVDIDesktop
      • QualityLevel
      • RadiusAttrType
      • RadiusType
      • RASAdminSessionProcessCmd
      • RASAgentDiagnosticType
      • RASAgentInfo
      • RASAllowedDevicesSetting
      • RASAuthSettings
      • RASClientSettings
      • RASFarmSettings
      • RASFiles
      • RASHelpdeskEmailSettings
      • RASListObj
      • RASLogLevel
      • RASLogSrvType
      • RASMailboxSettings
      • RASNotificationEventType
      • RASNotificationResourceType
      • RASPowerPermission
      • RASProxySettings
      • RASPubObject
      • RASSerilazableObj
      • RASServerType
      • RASSessionSetting
      • RASSystemSettings
      • RDPPrinterSettings
      • RDPSession
      • RDSAgentDiagnostic
      • RDSCmd
      • RDSDefaultSettings
      • RDSDefaultSiteSettings
      • RDSession
      • RDSessionSource
      • RDSHost
      • RDSHostPool
      • RDSHostPoolCmd
      • RDSHostPoolStatus
      • RDSHostSessionApp
      • RDSHostSysInfo
      • RDSHostSysInfoSession
      • RDSHostSysInfoSessionApp
      • RDSProcessCmd
      • RDSSessionCmd
      • Reconnection
      • RedirectActionType
      • Redirection
      • RedirectScanner
      • RedirectType
      • Registries
      • Registry
      • RemoteFxUsbRedirection
      • RemotePCDynamicProvider
      • RemotePCDynamicVersion
      • RemotePCStatic
      • RemotePCStaticProvider
      • RemotePCStaticVersion
      • RemoveType
      • RepairObjType
      • RepeatSpecificDays
      • RepeatType
      • ReportingSettings
      • RequestType
      • ResourceType
      • RetryLastActionObjType
      • RoamSearch
      • RouteFlowHopType
      • RouteFlowInfoEntry
      • RoutingType
      • RuleObjType
      • SafeNetAuthMode
      • SAMLIDP
      • SAMLIDPAttribute
      • SAMLIDPAttributes
      • SaveZipSupportRequest
      • ScaleComputingProvider
      • ScaleVersion
      • Scanning
      • ScanningSettings
      • ScanningTechnologyUse
      • ScanType
      • Schedule
      • ScheduleActionType
      • ScheduleMessage
      • ScheduleObjType
      • ScheduleTargetType
      • SecondaryConnection
      • SecondaryConnections
      • SectionPermission
      • SectionPermissions
      • SecurityPrincipalCriteriaEntry
      • SecurityPrincipalsCriteria
      • SendMsgWhen
      • SendSupportReport
      • ServerAppInfo
      • ServerAuthentication
      • ServerDefObjType
      • Session
      • SessionAction
      • SessionColorDepth
      • SessionLoginStatus
      • SessionMode
      • SessionPolicy
      • SessionPrelaunch
      • SessionProtocol
      • SessionPublishingType
      • SessionsPrinting
      • SessionState
      • SessionType
      • SessionUPDStatus
      • Settings
      • SettingsColorDepth
      • ShowInformationForUnenrolledUsers
      • SingleSignOn
      • Site
      • SitePermission
      • SiteSysInfo
      • SiteTypePermission
      • SmartCards
      • SmartSizing
      • StatusLevel
      • StopOptimizationObjType
      • StorageDevice
      • Subnet
      • SupportType
      • TargetNativeHost
      • TargetType
      • TempFolderRedirectionMode
      • Template
      • TemplateAdvanced
      • TemplateAdvancedAWS
      • TemplateAdvancedAzure
      • TemplateAdvancedFolder
      • TemplateAdvancedMultipleNIC
      • TemplateAdvancedNativePool
      • TemplateAdvancedPhysicalHost
      • TemplateCmd
      • TemplateLicense
      • TemplateLicenseKey
      • TemplateObjType
      • TemplatePreparation
      • TemplateSettings
      • TemplateState
      • TemplateStatus
      • TemplateVersion
      • TemplateVersionObjType
      • TemplateVersionStatus
      • TemplateVersionStatusType
      • Tenant
      • TenantBrokerSettings
      • TenantBrokerSettingsCommand
      • TenantCommand
      • Theme
      • ThemeCustomImage
      • ThemeImageTypes
      • ThemesCriteria
      • ThemeUserPortal
      • ThemeUserPortalBranding
      • ThemeUserPortalGateway
      • ThemeUserPortalMessages
      • ThemeWindowsBranding
      • ThemeWindowsClient
      • ThemeWindowsMessages
      • ThresholdDirection
      • TokenType
      • TOTPType
      • Trigger
      • UIType
      • UniversalPrinting
      • Update
      • UPDMode
      • UPDRoamingMode
      • UPDStatus
      • Url
      • URLRedirectEntry
      • URLRedirectionSettings
      • UserEnrollment
      • UserFilter
      • UserGroupType
      • UserProfileSettings
      • UserProfileTech
      • UserProfileType
      • UserType
      • UWPApps
      • ValueType
      • VCenterProvider
      • VDIAzureInfo
      • VDICommand
      • VDIDefaultSettings
      • VDIGeneralSettings
      • VDIHost
      • VDIHostConn
      • VDIHostPool
      • VDIHostPoolMember
      • VDIHostPoolMemberType
      • VDIHostPoolStatus
      • VDIHostState
      • VDIHostSysInfo
      • VDIMatchingMode
      • VDIPersistentHost
      • VDIProcessCmd
      • VDIRDPSession
      • VDISecuritySettings
      • VDIServerAppInfo
      • VDISessionCmd
      • VHDAccessMode
      • VHDXSectorSize
      • VideoCaptureDevices
      • VisualEffects
      • VisualEffectsType
      • VM
      • VMState
      • VMwareESXiProvider
      • VmwareESXiVersion
      • VmwareVCenterVersion
      • VolumeType
      • WebAuthentication
      • WeekDays
      • WhenAllSessionClosedAction
      • WinDeviceGroup
      • WinDeviceGroupInboundPort
      • WindowsAdvancedOptions
      • WindowsClient
      • WindowsComponent
      • WindowsComponents
      • WindowsDefenderATP
      • WindowsDefenderATPEnable
      • WindowsScheduledTasks
      • WindowsService
      • WindowsServices
      • WindowsTouchInput
      • WindowType
      • WorkAreaImage
    • Parallels RAS PowerShell
    • Contents
  • API Versions
  • Examples
    • Basic Example
    • Farm Example
    • Parallels RAS PowerShell
    • PA Promote Example
    • Publishing Example
    • Agent Example
    • RDS Template Example
    • Status Info Example
    • VDI Example
Powered by GitBook

© 2025 Parallels International GmbH. All rights reserved.

On this page
  • NAME
  • SYNOPSIS
  • SYNTAX
  • DESCRIPTION
  • PARAMETERS
  • INPUTS
  • OUTPUTS
  • EXAMPLES
  • RELATED LINKS
Export as PDF
  1. Parallels RAS Powershell Admin Module
  2. Commands

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> General: Description of the Theme

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> General: Whether Theme is enabled or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> General: The MFA Provider Id. One can set MFAId as 0 to unassign MFA from a theme.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OverrideAuthenticationDomain <bool> General: Whether to override the authentication domain

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Domain <string> General: The domain used

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GroupEnabled <bool> General: Whether to limit Themes to a certain group

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PostLogonMessage <string> Messages: The post-logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginPageURLPath <string> User Portal - URLs: The Theme login page URL Path following protocol and domain such as 'https://FQDN/path'.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ShowDownloadURL <bool> User Portal - URLs: Whether to show the download URL

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OverrideWindowsClientDownloadURL <string> User Portal - URLs: The Override download URL for branded Parallels Client (Windows)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WebpageTitle <string> User Portal - Branding: The Webpage Title

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FaviconIconFile <string> User Portal - Branding: The Favicon Image File path

If empty, the Favicon Icon is reset to default.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HeaderOptions <HeaderOptions> User Portal - Colors: The header options.

Possible values: Blurred, SolidColor

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkAreaImage <WorkAreaImage> User Portal - Colors: The work area image.

Possible values: SolidColor, Image1, Image2, Image3, Image4, Image5, Custom

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CustomWorkAreaImageType <CustomWorkAreaImageType> User Portal - Colors: The custom work area image type.

Possible values: URL, File

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CustomWorkAreaImageURL <string> User Portal - Colors: The custom work area image URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CustomWorkAreaImageId <uint> User Portal - Colors: The custom work area image Id.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CustomWorkAreaImageFit <CustomWorkAreaImageFit> User Portal - Colors: The custom work area image fit.

Possible values: Fill, Tile, Center, Fit

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HeaderBackgroundColor <uint> User Portal - Colors: The header background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkAreaBackgroundColor <uint> User Portal - Colors: The work area background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkAreaTextColor <uint> User Portal - Colors: The work area text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ButtonsBackgroundColor <uint> User Portal - Colors: The buttons background and link color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ButtonsTextColor <uint> User Portal - Colors: The buttons text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_de_DE <bool> User Portal - Language bar: Whether to enable the German Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_en_US <bool> User Portal - Language bar: Whether to enable the English (US) Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_es_ES <bool> User Portal - Language bar: Whether to enable the Spanish Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_fr_FR <bool> User Portal - Language bar: Whether to enable the French Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_it_IT <bool> User Portal - Language bar: Whether to enable the Italian Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_ja_JP <bool> User Portal - Language bar: Whether to enable the Japanese Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_ko_KR <bool> User Portal - Language bar: Whether to enable the Korean Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_nl_NL <bool> User Portal - Language bar: Whether to enable the Dutch Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_pt_BR <bool> User Portal - Language bar: Whether to enable the Portuguese Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_zh_CN <bool> User Portal - Language bar: Whether to enable the Chinese Simplified Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LanguageBar_zh_TW <bool> User Portal - Language bar: Whether to enable the Chinese Traditional Language Bar or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PreLogonMessage <string> User Portal - Messages: The Pre-Logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UserPortalPostLogonMessage <string> User Portal - Messages: The Post-Logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OverridePostLogonMessage <bool> User Portal - Messages: Whether to override the post-logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_de_DE <string> User Portal - Input prompt: The User Prompt: German

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_de_DE <string> User Portal - Input prompt: The Password Prompt: German

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_en_US <string> User Portal - Input prompt: The User Prompt: English (US)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_en_US <string> User Portal - Input prompt: The Password Prompt: English (US)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_es_ES <string> User Portal - Input prompt: The User Prompt: Spanish

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_es_ES <string> User Portal - Input prompt: The Password Prompt: Spanish

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_fr_FR <string> User Portal - Input prompt: The User Prompt: French

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_fr_FR <string> User Portal - Input prompt: The Password Prompt: French

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_it_IT <string> User Portal - Input prompt: The User Prompt: Italian

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_it_IT <string> User Portal - Input prompt: The Password Prompt: Italian

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_ja_JP <string> User Portal - Input prompt: The User Prompt: Japanese

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_ja_JP <string> User Portal - Input prompt: The Password Prompt: Japanese

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_ko_KR <string> User Portal - Input prompt: The User Prompt: Korean

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_ko_KR <string> User Portal - Input prompt: The Password Prompt: Korean

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_nl_NL <string> User Portal - Input prompt: The User Prompt: Dutch

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_nl_NL <string> User Portal - Input prompt: The Password Prompt: Dutch

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_pt_BR <string> User Portal - Input prompt: The User Prompt: Portuguese

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_pt_BR <string> User Portal - Input prompt: The Password Prompt: Portuguese

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_zh_CN <string> User Portal - Input prompt: The User Prompt: Chinese Simplified

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_zh_CN <string> User Portal - Input prompt: The Password Prompt: Chinese Simplified

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-LoginHint_zh_TW <string> User Portal - Input prompt: The User Prompt: Chinese Traditional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordHint_zh_TW <string> User Portal - Input prompt: The Password Prompt: Chinese Traditional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OverrideGatewaySettings <bool> User Portal - Gateway: Whether to override the gateway settings for the Theme

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowLaunchMethod <bool> User Portal - Gateway: Whether to allow the user to launch session using a particular method

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowAppsInNewTab <bool> User Portal - Gateway: Whether to allow applications in a new tab

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Pre2000Cred <bool> User Portal - Gateway: Whether to use the pre windows 2000 format

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowEmbed <bool> User Portal - Gateway: Whether to allow embed

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowCORS <bool> User Portal - Gateway: Whether to allow cross-origin resource sharing

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowedDomainsForCORS <List`1> User Portal - Gateway: Allowed domains for cross-origin resource sharing.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-BrowserCacheTimeInMonths <uint> User Portal - Gateway: How long should the browser preserve the cache (in months).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UseClientIPDetectionService <bool> Use Client IP detection service.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ClientIPPDetectionServiceURL <string> Client IP detection service URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DetectClientMode <DetectClientMode> Detection mode.

Automatically on sign in

Manually on user prompt (Default)

Possible values: Automatic, Manual

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ClientDetectionTimeout <uint> Client detection timeout in seconds.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowCookieConsent <bool> User Portal - Legal policies: Whether to allow cookies or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowEULA <bool> User Portal - Legal policies: Whether to allow EULA

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowCEPOptIn <bool> User Portal - Legal policies: Whether to allow CEP opt-in or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CompanyName <string> Windows client - Branding: The Company Name

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ApplicationName <string> Windows client - Branding: The Application Name

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProgressBarColor <uint> Windows client - Branding: The progress bar color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ApplicationIconFile <string> Windows client - Branding: The Application Icon File path

If empty, the Application Icon is reset to default.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WindowsClientOverridePostLogonMessage <bool> Windows client - Messages: Whether to allow the override post-logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WindowsClientPostLogonMessage <string> Windows client - Messages: The post-logon message

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MenuItem <string> Windows client - Custom menu: The Menu Item

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Command <string> Windows client - Custom menu: The Command

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowTunneling <bool> Access: If tunneling should be enabled on theme

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Set-RASTheme -Name NewTheme -NewName EditedTheme

Changes the name of the theme from NewTheme to EditedTheme.

RELATED LINKS

  • New-RASTheme

  • Remove-RASTheme

  • Get-RASTheme

PreviousSet-RASTenantBrokerSettingsNextSet-RASThemeCustomImage

Last updated 9 months ago