Citrix StoreFront SDK PowerShell Modules

Unregister-STFStoreGateway

July 29, 2024

Contributed by:

Unregister a Gateway from a Store

Syntax

Unregister-STFStoreGateway [-Gateway] <ICommonGateway> [-StoreService] <StoreService> [<CommonParameters>]

Unregister-STFStoreGateway [-Name] <String> [-StoreService] <StoreService> [<CommonParameters>]

Unregister-STFStoreGateway [-AllGateways] <SwitchParameter> [-StoreService] <StoreService> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Unregister a Gateway from a Store used for authentication and launch (if configured for launch)

Parameters

Name	Description	Required?	Pipeline Input
Gateway	The Gateway object to remove, either a Roaming or Store gateway	true	true (ByValue)
Name	Name of the Gateway to remove	true	true (ByValue)
AllGateways	Remove all Gateways	true	true (ByValue)
StoreService	Store service to unregister from	true	false

Input Type

Citrix.StoreFront.Model.Common.ICommonGateway

Parameter Gateway: The .NET Citrix.StoreFront.Model.Common.ICommonGateway reference type

System.String

Parameter Name: The .NET System.String reference type

System.Management.Automation.SwitchParameter

Parameter AllGateways: 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

Examples

EXAMPLE 1 Remove Gateway by name

$storeService = Get-STFStoreService
UnRegister-STFStoreGateway -StoreService $storeService -Name Netscaler10x
<!--NeedCopy-->

REMARKS

Remove the Gateway object by name

EXAMPLE 2 Remove Gateway by object

$storeService = Get-STFStoreService
$gateway = Get-STFRoamingGateway -Name Netscaler10x
UnRegister-STFStoreGateway -StoreService $storeService -Gateway $gateway
<!--NeedCopy-->

REMARKS

Remove the Gateway object Netscaler10x from the only 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

Unregister-STFStoreGateway

July 29, 2024

Contributed by:

July 29, 2024

Contributed by:

Unregister-STFStoreGateway

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Common.ICommonGateway

System.String

System.Management.Automation.SwitchParameter

Citrix.StoreFront.Model.Store.StoreService

Return Values

None

Examples

EXAMPLE 1 Remove Gateway by name

EXAMPLE 2 Remove Gateway by object

In this article