Citrix StoreFront SDK PowerShell Modules

Get-STFUserFarmMapping

June 27, 2023

Contributed by:

Get the UserFarmMappings for a Store

Syntax

Get-STFUserFarmMapping [-StoreService] <StoreService> [[-Name] <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Get the UserFarmMappings configured for a Store or a specific UserFarmMapping matching the supplied name.

Parameters

Name	Description	Required?	Pipeline Input
StoreService	The Store service output the UserFarmMappings from.	true	true (ByValue)
Name	Filter the UserFarmMappings by name.	false	false

Input Type

Citrix.StoreFront.Model.Store.StoreService

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

System.String

Parameter Name: The .NET ‘System.String’ reference type

Return Values

UserFarmMapping

The .NET ‘Citrix.StoreFront.Model.Store.UserFarmMapping’ reference type

Examples

EXAMPLE 1 Get all UserFarmMappings

Get-STFUserFarmMapping -StoreService $store
<!--NeedCopy-->

REMARKS

Gets all existing UserFarmMappings on the Store service $store.

EXAMPLE 2 Get specific UserFarmMappings

Get-STFUserFarmMapping -StoreService $store -Name "EUUsers"
<!--NeedCopy-->

REMARKS

Gets the EUUsers UserFarmMapping from the Store $store.

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

Get-STFUserFarmMapping

June 27, 2023

Contributed by:

June 27, 2023

Contributed by:

Get-STFUserFarmMapping

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.StoreService

System.String

Return Values

UserFarmMapping

Examples

EXAMPLE 1 Get all UserFarmMappings

EXAMPLE 2 Get specific UserFarmMappings

In this article