-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Set-SfDBConnection
-
-
-
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!
Set-SfDBConnection
Configures a database connection for the Storefront Service.
Syntax
Set-SfDBConnection
[-DBConnection] <String>
[-Force]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Specifies the database connection string for use by the currently selected Citrix Storefront 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 Storefront 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-SfDBConnection "Server=dbserver\SQLEXPRESS;Database=XDDB;Trusted_Connection=True"
<!--NeedCopy-->
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-SfDBConnection -DBConnection $null
<!--NeedCopy-->
Parameters
-DBConnection
Specifies the database connection string to be used by the Storefront 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 |
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-SfDBConnection cmdlet returns an object describing the status of the Storefront Service together with extra diagnostics information. Possible values are:
-
OK
The Storefront Service instance is configured with a valid database and service schema. The service is operational.
-
DBUnconfigured
No database connection string is set for the Storefront Service instance.
-
DBRejectedConnection
The database rejected the logon attempt from the Storefront 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 Storefront 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 Storefront Service currently in use is newer than, and incompatible with, the version of the Storefront Service schema on the database. Upgrade the Storefront Service to a more recent version.
-
DBOlderVersionThanService
The version of the Storefront Service schema on the database is newer than, and incompatible with, the version of the Storefront 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 Storefront 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 Storefront 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 Storefront 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.
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.