Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Set-BrokerSite

August 3, 2023
Contributed by: 
C

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>] [-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>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

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

Parameters

Name Description Required? Pipeline Input Default Value
PassThru This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record. false false False
AlwaysBypassAuthForCachedResources Allows client to always display cached resources without authentication.. false 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. false 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. false false  
BypassAuthForCachedResources Allows client to display cached resources without authentication.. false false  
CloudSiteLicense Used to override the Product, Edition and LicensingModel set during provisioning at CCS level. false 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. false 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. false false  
ConnectionLeasingEnabled Connection leasing is no longer supported and cannot be enabled. This property exists for backwards compatibility only. false 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. false false  
DefaultMinimumFunctionalLevel Changes the default minimum functional level used for new catalogs and desktop groups when no explicit value is provided. false false  
DefaultReuseMachinesWithoutShutdownInOutage The default ReuseMachinesWithoutShutdownInOutage used for new desktop groups when no explicit value is provided. false false  
DeleteResourceLeasesOnLogOff Enables lease syncing on client. false 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. false 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. false false  
LocalHostCacheEnabled If the Local Host Cache feature is available, this property enables or disables it at run-time. false false  
RequireXmlServiceKeyForNFuse Determines whether an XML Service Key header is required for the NFuse, MCP, and Admin XML interfaces. false false  
RequireXmlServiceKeyForSta Determines whether an XML Service Key header is required for the STA interface. false false  
ResourceLeaseValidityPeriodInDays Validity period for a lease. false false  
ResourceLeasingEnabled Enables lease syncing on client. false 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. false 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. false false  
TelemetryHeadlessLaunchEnabled Enables client to perform headless telemetry launches. false false  
TelemetryLaunchMinTimeIntervalMins Configures minimum time interval (in minutes) between headless telemetry launches. false false  
TelemetryLaunchShadowDelayMins Configures delay (in minutes) between ICA-HDX launch and headless telemetry launch. false 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. false 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. false 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. false false  
XmlServiceKey1 A 256 bit service key for the XML Services. Use the New-BrokerXmlServiceKey cmdlet to generate keys. false false  
XmlServiceKey2 A 256 bit service key for the XML Services. Use the New-BrokerXmlServiceKey cmdlet to generate keys. false 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. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

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.

Examples

Example 1 


C:\PS> Set-BrokerSite -ColorDepth SixteenBit

<!--NeedCopy-->

Description

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
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.