Storefront Powershell SDK 2411

Remove-STFServerGroupMember

November 28, 2024

Contributed by:

Remove a member from the Server group

Syntax

Remove-STFServerGroupMember [-Name] <String> [[-Notify] <SwitchParameter>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Removes a server that was previously joined from the StoreFront server group.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	The host name of the server to remove	true	false
Notify	Notify removed server to clear configuration (if it is contactable)	false	false

Input Type

System.String

Parameter Name: The .NET System.String reference type

System.Management.Automation.SwitchParameter

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

Return Values

None

Examples

EXAMPLE 1 Remove server from the group

Remove-STFServerGroupMember -Name 'ServerB'
<!--NeedCopy-->

REMARKS

Remove ServerB from the StoreFront server group.

EXAMPLE 2 Remove server from the group and clear configuration

Remove-STFServerGroupMember -Name 'ServerB' -Notify
<!--NeedCopy-->

REMARKS

Removes the server from the server group and notifies that it should clear the configuration it has.

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

November 28, 2024

Contributed by:

November 28, 2024

Contributed by:

Remove-STFServerGroupMember

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

System.Management.Automation.SwitchParameter

Return Values

None

Examples

EXAMPLE 1 Remove server from the group

EXAMPLE 2 Remove server from the group and clear configuration

In this article