Developer Documentation
Citrix Virtual Apps and Desktops 2402 SDK
Current Release 2303 2212 2209 2206 2203 2112 2109 2103 1912

Get-BrokerAdminFolder

April 19, 2024
Contributed by: 
C

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.

Get-BrokerAdminFolder
April 19, 2024
Contributed by: 
C
April 19, 2024
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.