Citrix Virtual Apps and Desktops SDK

Get-SfOptimalGateway

August 3, 2023

Contributed by:

Gets the configured optimal gateways for farms.

Syntax

Get-SfOptimalGateway -SiteId <Int64> -ResourcesVirtualPath <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Gets the configured optimal gateways for farms.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
SiteId	Site ID within IIS. This is typically 1 for the site in IIS where StoreFront is installed by default.	true	true (ByPropertyName)
ResourcesVirtualPath	Path to the store that is to be configured to have a farm to optimal gateway mapping.
Example: “/Citrix/Store”	true	true (ByPropertyName)
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

None

Return Values

Citrix.Storefront.Sdk.Optimalgateway

Examples

Example 1

C:\PS>Get-DSOptimalGatewayForFarms -siteId 1 -ResourcesVirtualPath "/Citrix/MyStore"

<!--NeedCopy-->

Description

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

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-SfOptimalGateway

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Storefront.Sdk.Optimalgateway

Examples

Example 1

Description

In this article