Product Documentation

Reset-BrokerServiceGroupMembership

Apr 15, 2014

Makes the broker load, from the specified Configuration Service instance, the addresses that the Service can be reached on.

Syntax

Reset-BrokerServiceGroupMembership -ConfigServiceInstance <PSObject[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This cmdlet reloads the access permissions and Configuration Service locations for the Broker Service. It must be run on at least one instance of the Broker Service after installation and registration with the Configuration Service. Without this operation, the Broker Services cannot communicate with the other services that form part of the Citrix XenDesktop deployment. Once the cmdlet is run, the services keep up to date when additional services are added to the deployment provided that the Configuration Service is not stopped. Run this cmdlet to refresh this information if automatic updates do not occur when new services are added to the deployment. If more than one Configuration Service instance is passed to the cmdlet, only the first is used that meets the expected service type requirements.

Related topics

Get-BrokerServiceInstance

Get-BrokerServiceStatus

Get-ConfigRegisteredServiceInstance

Parameters

-ConfigServiceInstance<PSObject[]>

The Configuration Service Instance object that represents a service instance of the type InterService that in turn references a Configuration Service for the deployment.

Required? true
Default Value LocalHost
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.XDPowerShell.ServiceInstance You can pipe a ServiceInstance that contains a ServiceInstance object that in turn refers to the Configuration Service InterService interface.

Return Values

Citrix.XDPowerShell.ServiceInstance

Reset-BrokerServiceGroupMembership returns opaque objects containing Configuration Service instances that are used by the Broker Service instance.

Examples

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

c:\PS$gt;Get-ConfigRegisteredServiceInstance -ServiceType Config | Reset-BrokerServiceGroupMembership

Resets the Broker Service's group membership. This assumes that the Configuration Service is running and configured on the same machine as the Broker service.

-------------------------- EXAMPLE 2 --------------------------

c:\PS$gt;Get-ConfigRegisteredServiceInstance -ServiceType Config -AdminAddress OtherServer.com | Reset-BrokerServiceGroupmembership

Resets the Broker Service's group membership. This uses a Configuration Service that is running and configured on a server called OtherServer.com.