Get-ConfigInstalledDBVersion

Last published : Oct 31, 2026
Gets a list of all available database schema versions for the Configuration Service.
Related information
about_ConfigConfigurationSnapIn

Syntax

Get-ConfigInstalledDBVersion
   [-Upgrade]
   [-Downgrade]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Gets the current version number of the Citrix Configuration 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-ConfigDBVersionChangeScript 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.

Examples

EXAMPLE 1

Gets the current Citrix Configuration Service database schema version number.
Get-ConfigInstalledDBVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
7      40     0      0

EXAMPLE 2

Get the versions of the Configuration Service database schema for which upgrade scripts are supplied.
Get-ConfigInstalledDBVersion -Upgrade

Major  Minor  Build  Revision
-----  -----  -----  --------
7      41     0      0

Parameters

-Upgrade

Specifies that only schema versions to which the current database version can be upgraded should be returned.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Downgrade

Specifies that only schema versions to which the current database version can be downgraded should be returned.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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 cannot pipe input into this cmdlet.

Outputs

Get-ConfigInstalledDBVersion returns database schema version numbers as requested.

Notes

If the command fails, the following errors can be returned:
  • 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 Configuration 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 Citrix Virtual Apps and Desktops logs.