Citrix Virtual Apps and Desktops SDK

Get-AdminDBConnection

August 9, 2024

Contributed by:

Returns the database connection string for the specified data store used by the DelegatedAdmin Service.

Syntax

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

Description

Returns the database connection string from the currently selected DelegatedAdmin 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 DelegatedAdmin SDK cmdlet.

Examples

EXAMPLE 1

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

Get-AdminDBConnection -AdminAddress controller1.mydomain.net
Server=serverName\SQLEXPRESS;Initial Catalog=databaseName;Integrated Security=True
<!--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 DelegatedAdmin Service instance.

Notes

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

NoDBConnections

The database connection string for the DelegatedAdminService 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 Citrix Virtual Apps and Desktops logs.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-AdminDBConnection

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-AdminDBConnection

Syntax

Description

Examples

EXAMPLE 1

Parameters

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

String

Notes

Related Links

In this article