Citrix Daas SDK

Get-SfDBConnection

Gets the database connection string for the specified data store used by the Storefront Service.

Syntax

Get-SfDBConnection
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Gets the database connection string from the currently selected Storefront Service instance.

If the returned string is blank, no valid connection string has been specified. In this case the service is running, but is idle and awaiting specification of a valid connection string.

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

Gets the database connection string in use by the Storefront Service instance running on controller “controller1.mydomain.net”.

Get-SfDBConnection -AdminAddress controller1.mydomain.net
<!--NeedCopy-->

Parameters

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

String

The database connection string configured for the current Storefront Service instance.

Notes

If the command fails, the following errors can be returned.

Error Codes


NoDBConnections

The database connection string for the Storefront

Service has not been specified.

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 XenDesktop logs.

Get-SfDBConnection