Product Documentation

Get-MonitorDataStore

Nov 11, 2015

Gets details for each of the Monitor data stores.

Syntax

Get-MonitorDataStore [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Returns an object for each of the Monitor data stores describing the connection string, data store name, db type, provider, schema name, and DB status.

A database connection must be configured in order for this command to be used if the service has a secondary data store. This is not required for the site data store.

Related topics

Reset-MonitorDataStore

Parameters

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Return Values

Citrix.Monitor.Sdk.DataStoreConfiguration

An object describing the connection string, data store name, database type, provider, schema name and database status.

Notes

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

Error Codes

-----------

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.

Examples

-------------------------- EXAMPLE 1 --------------------------

c:\PS>Get-MonitorDataStore 
 
ConnectionString : Server=.\SQLEXPRESS;Initial Catalog = databaseName; Integrated Security = True 
DataStore        : Site 
DatabaseType     : SqlServer 
Provider         : MSSQL 
SchemaName       : MonitorSiteSchema 
Status           : OK 
 
ConnectionString : 
DataStore        : Secondary 
DatabaseType     : SqlServer 
Provider         : MSSQL 
SchemaName       : MonitorSecondarySchema 
Status           : DBUnconfigured

Get the database connection string for the Monitor Service.