Citrix Daas SDK

Remove-ConfigServiceGroup

August 9, 2024

Contributed by:

C C

Removes service groups.

Syntax

Remove-ConfigServiceGroup
      [-ServiceGroupUid] <Guid>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Use this cmdlet to remove a service group and all the service instances that it contains.

Examples

EXAMPLE 1

Removes the service group (and all contained service instances) for the service group with a unique identifier of ‘31951f6f-7703-4abb-938a-2861d76ecfea’.

Remove-ConfigServiceGroup -ServiceGroupUid 31951f6f-7703-4abb-938a-2861d76ecfea
<!--NeedCopy-->

EXAMPLE 2

Removes all the service groups (and all contained service instances) for the XenDesktop deployment.

Get-ConfigServiceGroup | Remove-ConfigServiceGroup
<!--NeedCopy-->

Parameters

-ServiceGroupUid

The unique identifier for the service group.

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-LoggingId

Specifies the logging id of the high-level operation this cmdlet invocation is part of.

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

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

In the case of failure, the following errors can result.

Error Codes ———– ServiceGroupObjectNotFound

The service group specified could not be located.

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.

CommunicationError

An error occurred while communicating with the service.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

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

Remove-ConfigServiceGroup

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Remove-ConfigServiceGroup

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ServiceGroupUid

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None

Notes

Related Links

In this article