Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-MonitorDBConnection

March 11, 2024
Contributed by: 
C

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

Syntax

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

Description

Gets 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 the one on the local machine, or the one most recently specified using the -AdminAddress parameter of a Monitor SDK cmdlet.

Examples

EXAMPLE 1

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

Get-MonitorDBConnection -AdminAddress controller1.mydomain.net
<!--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:

  • NoDBConnections

    The database connection string for the MonitorService 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 XenDesktop logs.

Get-MonitorDBConnection
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.