-
-
-
-
-
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
[[-Name] <String>]
[-DirectChildAdminFolders <Int32>]
[-DirectChildApplicationGroups <Int32>]
[-DirectChildApplications <Int32>]
[-DirectChildCatalogs <Int32>]
[-DirectChildDesktopGroups <Int32>]
[-FolderName <String>]
[-LastChangeId <Guid>]
[-Metadata <String>]
[-ParentAdminFolderUid <Int32>]
[-TotalChildApplicationGroups <Int32>]
[-TotalChildApplications <Int32>]
[-TotalChildCatalogs <Int32>]
[-TotalChildDesktopGroups <Int32>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerAdminFolder
[-Uid] <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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
-
DirectChildApplicationGroups (System.Int32)
The number of application groups in this admin folder (does not include any application groups in child folders)
-
DirectChildApplications (System.Int32)
The number of applications in this admin folder (does not include any applications in child folders)
-
DirectChildCatalogs (System.Int32)
The number of catalogs in this admin folder (does not include any catalogs in child folders)
-
DirectChildDesktopGroups (System.Int32)
The number of desktop groups in this admin folder (does not include any desktop groups 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)
-
TotalChildApplicationGroups (System.Int32)
The number of application groups in this admin folder (including any application groups in child folders)
-
TotalChildApplications (System.Int32)
The number of applications in this admin folder (including any applications in child folders)
-
TotalChildCatalogs (System.Int32)
The number of catalogs in this admin folder (including any catalogs in child folders)
-
TotalChildDesktopGroups (System.Int32)
The number of desktop groups in this admin folder (including any desktop groups in child folders)
-
Uid (System.Int32)
The unique ID of the admin folder (the root folder has the value zero)
Examples
EXAMPLE 1
Return all administration folders.
Get-BrokerAdminFolder
<!--NeedCopy-->
EXAMPLE 2
Get the administration folder with Uid 1.
Get-BrokerAdminFolder -Uid 1
<!--NeedCopy-->
Parameters
-Uid
Gets only the admin folder with the specified unique identifier.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Gets admin folders matching the specified name (if no trailing backslash is supplied, it is assumed).
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DirectChildAdminFolders
Gets admin folders with the specified number of child folders.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectChildApplicationGroups
Gets admin folders with the specified number of application groups (excluding those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectChildApplications
Gets admin folders with the specified number of applications (excluding those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectChildCatalogs
Gets admin folders with the specified number of catalogs (excluding those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectChildDesktopGroups
Gets admin folders with the specified number of desktop groups (excluding those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FolderName
Gets only the admin folders matching the specified simple folder name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-LastChangeId
Gets only the admin folders with the specified value for LastChangeId.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ParentAdminFolderUid
Gets only admin folders with the specified parent admin folder UID value.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TotalChildApplicationGroups
Gets admin folders with the specified number of application groups (including those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TotalChildApplications
Gets admin folders with the specified number of applications (including those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TotalChildCatalogs
Gets admin folders with the specified number of catalogs (including those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TotalChildDesktopGroups
Gets admin folders with the specified number of desktop groups (including those in sub-folders).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| 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_Broker_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 |
-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 |
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
Input cannot be piped to this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.AdminFolder
Returns admin folders.
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.