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

Get-Brokercatalog

August 3, 2023
Contributed by: 
C

Gets catalogs configured for this site.

Syntax

Get-BrokerCatalog [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Get-BrokerCatalog [[-Name] <String>] [-AdminFolderName <String>] [-AdminFolderUid <Int32>] [-AllocationType <AllocationType>] [-AppDnaAnalysisState <AppDnaAnalysisState>] [-AssignedCount <Int32>] [-AvailableAssignedCount <Int32>] [-AvailableCount <Int32>] [-AvailableUnassignedCount <Int32>] [-CatalogName <String>] [-Description <String>] [-HypervisorConnectionUid <Int32>] [-IsRemotePC <Boolean>] [-MachinesArePhysical <Boolean>] [-Metadata <String>] [-MinimumFunctionalLevel <FunctionalLevel>] [-PersistUserChanges <PersistUserChanges>] [-ProvisioningSchemeId <Guid>] [-ProvisioningType <ProvisioningType>] [-PvsAddress <String>] [-PvsDomain <String>] [-RemotePCDesktopGroupPriority <Int32>] [-RemotePCDesktopGroupUid <Int32>] [-RemotePCHypervisorConnectionUid <Int32>] [-ScopeId <Guid>] [-ScopeName <String>] [-SessionSupport <SessionSupport>] [-Tag <String>] [-TenantId <Guid>] [-UnassignedCount <Int32>] [-UsedCount <Int32>] [-UUID <Guid>] [-ZoneHealthy <Boolean>] [-ZoneName <String>] [-ZoneUid <Guid>] [-MachineUid <Int32>] [-TagUid <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

Retrieves catalogs matching the specified criteria. If no parameters are specified this cmdlet enumerates all catalogs.

See about_Broker_Filtering for information about advanced filtering options.

Brokercatalog Object

The catalog object returned represents a group of related physical or virtual machines that have been configured in the site.

See about_Broker_Machines for more information.

  • AdminFolderName (System.String) The name of the admin folder the catalog is in (including trailing backslash), or the empty string if the catalog is at the root level

  • AdminFolderUid (System.Int32) The Uid of the admin folder the catalog is in (if any)

  • AllocationType (Citrix.Broker.Admin.SDK.AllocationType) Denotes how the the machines in the catalog are allocated to a user. Possible values are:

    • Static: Machines get assigned to a user either by the admin or on first use. This relationship is static and changes only if an admin explicitly changes the assignments.
    • Random: Machines are allocated to users randomly from a pool of available machines.

  • AppDnaAnalysisState (Citrix.Broker.Admin.SDK.AppDnaAnalysisState?) The AppDNA Analysis State of the catalog

  • AssignedCount (System.Int32) The number of assigned machines (machines that have been assigned to a user/users or a client name/address).

  • AvailableAssignedCount (System.Int32) The number of available machines (not in a desktop group), that are also assigned to users.

  • AvailableCount (System.Int32) The number of available machines (those not in any desktop group).

  • AvailableUnassignedCount (System.Int32) The number of available machines (those not in any desktop group) that are not assigned to users.

  • CatalogName (System.String) Name of the catalog (must be unique within a Folder)

  • Description (System.String) Description of the catalog.

  • HypervisorConnectionUid (System.Int32?) The Uid of the hypervisor connection that is associated with the machines in the catalog. This property only applies to MCS provisioned catalogs. For other provisioning types machines can be from one or more different hypervisor connections.

  • IsRemotePC (System.Boolean) Specifies whether or not the catalog is a RemotePC catalog. Remote PC catalogs automatically configure appropriate machines without the need for manual configuration. See about_Broker_RemotePC for more information.

  • MachinesArePhysical (System.Boolean) Specifies whether or not the machines in the catalog can be power-managed by the broker.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>) Holds any metadata associated with the catalog.

  • MinimumFunctionalLevel (Citrix.Broker.Admin.SDK.FunctionalLevel) The expected minimal functional level of the machines in the catalog.

  • Name (System.String) Name of the catalog.

  • PersistUserChanges (Citrix.Broker.Admin.SDK.PersistUserChanges) Specifies how user changes are persisted on machines in the catalog. Possible values are:

    • OnLocal: User changes are stored on the machine’s local storage.
    • Discard: User changes are discarded.

  • ProvisioningSchemeId (System.Guid?) The GUID of the provisioning scheme (if any) associated with the catalog. This only applies if the provisioning type is MCS.

  • ProvisioningType (Citrix.Broker.Admin.SDK.ProvisioningType) Specifies how the machines are provisioned in the catalog. Possible values are:

    • Manual: No provisioning.
    • PVS: Machine provisioned by PVS (machine may be physical, blade, VM…)
    • MCS: Machine provisioned by MCS (machine must be a VM).

  • PvsAddress (System.String) IP address of the PVS server to be used in a catalog with a PVS ProvisioningType.

  • PvsDomain (System.String) The domain of the PVS server to be used in a catalog with a PVS ProvisioningType.

  • RemotePCDesktopGroupPriorities (System.Int32[]) Remote PC desktop groups’ association priorities.

  • RemotePCDesktopGroupUids (System.Int32[]) UIDs of the Remote PC desktop groups associated with this catalog.

  • RemotePCHypervisorConnectionUid (System.Int32?) UID of the hypervisor connection used for powering on RemotePC machines in this catalog (only for catalogs with IsRemotePC set to true).

  • Scopes (Citrix.Fma.Sdk.DelegatedAdminInterfaces.ScopeReference[]) The list of the delegated admin scopes to which the catalog belongs.

  • SessionSupport (Citrix.Broker.Admin.SDK.SessionSupport) Specifies the session support of the machines in the catalog. Valid values are: SingleSession, MultiSession.

  • Tags (System.String[]) Tags associated with the catalog.

  • TenantId (System.Guid?) Identity of tenant associated with catalog. Not applicable (always blank) in non-multitenant sites.

  • Uid (System.Int32) Uid of the catalog.

  • UnassignedCount (System.Int32) The number of unassigned machines (machines not assigned to users).

  • UsedCount (System.Int32) The number of machines in the catalog that are in a desktop group.

  • UUID (System.Guid) The global ID of the catalog.

  • ZoneHealthy (System.Boolean?) Health state of the Zone associated with this catalog.

  • ZoneName (System.String) Name of the Zone associated with this catalog.

  • ZoneUid (System.Guid) Uid of the Zone associated with this catalog.

Parameters

Name Description Required? Pipeline Input Default Value
Uid Get catalogs with the specified UID. true false  
Name Gets catalogs with the specified name. false false  
AdminFolderName Gets catalogs that are in admin folders matching the specified name. false false  
AdminFolderUid Gets catalogs that are in the specified admin folder. false false  
AllocationType Gets catalogs that are of the specified allocation type. Values can be      

o Static - Machines in a catalog of this type are permanently assigned to a user.
o Permanent - equivalent to ‘Static’.
o Random - Machines in a catalog of this type are picked at random and temporarily assigned to a user. | false | false | | | AppDnaAnalysisState | Gets catalogs that have of the specified AppDNA Analysis State. Values can be:
o None - No AppDNA analysis has not been preformed.
o Capturing - AppDNA analysis is running and capturing infomation from a catalog machine.
o Canceled - The AppDNA analysis process was cancelled.
o Ready - The AppDNA analysis process has finished correctly.
o Failed - The AppDNA analysis process failed.
o Importing - AppDNA analysis is running and uploading results to the AppDNA server. | false | false | | | AssignedCount | Gets catalogs containing a specified number of assigned machines (machines that have been assigned to users).
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | AvailableAssignedCount | Gets catalogs containing a specified number of available machines (those not in any desktop group) that are also assigned to users.
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | AvailableCount | Gets catalogs containing a specified number of available machines (those not in any desktop group).
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | AvailableUnassignedCount | Gets catalogs containing a specified number of available machines (those not in any desktop group) that are not assigned to users.
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | CatalogName | Gets Catalogs that match the specified simple name. | false | false | | | Description | Gets catalogs with the specified description. | false | false | | | HypervisorConnectionUid | Gets catalogs associated with the specified hypervisor connection. | false | false | | | IsRemotePC | Gets catalogs with the specified IsRemotePC value. | false | false | | | MachinesArePhysical | Specifies whether machines in the catalog can be power-managed by the Citrix Broker Service. Where the Citrix Broker Service cannot control the power state of the machine specify $true, otherwise $false. Can only be specified together with a provisioning type of Pvs or Manual, or if used with the legacy CatalogKind parameter only with a Pvs catalog kind. | 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 | | | MinimumFunctionalLevel | Gets catalogs with a specific MinimumFunctionalLevel.
Valid values are L5, L7, L7_6, L7_7, L7_8, L7_9, L7_20, L7_25 | false | false | | | PersistUserChanges | Gets catalogs with the specified behavior when persisting changes made by the end user. Possible values are:
o OnLocal - User changes are stored on the machine’s local storage.
o Discard - User changes are discarded. | false | false | | | ProvisioningSchemeId | Gets catalogs associated with the specified provisioning scheme. | false | false | | | ProvisioningType | Specifies the provisioning type for the catalog. Values can be:
o Manual - No provisioning.
o PVS - Machine provisioned by PVS (machine may be physical, blade, VM,…).
o MCS - Machine provisioned by MCS (machine must be VM). | false | false | | | PvsAddress | Gets catalogs containing machines provided by the Provisioning Services server with the specified address. | false | false | | | PvsDomain | Gets catalogs containing machines provided by the Provisioning Services server in the specified domain. | false | false | | | RemotePCDesktopGroupPriority | Gets Remote PC catalogs with a Remote PC desktop group association with the specified priority. | false | false | | | RemotePCDesktopGroupUid | Gets Remote PC catalogs associated with the specified Remote PC desktop group. | false | false | | | RemotePCHypervisorConnectionUid | Gets Remote PC catalogs associated with the specified Remote PC hypervisor connection. | false | false | | | ScopeId | Gets catalogs that are associated with the given scope identifier. | false | false | | | ScopeName | Gets catalogs that are associated with the given scope name. | false | false | | | SessionSupport | Gets catalogs that have the specified session capability. Values can be:
o SingleSession - Single-session only machine.
o MultiSession - Multi-session capable machine. | false | false | | | Tag | Gets catalogs tagged with the specified tag. | false | false | | | TenantId | Gets catalogs associated with the specified tenant identity. | false | false | | | UnassignedCount | Gets catalogs containing a specified number of unassigned machines (machines not assigned to users).
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | UsedCount | Gets catalogs containing a specified number of machines used in a desktop group.
This property is typically used with advanced filtering; see [about_Broker_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html). | false | false | | | UUID | Get catalogs with the specified global ID. | false | false | | | ZoneHealthy | Gets catalogs located in the zone with the specified health state. | false | false | | | ZoneName | Gets catalogs located in the zone with the specified name. | false | false | | | ZoneUid | Gets machines located in the zone with the specified UID. | false | false | | | MachineUid | Gets the catalog containing the machine referenced by the specified unique identifier (UID). | false | false | | | TagUid | Gets catalogs to which the specified tag (identified by its Uid) has been added to help identify it - see Add-BrokerTag for more information. | 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](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html) 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](/en-us/citrix-virtual-apps-desktops-sdk/2112/Broker/about_Broker_Filtering.html) 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

Return Values

Citrix.Broker.Admin.Sdk.Catalog

Get-BrokerCatalog returns an object for each matching catalog.

Examples

Example 1 

C:\PS> Get-BrokerCatalog -AllocationType Random

C:\PS> Get-BrokerCatalog -Filter { AllocationType  -eq 'Random'}
<!--NeedCopy-->

Description

These commands return all catalogs containing machines that are randomly assigned to users. The second form uses advanced filtering (see about_Broker_Filtering).

Example 2 

C:\PS> Get-BrokerCatalog -Filter { AvailableCount  -gt 10}
<!--NeedCopy-->

Description

This command returns catalogs with more than 10 unused machines that are available for assignment to users.

Example 3 

C:\PS> Get-BrokerCatalog -MaxRecordCount 1 -ProvisioningType Manual -SortBy '-AvailableCount'
<!--NeedCopy-->

Description

This command returns the unmanaged catalog with the highest number of available machines.

Get-Brokercatalog
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

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