Citrix Virtual Apps and Desktops SDK

Get-SfOptimalGateway

May 4, 2026

Contributed by:

Gets the configured optimal gateways for farms.

Syntax

Get-SfOptimalGateway
   -SiteId <Int64>
   -ResourcesVirtualPath <String>
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Gets the configured optimal gateways for farms.

Examples

EXAMPLE 1

Get-DSOptimalGatewayForFarms -siteId 1 -ResourcesVirtualPath "/Citrix/MyStore"
<!--NeedCopy-->

Parameters

-SiteId

Site ID within IIS. This is typically 1 for the site in IIS where StoreFront is installed by default.

Type:	Int64
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-ResourcesVirtualPath

Path to the store that is to be configured to have a farm to optimal gateway mapping.

Example: “/Citrix/Store”

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2511

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.Storefront.Sdk.OptimalGateway

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

May 4, 2026

Contributed by:

May 4, 2026

Contributed by:

Get-SfOptimalGateway

Syntax

Description

Examples

EXAMPLE 1

Parameters

-SiteId

-ResourcesVirtualPath

-SkipCertificateValidation

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Storefront.Sdk.OptimalGateway

Related Links

In this article