Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-Provinstalleddbversion

August 3, 2023
Contributed by: 
C

Gets a list of all available database schema versions for the MachineCreation Service.

Syntax

Get-ProvInstalledDBVersion [-Upgrade] [-Downgrade] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Gets the current version number of the Citrix MachineCreation Service database schema when called with no parameters.

When called with the -Upgrade parameter, gets the service schema version numbers to which an upgrade could be performed.

When called with the -Downgrade parameter, gets the service schema version numbers to which a downgrade could be performed.

The SQL scripts to perform schema upgrades and downgrades can be obtained using the Get-ProvDBVersionChangeScript cmdlet. Citrix recommends that where possible service schema upgrades are performed using Studio rather than manually via the SDK.

Only one of the -Upgrade or -Downgrade parameters may be supplied at once.

Parameters

Name Description Required? Pipeline Input Default Value
Upgrade Specifies that only schema versions to which the current database version can be updated should be returned. false false  
Downgrade Specifies that only schema versions to which the current database version can be reverted should be returned. false false  
BearerToken Specifies the bearer token assigned to the calling user 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

None

You cannot pipe input into this cmdlet.

Return Values

System.Version

Get-ProvInstalledDBVersion returns database schema version numbers as requested.
Major <Integer> Minor <Integer> Build <Integer> Revision <Integer>

Notes

If the command fails, the following errors can be returned.
Error Codes
———–
InvalidParameterCombination
Both the Upgrade and Downgrade flags were specified.
NoOp
The operation was successful but had no effect.
NoDBConnections
The database connection string for the MachineCreation Service has not been specified.
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.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1 

PS C:\>Get-ProvInstalledDBVersion

Major  Minor  Build  Revision

-----  -----  -----  --------

5      6      0      0
<!--NeedCopy-->

Description

Gets the current Citrix MachineCreation Service database schema version number.

Example 2 

C:\PS>Get-ProvInstalledDBVersion -Upgrade
<!--NeedCopy-->

Description

Get the versions of the MachineCreation Service database schema for which upgrade scripts are supplied.

Get-Provinstalleddbversion
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.