Citrix Virtual Apps and Desktops SDK

Unregister-HypPvsSite

Introduced in: Citrix Virtual Apps and Desktop 7 2209

Unregister PVS Site.

Syntax

Unregister-HypPvsSite
          -SiteId <Guid>
          [<CitrixCommonParameters>]
          [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to remove a PvsSite with the corresponding SiteId

Examples

EXAMPLE 1

This command unregisters the PVS site with SiteId 00000000-0000-0000-0000-000000000000

Unregister-HypPvsSite -SiteId 00000000-0000-0000-0000-000000000000
<!--NeedCopy-->

Parameters

-SiteId

The ID of the PVS site.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
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


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.

PermissionDenied

The user does not have administrative rights to perform this operation.

ExceptionThrown

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

Unregister-HypPvsSite