Citrix StoreFront SDK PowerShell Modules

Register-STFStoreOptimalLaunchGateway

August 23, 2023

Contributed by:

Syntax

Register-STFStoreOptimalLaunchGateway [-Gateway] <RoamingGateway> [[-FarmName] <String[]>] [[-ZoneName] <String[]>] [[-EnabledOnDirectAccess] <SwitchParameter>] [-StoreService] <StoreService> [<CommonParameters>]

Register-STFStoreOptimalLaunchGateway [-NeverLaunchThroughGateway] <SwitchParameter> [[-FarmName] <String[]>] [[-ZoneName] <String[]>] [[-EnabledOnDirectAccess] <SwitchParameter>] [-StoreService] <StoreService> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Configure optimal NetScaler Gateway routing to optimize the handling of ICA connection routing from the HDX engine to published resources such as XenDesktop VDAs or XenApp or XenDesktop published applications using StoreFront. Typically, the optimal gateway for a site is collocated in the same geographical location. Optionally configure a farm or farms to never use a gateway, “UseNoOptimalGateway”.

Parameters

Name	Description	Required?	Pipeline Input
Gateway	Gateway to register	true	true (ByValue)
NeverLaunchThroughGateway	Use no Gateway for the Farms specified	true	false
FarmName	Farms to use the Gateway for	false	false
ZoneName	Zones to use the Gateway for	false	false
EnabledOnDirectAccess	Route connections through the Gateway when users are on the internal network	false	false
StoreService	Route connections through the Gateway when users are on the internal network	true	false

Input Type

Citrix.StoreFront.Model.Roaming.RoamingGateway

Parameter Gateway: The .NET Citrix.StoreFront.Model.Roaming.RoamingGateway reference type

System.Management.Automation.SwitchParameter

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

System.String[]

Parameter FarmName: The .NET System.String reference type

System.String[]

Parameter ZoneName: The .NET System.String reference type

System.Management.Automation.SwitchParameter

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

Citrix.StoreFront.Model.Store.StoreService

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

Return Values

None

Notes

When an existing Optimal gateway registration requires an update to include additional farms then it must be unregistered using UnRegister-STFStoreOptimalLaunchGateway -Gateway $gateway and then re-registered with the new list of farms / zones.

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

August 23, 2023

Contributed by:

August 23, 2023

Contributed by:

Register-STFStoreOptimalLaunchGateway

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Roaming.RoamingGateway

System.Management.Automation.SwitchParameter

System.String[]

System.String[]

System.Management.Automation.SwitchParameter

Citrix.StoreFront.Model.Store.StoreService

Return Values

None

Notes

In this article