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 9, 2024
Contributed by: 
C

Set the Service configuration data objects.

Syntax

Set-BrokerServiceConfigurationData
   [-InputObject] <ServiceConfigurationData[]>
   [-PassThru]
   [-SettingValue <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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

Examples

EXAMPLE 1

Running this will set the HeartbeatPeriodMs to 6 minutes

Set-BrokerServiceConfigurationData Core.HeartbeatPeriodMs  -SettingValue 360000
<!--NeedCopy-->

EXAMPLE 2

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

Set-BrokerServiceConfigurationData MaxHeartbeatIntervalMs
<!--NeedCopy-->

Parameters

-InputObject

The service configuration data object

Type: ServiceConfigurationData[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-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

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

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

Input cannot be piped to this cmdlet.

Outputs

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.

Set-BrokerServiceConfigurationData
August 9, 2024
Contributed by: 
C
August 9, 2024
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.