Register-Hyppvssite¶
Register PVS Site.
Syntax¶
Register-HypPvsSite -SiteId <Guid> -SiteName <String> -FarmId <Guid> -FarmName <String> -ResourceLocation <Guid> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Use this command to register PvsSites with with SiteId FarmId and ResourceLocation.
Related Commands¶
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.
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.
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
Description¶
This command registers a PvsSite with 00000000-0000-0000-0000-000000000000 in each attribute