-
-
-
-
-
Get-BrokerAdminFolder
-
-
-
-
-
-
-
-
-
-
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-Brokeradminfolder
Get the admin folders in this site.
Syntax
Get-BrokerAdminFolder [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Get-BrokerAdminFolder [[-Name] <String>] [-DirectChildAdminFolders <Int32>] [-DirectChildApplications <Int32>] [-FolderName <String>] [-LastChangeId <Guid>] [-Metadata <String>] [-ParentAdminFolderUid <Int32>] [-TotalChildApplications <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
The Get-BrokerAdminFolder cmdlet gets admin folders in this site.
Without parameters, Get-BrokerAdminFolder gets all the admin folders that have been created. You can also use the parameters of Get-BrokerAdminFolder to filter the results to just the folders you’re interested in. You can also identify folders by their UIDs or their FolderNames.
Brokeradminfolder Object
A folder for use in the administration console for organising other objects. E.g. BrokerApplication objects
-
DirectChildAdminFolders (System.Int32) The number of admin folders with this folder as a direct parent
-
DirectChildApplications (System.Int32) The number of applications in this admin folder (does not include any applications in child folders)
-
FolderName (System.String) The simple name of this folder within any parent folder
-
LastChangeId (System.Guid) A random GUID assigned whenever there is a change anywhere in the hierarchy of admin folders below this node; each change updates this value on the changed folder and all parents all the way up to the root folder. Note that nodes below any change do not have their LastChangeId value updated
-
MetadataMap (System.Collections.Generic.Dictionary<string, string>) Holds any metadata associated with the admin folder
-
Name (System.String) The full name of the folder including the full parent hierarchy separated by back-slash characters and including a trailing back-slash
-
ParentAdminFolderUid (System.Int32) The UID of the parent admin folder; the root folder references itself (zero)
-
TotalChildApplications (System.Int32) The number of applications in this admin folder (including any applications in child folders)
-
Uid (System.Int32) The unique ID of the admin folder (the root folder has the value zero)
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Uid | Gets only the admin folder with the specified unique identifier. | true | false | |
| Name | Gets admin folders matching the specified name (if no trailing backslash is supplied, it is assumed). | false | false | |
| DirectChildAdminFolders | Gets admin folders with the specified number of child folders. | false | false | |
| DirectChildApplications | Gets admin folders with the specified number of applications (excluding those in sub-folders). | false | false | |
| FolderName | Gets only the admin folders matching the specified simple folder name. | false | false | |
| LastChangeId | Gets only the admin folders with the specified value for LastChangeId. | false | false | |
| 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”. | false | false | ||
| ParentAdminFolderUid | Gets only admin folders with the specified parent admin folder UID value. | false | false | |
| TotalChildApplications | Gets admin folders with the specified number of applications (including those in sub-folders). | false | false | |
| ReturnTotalRecordCount | When specified, this causes the cmdlet to output 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_Broker_Filtering for details. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| 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. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | 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. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| 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 |
Input Type
None
Input cannot be piped to this cmdlet.
Return Values
Citrix.Broker.Admin.Sdk.Adminfolder
Returns admin folders.
Examples
Example 1
C:\PS> Get-BrokerAdminFolder
<!--NeedCopy-->
Description
Return all administration folders.
Example 2
C:\PS> Get-BrokerAdminFolder -Uid 1
<!--NeedCopy-->
Description
Get the administration folder with Uid 1.
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.