Download full document:

# Get-OrchInstalledDBVersion

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

Syntax

Get-OrchInstalledDBVersion [-Upgrade] [-Downgrade] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Gets the current version number of the Citrix Orchestration 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-OrchDBVersionChangeScript 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
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-OrchInstalledDBVersion returns database schema version numbers as requested.
Major Minor Build Revision ## 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 Orchestration 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-OrchInstalledDBVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
5      6      0      0

Description
-----------
Gets the current Citrix Orchestration Service database schema version number.

EXAMPLE 2

C:\PS>Get-OrchInstalledDBVersion -Upgrade

Description
-----------
Get the versions of the Orchestration Service database schema for which upgrade scripts are supplied.