Reset-AppLibServiceGroupMembership

Last published : Oct 31, 2026
Reloads the access permissions and configuration service locations for the AppLibrary Service.
Related information
about_AppLibAppLibrarySnapin

Syntax

Reset-AppLibServiceGroupMembership
     [-ConfigServiceInstance] <ServiceInstance[]>
     [-LoggingId <Guid>]
     [-SkipCertificateValidation]
     [<CitrixCommonParameters>]
     [<CommonParameters>]

Description

Reloads the access permissions and configuration service locations for the AppLibrary Service.
The Reset-AppLibServiceGroupMembership cmdlet must be run on at least one instance of the service type (AppLib) after installation and registration with the configuration service. Without this operation, the AppLibrary services will be unable to communicate with other services in the Citrix Virtual Apps and Desktops deployment.
When the cmdlet is run, the services are updated when additional services are added to the deployment, provided that the configuration service is not stopped. The Reset-AppLibServiceGroupMembership 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.

Examples

EXAMPLE 1

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.
Get-ConfigRegisteredServiceInstance -ServiceType Config | Reset-AppLibServiceGroupMembership

EXAMPLE 2

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'.
Get-ConfigRegisterdServiceInstance -ServiceType Config -AdminAddress OtherServer.example.com | Reset-AppLibServiceGroupmembership

Parameters

-ConfigServiceInstance

Specifies the configuration service instance object that represents the service instance for the type 'InterService' that references a configuration service for the deployment.
Type: ServiceInstance[]
Position: 2
Default value: LocalHost
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-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.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

Citrix.AppLibrary.Sdk.ServiceInstance\[\]

Service instances containing a ServiceInstance object that refers to the Central Configuration Service interservice interface can be piped to the Reset-AppLibServiceGroupMembership command.

Outputs

Citrix.AppLibrary.Sdk.ServiceInstance

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

Notes

If the command fails, the following errors can be returned:
  • 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 Citrix Virtual Apps and Desktops logs.