Register-HypPvsServer
Register PVS Site.
Syntax
Register-HypPvsServer
-SiteId <Guid>
-SiteName <String>
-FarmId <Guid>
-FarmName <String>
-ServerId <Guid>
-ServerName <String>
-ServerAddress <String>
-Thumbprint <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Use this command to register PvsSites with with SiteId FarmId and ResourceLocation.
Examples
EXAMPLE 1
This command registers a PvsServer with 00000000-0000-0000-0000-000000000000 in each attribute
Register-HypPvsServer -SiteId 00000000-0000-0000-0000-000000000000 -SiteName exampleSiteName -FarmId 00000000-0000-0000-0000-000000000000 -FarmName exampleFarmName -ServerId 00000000-0000-0000-0000-000000000000 -ServerAddress xyz.abc.local -ServerName exampleServerName
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 |
-SiteName
The Name of the PVS site.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-FarmId
The ID of the PVS farm.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-FarmName
The Name of the PVS farm.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-ServerId
The Server ID of the PVS server.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-ServerName
The PVS Server Name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-ServerAddress
The PVS Server Address
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Thumbprint
The PVS Server Certificate SSL Thumbprint
| Type: | String |
| 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.