Citrix StoreFront SDK PowerShell Modules

Get-STFUserFarmMapping

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 Default Value
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.

Get-STFUserFarmMapping