-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
Test-ConfigDBConnection
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Test-ConfigDBConnection
Tests whether a database is suitable for use by the Citrix Configuration Service.
Syntax
Test-ConfigDBConnection
[-DBConnection] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Test-ConfigDBConnection
[-DBConnection] <String>
[-Credentials] <PSCredential>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Test-ConfigDBConnection
[-DBConnection] <String>
[-Login] <String>
[-Password] <SecureString>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Tests whether the database specified in the given connection string is suitable for use by the currently selected Citrix Configuration Service instance.
The service attempts to contact the specified database and returns a status indicating whether the database is both contactable and usable. The test does not impact any currently established connection from the service instance to another database in any way. The tested 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 Configuration SDK cmdlet.
Examples
EXAMPLE 1
Tests whether the service instance could use a database called XDDB on an SQL Server Express database running on the machine called dbserver. Integrated Windows authentication is required.
Test-ConfigDBConnection "Server=dbserver\SQLEXPRESS;Database=XDDB;Trusted_Connection=True"
<!--NeedCopy-->
Parameters
-DBConnection
Specifies the database connection string to be tested by the currently selected Citrix Configuration Service instance.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credentials
If using SQL authentication, a PSCredential object containing the SQL credentials to be used. This can be created using the Get-Credential cmdlet. The credentials required are the SQL server login and its associated password. By default Windows authentication is used and no credentials need to be specified.
| Type: | PSCredential |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Login
If using SQL authentication, the SQL server login to use. By default Windows authentication is used and no login needs to be specified.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Password
If using SQL authentication, the SQL server password to use. By default Windows authentication is used and no password needs to be specified.
| Type: | SecureString |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| 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 |
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 can’t pipe objects to this cmdlet.
Outputs
Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo
The Test-ConfigDBConnection cmdlet returns an object describing the status of the selected Configuration Service instance that would result if the connection string were used with the Set-ConfigDBConnection cmdlet together with extra diagnostics information for the specified connection string. The actual current status of the service is not changed. Possible diagnostic values are:
- OK:
The Set-ConfigDBConnection command would succeed if it were executed with the supplied connection string.
- DBUnconfigured:
No database connection string is set for the service instance.
- DBRejectedConnection:
The database rejected the logon attempt from the Configuration Service instance. 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 Configuration Service instance, or the service’s schema within the database is invalid.
- DBNotFound:
The specified database could not be located with the given connection string.
- DBNewerVersionThanService:
The Configuration Service instance is older than, and incompatible with, the service’s schema in the database. The service instance needs upgrading.
- DBOlderVersionThanService:
The Configuration Service instance is newer than, and incompatible with, the service’s schema in the database. The database schema needs upgrading.
- DBVersionChangeInProgress:
A database schema upgrade is currently in progress.
- PendingFailure:
Connectivity between the Configuration 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 Configuration 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:
Service status cannot be determined.
Notes
If the command fails, the following errors can be returned.
Error Codes
InvalidDBConnectionString
The database connection string has an invalid format.
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 XenDesktop logs.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.