Citrix StoreFront SDK PowerShell Modules

Set-STFStoreEnumerationOptions

March 5, 2024

Contributed by:

Set Store enumeration options

Syntax

Set-STFStoreEnumerationOptions [-StoreService] <StoreService> [[-EnhancedEnumeration] <Boolean>] [[-MaximumConcurrentEnumerations] <Int32>] [[-FilterByTypesInclude] <String[]>] [[-FilterByKeywordsInclude] <String[]>] [[-FilterByKeywordsExclude] <String[]>] [[-RequestFullIconData] <None | Full | FullAndMulti>] [[-PassThru] <SwitchParameter>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Set the Store options used when enumerating the XenApp and XenDesktop xml services.

Get-STFStoreEnumerationOptions

Parameters

Name	Description	Required?	Pipeline Input
StoreService	Store service	true	true (ByValue)
EnhancedEnumeration	Enable enhanced enumeration. Enumerate multiple farms in parallel to reduce operation time	false	false
MaximumConcurrentEnumerations	Maximum farms enumerated in parallel	false	false
FilterByTypesInclude	Inclusive resource filter by type (Applications, Desktops or Documents)	false	false
FilterByKeywordsInclude	Only include applications and desktops that match the keywords	false	false
FilterByKeywordsExclude	Exclude applications and desktops that match the keywords	false	false
RequestFullIconData	Request icon data (None, Full, FullAndMulti)	false	false
PassThru	The resulting Store Enumeration options	false	false

Input Type

Citrix.StoreFront.Model.Store.StoreService

Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service

System.Boolean

Parameter EnhancedEnumeration: The .NET System.Boolean value type

System.Int32

Parameter MaximumConcurrentEnumerations: The .NET System.Int32 value type

System.String[]

Parameter FilterByTypesInclude: The .NET System.String reference type

System.String[]

Parameter FilterByKeywordsInclude: The .NET System.String reference type

System.String[]

Parameter FilterByKeywordsExclude: The .NET System.String reference type

Citrix.StoreFront.Model.Store.RequestFullIconData

Parameter RequestFullIconData: The .NET Citrix.StoreFront.Model.Store.RequestFullIconData value type

System.Management.Automation.SwitchParameter

Parameter PassThru: The .NET System.Management.Automation.SwitchParameter value type

Return Values

None

Examples

EXAMPLE 1 Turn off enhanced enumeration options

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -EnhancedEnumeration $false
<!--NeedCopy-->

REMARKS

Turn off parallel enumeration of Store farms.

EXAMPLE 2 Filter by type

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -FilterByTypesInclude Applications
<!--NeedCopy-->

REMARKS

Filter resources to only show applications.

EXAMPLE 3 Filter by keyword (include)

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -FilterByKeywordsInclude @("AppSet1","AppSet2")
<!--NeedCopy-->

REMARKS

Only publish resources in the Store that have the keywords AppSet1 or Appset2.

EXAMPLE 4 Filter by keyword (exclude)

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -FilterByKeywordsExclude @("AppSet1","AppSet2")
<!--NeedCopy-->

REMARKS

Exclude resources from the store that have the keywords AppSet1 or Appset2

EXAMPLE 5 Filter by keyword (include and exclude)

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -FilterByKeywordsInclude @("AppSet1","AppSet2") -FilterByKeywordsExclude @("AppSet3","AppSet4")
<!--NeedCopy-->

REMARKS

Includes resources from the store that have the keywords AppSet1 or Appset2 and do not contain the keywords App3 or App4. It is not possible to use the same keyword for both Exclude and Include filtering.

EXAMPLE 6 Filter by keyword (clear)

$storeService = Get-STFStoreService
Set-STFStoreEnumerationOptions $storeService -FilterByKeywordsInclude "" -FilterByKeywordsExclude ""
<!--NeedCopy-->

REMARKS

Remove configured exclude or include keywords you have already set.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-STFStoreEnumerationOptions

March 5, 2024

Contributed by:

March 5, 2024

Contributed by:

Set-STFStoreEnumerationOptions

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.StoreService

System.Boolean

System.Int32

System.String[]

System.String[]

System.String[]

Citrix.StoreFront.Model.Store.RequestFullIconData

System.Management.Automation.SwitchParameter

Return Values

None

Examples

EXAMPLE 1 Turn off enhanced enumeration options

EXAMPLE 2 Filter by type

EXAMPLE 3 Filter by keyword (include)

EXAMPLE 4 Filter by keyword (exclude)

EXAMPLE 5 Filter by keyword (include and exclude)

EXAMPLE 6 Filter by keyword (clear)

In this article