Gets a list of all available database schema versions for the Orchestration Service.
Get-OrchInstalledDBVersion [-Upgrade] [-Downgrade] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
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.
|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|
|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.|
You cannot pipe input into this cmdlet.
Get-OrchInstalledDBVersion returns database schema version numbers as requested.
Major <Integer> Minor <Integer> Build <Integer> Revision <Integer>
If the command fails, the following errors can be returned.
Both the Upgrade and Downgrade flags were specified.
The operation was successful but had no effect.
The database connection string for the Orchestration Service has not been specified.
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
You do not have permission to execute this command.
There was a problem communicating with the Citrix Delegated Administration Service.
There was a problem communicating with the remote service.
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.
PS C:\>Get-OrchInstalledDBVersion Major Minor Build Revision ----- ----- ----- -------- 5 6 0 0
Gets the current Citrix Orchestration Service database schema version number.
Get the versions of the Orchestration Service database schema for which upgrade scripts are supplied.