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

March 11, 2024
Contributed by: 
C

Gets the current status of the ADIdentity Service on the controller.

Syntax


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

<!--NeedCopy-->

Detailed Description

Enables the status of the ADIdentity Service on the controller. The database connection to the service does not need to be configured before using this command.

Parameters

Name Description Required? Pipeline Input Default Value
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of 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 The address of a Citrix Virtual Apps and Desktops 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

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Fma.Sdk.Utilities.Service.Servicestatusinfo

The Get-AcctServiceStatus cmdlet returns an object describing the status of the ADIdentity Service together with extra diagnostics information.

  • ServiceStatus <string> The status of the ADIdentity Service instance. Possible ServiceStatus values are:

  • OK: The ADIdentity Service instance is configured with a valid database and service schema. The service is operational.

  • DBUnconfigured: No database connection string is set for the ADIdentity Service instance.

  • DBRejectedConnection: The database rejected the logon attempt from the ADIdentity 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 specified database does not exist, is not visible to the ADIdentity Service instance, or the service’s schema within the database is invalid.

  • DBNotFound: The specified database could not be located with the configured connection string.

  • DBNewerVersionThanService: The version of the ADIdentity Service currently in use is newer than, and incompatible with, the version of the ADIdentity Service schema on the database. Upgrade the ADIdentity Service to a more recent version.

  • DBOlderVersionThanService: The version of the ADIdentity Service schema on the database is newer than, and incompatible with, the version of the ADIdentity Service currently in use. Upgrade the database schema to a more recent version.

  • DBVersionChangeInProgress: A database schema upgrade is in progress.

  • PendingFailure: Connectivity between the ADIdentity Service instance 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 ADIdentity Service instance and the database has been lost for an extended period of time, or has failed due to a configuration problem. The service instance cannot operate while its connection to the database is unavailable.

  • Unknown: The status of the ADIdentity Service cannot be determined.

  • ExtraInfo <System.Collections.Generic.Dictionary[string, string]> Dictionary providing extra diagnostics information for the database identified by the connection string. It contains at least the following keys, and their associated string values:

  • Server.Version: Database server version number.

  • Server.IsClustered: “True” if the database server is clustered; “False” otherwise.

  • Database.Status: Status of the database. When operating normally, the value is “Normal”.

  • Database.RecoveryModel: Recovery model of the database (e.g. “Simple”).

  • Database.LastBackupDate: Date of the last backup of this database.

  • Database.IsReadCommittedSnapshotOn: “True” if the READ_COMMITTED_SNAPSHOT database option is enabled; “False” otherwise.

  • Database.Collation: Collation order of the database (e.g. “Latin1_General_100_CI_AS_KS”).

  • Database.IsMirroringEnabled: “True” if the database is mirrored; “False” otherwise.

  • Database.AvailabilityGroupName: The name of the availability group of which this database is a member. Beware that the corresponding values are always strings. Therefore, to test Boolean values, you must use statements like: if ($info[“Server.IsClustered”] == “True”) instead of just using: if ($info[“Server.IsClustered”]).

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.

Examples

Example 1 


C:\PS>Get-AcctServiceStatus

ServiceStatus  ExtraInfo

-------------- ---------

DBUnconfigured {...}

<!--NeedCopy-->

Description

Get the current status of the ADIdentity Service.

Get-AcctServiceStatus
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.