Get-MonitorServiceStatus

Last published : Oct 31, 2026
Gets the current status of the Monitor Service on the controller.
Related information
about_MonitorMonitorSnapIn

Syntax

Get-MonitorServiceStatus
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Enables the status of the Monitor Service on the controller to be determined. If the service has multiple data stores it will return the overall state as an aggregate of all the data store states. For example, if the site data store status is OK and the secondary data store status is DBUnconfigured then it will return DBUnconfigured.
Before using this cmdlet, you don't have to configure the database connection for the Service.

Examples

EXAMPLE 1

Get the current status of the Monitor Service.
Get-MonitorServiceStatus

ServiceStatus  ExtraInfo
-------------- ---------
DBUnconfigured {...}

Parameters

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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 can't pipe objects to this cmdlet.

Outputs

Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo

The Get-MonitorServiceStatus cmdlet returns an object containing the status of the Monitor Service together with extra diagnostics information.
  • DBUnconfigured
    The Monitor Service does not have a database connection configured.
  • DBRejectedConnection
    The database rejected the logon attempt from the Monitor Service. This may be because the service attempted to log on with invalid credentials or because a database has not been installed in the specified location.
  • InvalidDBConfigured
    The expected stored procedures are missing from the database. This may be because the Monitor Service schema has not been added to the database.
  • DBNotFound
    The specified database could not be located with the configured connection string.
  • DBMissingOptionalFeature
    The Monitor is connected to a database that is valid, but it does not have the full functionality required for optimal performance. Upgrading the database is advisable.
  • DBMissingMandatoryFeature
    The Monitor is connected to a database that is valid, but it does not have the full functionality required so the Monitor cannot function. Upgrading the database is required.
  • DBNewerVersionThanService
    The version of the Monitor Service currently in use is incompatible with the version of the Monitor Service schema on the database. Upgrade the Monitor Service to a more recent version.
  • DBOlderVersionThanService
    The version of the Monitor Service schema on the database is incompatible with the version of the Monitor Service currently in use. Upgrade the database schema to a more recent version.
  • DBVersionChangeInProgress
    A database schema upgrade is currently in progress.
  • OK
    The Monitor Service is running and is connected to a database containing a valid schema.
  • PendingFailure
    Connectivity between the Monitor Service and the database has been lost. This may be a transitory network error, but may indicate a loss of connectivity that requires administrator intervention.
  • Failed
    Connectivity between the Monitor and the database has been lost for an extended period of time, or has failed due to a configuration problem. The Monitor service cannot operate while its connection to the database is unavailable.
  • Unknown
    The service status cannot be determined.

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