-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
Get-ConfigService
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-ConfigService
Gets the service record entries for the Configuration Service.
Syntax
Get-ConfigService
[-Metadata <String>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Returns instances of the Configuration Service that the service publishes. The service records contain account security identifier information that can be used to remove each service from the database.
A database connection for the service is required to use this command.
Examples
EXAMPLE 1
Get all the instances of the Configuration Service running in the current service group.
Get-ConfigService
Uid : 1
ServiceHostId : aef6f464-f1ee-4042-a523-66982e0cecd0
DNSName : MyServer.company.com
MachineName : MYSERVER
CurrentState : On
LastStartTime : 04/04/2011 15:25:38
LastActivityTime : 04/04/2011 15:33:39
OSType : Win32NT
OSVersion : 6.1.7600.0
ServiceVersion : 5.1.0.0
DatabaseUserName : NT AUTHORITY\NETWORK SERVICE
Sid : S-1-5-21-2316621082-1546847349-2782505528-1165
ActiveSiteServices : {MySiteService1, MySiteService2...}
<!--NeedCopy-->
Parameters
-Metadata
Gets records with matching metadata entries.
The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Config_Filtering for details.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
Type: | Int32 |
Position: | Named |
Default value: | 250 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
Type: | String |
Position: | Named |
Default value: | The default sort order is by name or unique identifier. |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell-style filter expression. See about_Config_Filtering for details.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
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.Configuration.Sdk.Service
The Get-ConfigServiceInstance command returns an object containing the following properties.
-
Uid <Integer>
Specifies the unique identifier for the service in the group. The unique identifier is an index number.
-
ServiceHostId <Guid>
Specifies the unique identifier for the service instance.
-
DNSName <String>
Specifies the domain name of the host on which the service runs.
-
MachineName <String>
Specifies the short name of the host on which the service runs.
-
CurrentState <Citrix.Fma.Sdk.ServiceCore.ServiceState>
Specifies whether the service is running, started but inactive, stopped, or failed.
-
LastStartTime <DateTime>
Specifies the date and time at which the service was last restarted.
-
LastActivityTime <DateTime>
Specifies the date and time at which the service was last stopped or restarted.
-
OSType
Specifies the operating system installed on the host on which the service runs.
-
OSVersion
Specifies the version of the operating system installed on the host on which the service runs.
-
ServiceVersion
Specifies the version number of the service instance. The version number is a string that reflects the full build version of the service.
-
DatabaseUserName <string>
Specifies the Active Directory account name with permissions to access the database for this service instance. This will be either the machine account or, if the database is running on a controller, the NetworkService account.
-
Sid <string>
Specifies the Active Directory account security identifier for the machine on which the service instance is running.
-
ActiveSiteServices <string[]>
Specifies the names of active site services currently running in the service. Site services are components that perform long-running background processing in some services. This field is empty for services that do not contain site services.
Notes
If the command fails, the following errors can be returned:
-
UnknownObject
One of the specified objects was not found.
-
PartialData
Only a subset of the available data was returned.
-
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
-
CouldNotQueryDatabase
The query required to get the database was not defined.
-
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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.