Citrix Virtual Apps and Desktops SDK

Register-HypPvsSite

August 3, 2023

Contributed by:

Syntax

Register-HypPvsSite -SiteId <Guid> -SiteName <String> -FarmId <Guid> -FarmName <String> -ResourceLocation <Guid> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Use this command to register PvsSites with with SiteId FarmId and ResourceLocation.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
SiteId	The ID of the PVS site.	true	true (ByValue)
SiteName	The Name of the PVS site.	true	true (ByValue)
FarmId	The ID of the PVS farm.	true	true (ByValue)
FarmName	The Name of the PVS farm.	true	true (ByValue)
ResourceLocation	The ResourceLocation ID of the PVS server.	true	true (ByValue)
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	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

Return Values

Notes

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

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.

Examples

Example 1

Register-HypPvsSite -SiteId 00000000-0000-0000-0000-000000000000 -SiteName exampleSiteName -FarmId 00000000-0000-0000-0000-000000000000 -FarmName exampleFarmName -ResourceLocation 00000000-0000-0000-0000-000000000000

<!--NeedCopy-->

Description

This command registers a PvsSite with 00000000-0000-0000-0000-000000000000 in each attribute

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

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Register-HypPvsSite

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Notes

Examples

Example 1

Description

In this article