This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Set-BrokerSite
Changes the overall settings of the current XenDesktop broker site.
Syntax
Set-BrokerSite
[-PassThru]
[-AlwaysBypassAuthForCachedResources <Boolean>]
[-ApplicationIconUid <Int32>]
[-BaseOU <Guid>]
[-BypassAuthForCachedResources <Boolean>]
[-CloudSiteLicense <String>]
[-CloudValidLicenses <String>]
[-ColorDepth <ColorDepth>]
[-ConnectionLeasingEnabled <Boolean>]
[-CredentialForwardingToCloudAllowed <Boolean>]
[-DefaultMinimumFunctionalLevel <FunctionalLevel>]
[-DefaultReuseMachinesWithoutShutdownInOutage <Boolean>]
[-DeleteResourceLeasesOnLogOff <Boolean>]
[-DesktopGroupIconUid <Int32>]
[-DnsResolutionEnabled <Boolean>]
[-LocalHostCacheEnabled <Boolean>]
[-PreferredAccountName <String>]
[-RequireXmlServiceKeyForNFuse <Boolean>]
[-RequireXmlServiceKeyForSta <Boolean>]
[-ResourceLeaseValidityPeriodInDays <Int32>]
[-ResourceLeasingEnabled <Boolean>]
[-ReuseMachinesWithoutShutdownInOutageAllowed <Boolean>]
[-SecureIcaRequired <Boolean>]
[-TelemetryHeadlessLaunchEnabled <Boolean>]
[-TelemetryLaunchMinTimeIntervalMins <Int32>]
[-TelemetryLaunchShadowDelayMins <Int32>]
[-TrustManagedAnonymousXmlServiceRequests <Boolean>]
[-TrustRequestsSentToTheXmlServicePort <Boolean>]
[-UseVerticalScalingForRdsLaunches <Boolean>]
[-XmlServiceKey1 <String>]
[-XmlServiceKey2 <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Set-BrokerSite cmdlet modifies properties of the current broker site.
The broker site is a top-level, logical representation of the XenDesktop site, from the perspective of the brokering services running within the site. It defines various site-wide default attributes used by the brokering services.
A XenDesktop installation has only a single broker site instance.
Examples
EXAMPLE 1
Specifies that any new desktop groups created, where a color depth value is not specified, default to using 16-bit color depth for user sessions to desktops or applications within that group.
Set-BrokerSite -ColorDepth SixteenBit
<!--NeedCopy-->
Parameters
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AlwaysBypassAuthForCachedResources
Allows client to always display cached resources without authentication..
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationIconUid
Changes the default icon used for new applications if no icon is specified explicitly when an application is created. Changing this default has no impact on the icons used by existing applications.
The specified icon must already have been added to the site using New-BrokerIcon.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BaseOU
Changes the objectGUID property identifying the base OU in Active Directory used for desktop registrations. For sites using only registry-based discovery (the default) this value is $null.
Any desktop attempting to register through a different OU from the one specified here is rejected. Note that desktops configured for registry-based discovery can register with the site, even if a BaseOU value is specified.
Information held in Active Directory is not modified by changing this value.
Typically, this property is changed only by using the Set-ADControllerDiscovery.ps1 script.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BypassAuthForCachedResources
Allows client to display cached resources without authentication..
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CloudSiteLicense
Used to override the Product, Edition and LicensingModel set during provisioning at CCS level.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CloudValidLicenses
List of license SKUs purchased by the customer needs to be set a provisioning time every time Ptah re-provisions the customer because of SKU changes for the customer. This will be used for validation purposes.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ColorDepth
Changes the default color depth for new desktop groups, if no color depth is specified explicitly when a group is created. Changing this default has no impact on the color depths used already by existing groups.
Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.
| Type: | ColorDepth |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectionLeasingEnabled
Connection leasing is no longer supported and cannot be enabled. This property exists for backwards compatibility only.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CredentialForwardingToCloudAllowed
Determines whether to allow the Connector to forward user credentials to cloud for verification when they cannot be authenticated locally.
With the default value ($false), requests from Storefront containing user credentials that cannot be authenticated locally will be failed.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultMinimumFunctionalLevel
Changes the default minimum functional level used for new catalogs and desktop groups when no explicit value is provided.
| Type: | FunctionalLevel |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultReuseMachinesWithoutShutdownInOutage
The default ReuseMachinesWithoutShutdownInOutage used for new desktop groups when no explicit value is provided.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeleteResourceLeasesOnLogOff
Enables lease syncing on client.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopGroupIconUid
Changes the default desktop icon used for new desktop groups if no icon is specified explicitly when a group is created. Changing this default has no impact on the icons used already by existing groups.
The specified icon must already have been added to the site using New-BrokerIcon.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DnsResolutionEnabled
Changes whether ICA files returned by a broker service to a user device contain the numeric IP address or the DNS name of the desktop machine to which a session should be established.
With the default value ($false), ICA files will always contain a numeric IP address. To have DNS names appear in the ICA files, set the value to $true.
Even when DNS resolution is enabled ($true), IP addresses may still appear in ICA files. The reasons for this include, for example, that the broker service is unable to obtain a DNS name for the target machine, or that Storefront is configured to always use numeric IP addresses in this context.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocalHostCacheEnabled
If the Local Host Cache feature is available, this property enables or disables it at run-time.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreferredAccountName
Determines if SAM name or UPN should be displayed for default name of user/group account
| Type: | String |
| Accepted values: | SamName, SamNameFallbackToUpn, Upn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireXmlServiceKeyForNFuse
Determines whether an XML Service Key header is required for the NFuse, MCP, and Admin XML interfaces.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireXmlServiceKeyForSta
Determines whether an XML Service Key header is required for the STA interface.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceLeaseValidityPeriodInDays
Validity period for a lease.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceLeasingEnabled
Enables lease syncing on client.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReuseMachinesWithoutShutdownInOutageAllowed
Allows the ReuseMachinesWithoutShutdownInOutage setting on individual DesktopGroups to be enabled. Because these settings have potential security implications, only the site administrator can enable use of this feature. Disabling this setting will clear corresponding field on all delivery groups.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecureIcaRequired
Changes the default SecureICA usage requirements for new desktop groups if no SecureICA setting is specified explicitly when a group is created. Changing this default has no impact on the SecureICA usage requirements of existing groups.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TelemetryHeadlessLaunchEnabled
Enables client to perform headless telemetry launches.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TelemetryLaunchMinTimeIntervalMins
Configures minimum time interval (in minutes) between headless telemetry launches.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TelemetryLaunchShadowDelayMins
Configures delay (in minutes) between ICA-HDX launch and headless telemetry launch.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrustManagedAnonymousXmlServiceRequests
Changes whether the XML Service (as used by Storefront) implicitly trusts managed anonymous launch requests.
With the default value ($false), any attempt to use the XML service for managed anonymous sessions is rejected.
If this setting is enabled, anyone with access to the XML service will be able to utilize the managed anonymous functionality to leave disconnected prelaunched anonymous sessions available for reconnection. You must ensure that controllers running the brokering services are securely firewalled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrustRequestsSentToTheXmlServicePort
Changes whether the XML Service (as used by Storefront) implicitly trusts the originator of requests it receives, or whether it fully authenticates them.
With the default value ($false), full authentication checks are performed. However, you must enable this setting ($true) to allow support for “Pass-through” authentication, and/or connections routed through Access Gateway.
If this setting is enabled, you must ensure that controllers running the brokering services are securely firewalled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseVerticalScalingForRdsLaunches
Determines whether to use vertical scaling when considering RDS machines for launches. Vertical scaling would saturate machines in the current pool rather than send sessions to the least loaded machines. This would be a trade in performance vs. cost, where vertical scaling would be less costly.
With the default value ($false), horizontal scaling will be used.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-XmlServiceKey1
A 256 bit service key for the XML Services.
Use the New-BrokerXmlServiceKey cmdlet to generate keys.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-XmlServiceKey2
A 256 bit service key for the XML Services.
Use the New-BrokerXmlServiceKey cmdlet to generate keys.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You cannot pipe input into this cmdlet.
Outputs
None or Citrix.Broker.Admin.SDK.Site
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.Site object.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.