Citrix Virtual Apps and Desktops SDK

Reset-MonitorDataStore

Refreshes the database string currently being used by the Monitor service.

Syntax


Reset-MonitorDataStore [-DataStore] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Returns the string for the database connection currently being used by the Monitor Service. Can only be called for secondary data stores.

There is no requirement for a database connection to be configured in order for this command to be used.

Parameters

Name Description Required? Pipeline Input Default Value
DataStore Specifies the database connection logical name to be used by the Monitor Service. Can be either be ‘Site’ or the logical name of the secondary data store. Specifying the site data store will display an error because this operation is not supported for site data stores. true false Site
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
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.Servicestatus

The status of the specified data store.

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. ConfigurationLoggingError The operation could not be performed because of a configuration logging error. 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>Reset-MonitorDataStore -DataStore Secondary

OK

<!--NeedCopy-->

Description

Refresh the database connection string for the Monitor Service.

Reset-MonitorDataStore