Set-VusDBConnection

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Configures a database connection for the VdaUpdateService Service.
Related information
about_VusVdaUpdateServiceSnapIn

Syntax

Set-VusDBConnection
   [-DBConnection] <String>
   [-Force]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Specifies the database connection string for use by the currently selected Citrix VdaUpdateService Service instance.
The service records the connection string and attempts to contact the specified database. If the database cannot initially be contacted the service retries the connection at intervals until contact with the database is successfully established.
Is is not possible to set a new database connection string for the service if one is already recorded. The connection string must first be set to \$null. This action causes the service to reset and return to its idle state, at which point a new connection string can be set.
When a database connection string is successfully set for the service, a status of OK is returned by the cmdlet. If the database connection string is set to \$null, a DBUnconfigured status is returned.
A syntactically invalid connection string is not recorded.
Only use of Windows authentication within the connection string is supported; a connection string containing SQL authentication credentials is always rejected as invalid.
The current service instance is the one on the local machine, or the one most recently specified using the -AdminAddress parameter of a VdaUpdateService SDK cmdlet.

Examples

EXAMPLE 1

Configures the service instance to use a database called XDDB on an SQL Server Express database running on the machine called dbserver. Integrated Windows authentication is required.
Set-VusDBConnection "Server=dbserver\SQLEXPRESS;Database=XDDB;Trusted_Connection=True"

EXAMPLE 2

Resets the service instance's database connection string. The service instance resets and returns to an idle state until a valid new database connection string is specified.
Set-VusDBConnection -DBConnection $null

Parameters

-DBConnection

Specifies the database connection string to be used by the VdaUpdateService Service. Passing in \$null will clear any existing database connection configured.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Force

If present, allows the local administrator to set the connection string to null when there are problems contacting the database or other services.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo

The Set-VusDBConnection cmdlet returns an object describing the status of the VdaUpdateService Service together with extra diagnostics information. Possible values are:
  • OK
    The VdaUpdateService Service instance is configured with a valid database and service schema. The service is operational.
  • DBUnconfigured
    No database connection string is set for the VdaUpdateService Service instance.
  • DBRejectedConnection
    The database rejected the logon attempt from the VdaUpdateService Service. This may be because the service attempted to log on with invalid credentials or because a database has not been installed in the specified location.
  • InvalidDBConfigured
    The specified database does not exist, is not visible to the VdaUpdateService Service instance, or the service's schema within the database is invalid.
  • DBNotFound
    The specified database could not be located with the configured connection string.
  • DBNewerVersionThanService
    The version of the VdaUpdateService Service currently in use is newer than, and incompatible with, the version of the VdaUpdateService Service schema on the database. Upgrade the VdaUpdateService Service to a more recent version.
  • DBOlderVersionThanService
    The version of the VdaUpdateService Service schema on the database is newer than, and incompatible with, the version of the VdaUpdateService Service currently in use. Upgrade the database schema to a more recent version.
  • DBVersionChangeInProgress
    A database schema upgrade is in progress.
  • PendingFailure
    Connectivity between the VdaUpdateService Service instance and the database has been lost. This may be a transitory network error, but may indicate a loss of connectivity that requires administrator intervention.
  • Failed
    Connectivity between the VdaUpdateService Service instance and the database has been lost for an extended period of time, or has failed due to a configuration problem. The service instance cannot operate while its connection to the database is unavailable.
  • Unknown
    The status of the VdaUpdateService Service cannot be determined.

Notes

If the command fails, the following errors can be returned:
  • InvalidDBConnectionString
    The database connection string has an invalid format.
  • DatabaseConnectionDetailsAlreadyConfigured
    There was already a database connection configured. After a configuration is set, it can only be set to \$null.
  • PermissionDenied
    You do not have permission to execute this command.
  • AuthorizationError
    There was a problem communicating with the Citrix Delegated Administration Service.
  • ConfigurationLoggingError
    The operation could not be performed because of a configuration logging error.
  • 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.