Citrix Daas SDK

Get-MonitorDBConnection

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

Syntax

Get-MonitorDBConnection
   [[-DataStore] <String>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns the database connection string from the currently selected Monitor 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 that on the local machine, or that explicitly specified by the last usage of the -AdminAddress parameter to a Monitor SDK cmdlet.

Examples

EXAMPLE 1

Get the database connection string for the Monitor Service.

Get-MonitorDBConnection

Server=serverName\SQLEXPRESS;Initial Catalog = databaseName;  Integrated Security = True
<!--NeedCopy-->

Parameters

-DataStore

Specifies the logical name of the data store for the Monitor Service. Can be either be ‘Site’ or the logical name of the secondary data store.

Type: String
Position: 2
Default value: Site
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

String

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

Notes

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

Error Codes


NoDBConnections

The database connection string for the Monitor

Service has not been specified.

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

DataStoreException

An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

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

Get-MonitorDBConnection