Citrix StoreFront SDK PowerShell Modules

Remove-STFRoamingGateway

June 13, 2023

Contributed by:

Remove a Gateway used for remote access and authentication

Syntax

Remove-STFRoamingGateway [-Gateway] <RoamingGateway> [[-RoamingService] <RoamingService>] [<CommonParameters>]

Remove-STFRoamingGateway [-Name] <String> [[-RoamingService] <RoamingService>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Remove a Gateway from the global list of Gateways and from any Stores that are configured to use it for remote access or authentication.

Parameters

Name	Description	Required?	Pipeline Input
Gateway	Remove the Gateway supplied from the global list	true	true (ByValue)
Name	Remove the Gateway named from the global list	true	true (ByValue)
RoamingService	The Roaming service	false	false

Input Type

Citrix.StoreFront.Model.Roaming.RoamingGateway

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

System.String

Parameter Name: The .NET System.String reference type

Citrix.StoreFront.Model.Roaming.RoamingService

Parameter RoamingService: A .NET class representing the configuration of a StoreFront Roaming service

Return Values

None

Notes

Any existing Store Service objects may be invalidated by this operation and should not be used after calling this Cmdlet.

Examples

EXAMPLE 1 Remove Gateway by name

Remove-STFRoamingGateway -Gateway "Netscaler10x"
<!--NeedCopy-->

REMARKS

Removes the Gateway with the matching name.

EXAMPLE 2 Remove Gateway

$gateway = Get-STFRoamingGateway -Name "Netscaler10x"
          Remove - STFRoamingGateway - Gateway $gateway
<!--NeedCopy-->

REMARKS

Gets the Gateway named “Netscaler10x” from the global list and removes it.

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

June 13, 2023

Contributed by:

June 13, 2023

Contributed by:

Remove-STFRoamingGateway

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Roaming.RoamingGateway

System.String

Citrix.StoreFront.Model.Roaming.RoamingService

Return Values

None

Notes

Examples

EXAMPLE 1 Remove Gateway by name

EXAMPLE 2 Remove Gateway

In this article