-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
Get-ConfigScopedObject
-
-
-
-
-
-
-
-
-
-
-
-
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-ConfigScopedObject
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Gets the details of the scoped objects for the Configuration Service.
Syntax
Get-ConfigScopedObject
[-Description <String>]
[-ObjectId <String>]
[-ObjectName <String>]
[-ObjectType <ScopedObjectType>]
[-ScopeId <Guid>]
[-ScopeName <String>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Returns a list of directly scoped objects including the names and identifiers of both the scope and object as well as the object description for display purposes. There will be at least one result for every directly scoped object. When an object is associated with multiple scopes the output contains one result per scope duplicating the object details. No records are returned for the All scope.
Examples
EXAMPLE 1
Gets all of the scoped objects with type Zone. The example output shows a zone object (zone1) in two scopes Sales and Finance, and another zone (zone2) that is in scope any.
C:\> Get-ConfigScopedObject -ObjectType Zone
ScopeId : eff6f464-f1ee-4442-add3-99982e0cec01
ScopeName : Sales
ObjectType : Zone
ObjectId : cd4174ee-9e4b-4e57-b126-9dbf757fe493
ObjectName : zone1
Description : Test zone1
ScopeId : 304e0fa7-d390-47f0-a94f-7e956a324c41
ScopeName : Finance
ObjectType : Zone1
ObjectId : cd4174ee-9e4b-4e57-b126-9dbf757fe493
ObjectName : zone1
Description : Test zone1
ScopeId : bb6cb365-909d-468e-8895-061a3e910b95
ScopeName : any
ObjectType : Zone
ObjectId : 5062e46b-71bc-4ac9-901a-30fe6797e2f6
ObjectName : zone2
Description : Another zone in scope any
<!--NeedCopy-->
Parameters
-Description
Gets scoped object entries for objects with the specified description.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ObjectId
Gets scoped object entries for objects with the specified object identifier.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ObjectName
Gets scoped object entries for objects with the specified object name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ObjectType
Gets scoped object entries for objects of the given type.
| Type: | ScopedObjectType |
| Accepted values: | Zone |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeId
Gets scoped object entries for the given scope identifier.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeName
Gets scoped object entries with the given scope name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-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 |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -SkipCertificateValidation, -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.Config.Sdk.ScopedObject
This represents a scoped object and has the following properties: ScopeId <Guid?>The unique identifier of the scope.ScopeName <String>The display name of the scope.ObjectType <ScopedObjectType>The type of the object this entry relates to.ObjectId <String>The unique identifier of the object.ObjectName <String>The display name of the object.Description <String>The description of the object (possibly $null if the object type does not have a description).
Notes
In the case of failure, the following errors can result.
Error Codes ———– PartialData
Only a subset of the available data was returned.
CouldNotQuueryDatabase
The query required to get the database was not defined.
CommunicationError
An error occurred while communicating with the service.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown
An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop 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.