Storefront Powershell SDK 2402

Get-STFEquivalentFarmset

March 5, 2024

Contributed by:

Get the EquivalentFarmSet for a UserFarmMapping

Syntax

Get-STFEquivalentFarmset [-UserFarmMapping] <UserFarmMapping> [[-Name] <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Get the EquivalentFarmSets configured for a UserFarmMapping or a specific EquivalentFarmSet matching the supplied name.

New-STFEquivalentFarmset

Parameters

Name	Description	Required?	Pipeline Input	Default Value
UserFarmMapping	The UserFarmMapping to get the EquivalentFarmset from.	true	true (ByValue)
Name	Filter the EquivalentFarmset by name.	false	false

Input Type

Citrix.StoreFront.Model.Store.UserFarmMapping

Parameter UserFarmMapping: The .NET Citrix.StoreFront.Model.Store.UserFarmMapping reference type

System.String

Parameter Name: The .NET System.String reference type

Return Values

EquivalentFarmSet

The .NET Citrix.StoreFront.Model.Store.EquivalentFarmSet reference type

Examples

EXAMPLE 1 Get all EquivalentFarmSets

Get-STFEquivalentFarmset -UserFarmMapping $UserFarmMapping
<!--NeedCopy-->

REMARKS

Gets all existing EquivalentFarmSet on the $UserFarmMapping object.

EXAMPLE 2 Get specific EquivalentFarmSet

Get-STFEquivalentFarmset -UserFarmMapping $UserFarmMapping -Name "EUMapping"
<!--NeedCopy-->

REMARKS

Gets the EUMapping from the UserFarmMapping $UserFarmMapping.

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-STFEquivalentFarmset

March 5, 2024

Contributed by:

March 5, 2024

Contributed by:

Get-STFEquivalentFarmset

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.UserFarmMapping

System.String

Return Values

EquivalentFarmSet

Examples

EXAMPLE 1 Get all EquivalentFarmSets

EXAMPLE 2 Get specific EquivalentFarmSet

In this article