Citrix Virtual Apps and Desktops SDK

Reset-Hypservicegroupmembership

July 4, 2023

Contributed by:

Reloads the access permissions and configuration service locations for the Host Service.

Syntax

Reset-HypServiceGroupMembership [-ConfigServiceInstance] <ServiceInstance[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Enables you to reload Host Service access permissions and configuration service locations. The Reset-HypServiceGroupMembership command must be run on at least one instance of the service type (Hyp) after installation and registration with the configuration service. Without this operation, the Host services will be unable to communicate with other services in the XenDesktop deployment. When the command is run, the services are updated when additional services are added to the deployment, provided that the configuration service is not stopped. The Reset-HypServiceGroupMembership command can be run again 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 command, the first instance that meets the expected service type requirements is used.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ConfigServiceInstance	Specifies the configuration service instance object that represents the service instance for the type ‘InterService’ that references a configuration service for the deployment.	true	true (ByValue)
LoggingId	Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Host.Sdk.Serviceinstance[]
Service Instances Containing A Serviceinstance Object That Refers To The Central Configuration Service Inter-Service Interface Can Be Piped To The Reset-Hypservicegroupmembership Command.

Return Values

Notes

If the command fails, the following errors can be returned.
Error Codes
———–
NoSuitableServiceInstance
None of the supplied service instance objects were suitable for resetting service group membership.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1

c:\PS>Get-ConfigRegisteredServiceInstance -ServiceType Config | Reset-HypServiceGroupMembership
<!--NeedCopy-->

Description

Reset the service group membership for a service in a deployment where the configuration service is configured and running on the same machine as the service.

Example 2

c:\PS>Get-ConfigRegisterdServiceInstance -ServiceType Config -AdminAddress OtherServer.example.com | Reset-HypServiceGroupmembership
<!--NeedCopy-->

Description

Reset the service group membership for a service in a deployment where the configuration service that is configured and running on a machine named ‘OtherServer.example.com’.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Reset-Hypservicegroupmembership

July 4, 2023

Contributed by:

July 4, 2023

Contributed by:

Reset-Hypservicegroupmembership

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Host.Sdk.Serviceinstance[]Service Instances Containing A Serviceinstance Object That Refers To The Central Configuration Service Inter-Service Interface Can Be Piped To The Reset-Hypservicegroupmembership Command.

Return Values

Notes

Examples

Example 1

Description

Example 2

Description

In this article

Citrix.Host.Sdk.Serviceinstance[]
Service Instances Containing A Serviceinstance Object That Refers To The Central Configuration Service Inter-Service Interface Can Be Piped To The Reset-Hypservicegroupmembership Command.