Storefront Powershell SDK 2402

Remove-STFUserFarmMapping

March 5, 2024

Contributed by:

Remove a UserFarmMapping from the Store

Syntax

Remove-STFUserFarmMapping [-UserFarmMapping] <UserFarmMapping> [-StoreService] <StoreService> [<CommonParameters>]

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

Detailed Description

Remove the UserFarmMapping configured for or Store.

Parameters

Name	Description	Required?	Pipeline Input
StoreService	The Store service output the UserFarmMappings from.	true	true (ByValue)
UserFarmMapping	The UserFarmMapping to remove from the StoreService UserFarmMappings.	true	false
Name	The unique name used to identify the UserFarmMapping.	true	false

Input Type

Citrix.StoreFront.Model.Store.StoreService

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

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

None

Examples

EXAMPLE 1 Remove a UserFarmMapping

$store = Get-STFStoreService -VirtualPath /Citrix/Store
Remove-STFUserFarmMapping -StoreService $store -Name "EUMapping"
<!--NeedCopy-->

REMARKS

Remove the EUMapping from the UserFarmMappings for the Store service /Citrix/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

Remove-STFUserFarmMapping

March 5, 2024

Contributed by:

March 5, 2024

Contributed by:

Remove-STFUserFarmMapping

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.StoreService

Citrix.StoreFront.Model.Store.UserFarmMapping

System.String

Return Values

None

Examples

EXAMPLE 1 Remove a UserFarmMapping

In this article