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

August 3, 2023
Contributed by: 
C

Set the Service configuration data objects.

Syntax


Set-BrokerServiceConfigurationData [-InputObject] <ServiceConfigurationData[]> [-PassThru] [-SettingValue <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

View the Service configuration data objects stored in the broker database. These objects if set correctly, if set overrride the values present in the windows registry

Parameters

Name Description Required? Pipeline Input Default Value
InputObject The service configuration data object true true (ByValue)  
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
SettingValue The value of the service setting that can be overridden and stored in the database. This must fall in the specified range as described in order to successfully set the service configuration object. Keeping the parameter as null will result in resetting of the key(It will be read from the windows registry in that case) 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

Input cannot be piped to this cmdlet.

Return Values

None Or Citrix.Broker.Admin.Sdk.Serviceconfigurationdata

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.ServiceConfigurationData object.

Examples

Example 1 


Set-BrokerServiceConfigurationData Core.MaxHeartbeatIntervalMs  -SettingValue 360000

<!--NeedCopy-->

Description

Running this will set the MaxHeartbeatIntervalMs to 6 minutes

Example 2 


Set-BrokerServiceConfigurationData MaxHeartbeatIntervalMs

<!--NeedCopy-->

Description

Running this will reset the value of MaxHeartbeatIntervalMs and it will be read from the windows registry instead of the Broker Database

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