Citrix Virtual Apps and Desktops SDK

Get-MonitorDataStore

August 3, 2023

Contributed by:

Gets details for each of the Monitor data stores.

Syntax

Get-MonitorDataStore [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

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.

Reset-MonitorDataStore

Parameters

Name	Description	Required?	Pipeline Input	Default Value
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a Citrix Virtual Apps and Desktops 7 controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

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.

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.

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

<!--NeedCopy-->

Description

Get the database connection string for the Monitor Service.

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-MonitorDataStore

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-MonitorDataStore

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Monitor.Sdk.Datastoreconfiguration

Notes

Examples

Example 1

Description

In this article