Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-SfServerFromCluster

August 9, 2024
Contributed by: 
C

Removes server from the cluster.

Syntax

Remove-SfServerFromCluster
      -ClusterId <Guid>
      [-StorefrontUrl <Uri>]
      -ServerName <String>
      [-FarmName <String>]
      [-XmlServices <Uri[]>]
      [-RunAsynchronously <Boolean>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Removes server from the cluster and propagates information to other servers. The configuration of the server is wiped out, so the server can be reused.

Examples

EXAMPLE 1

Removes Server “BrokenSfServer” from a Cluster with id (Guid).

Remove-SfServerFromCluster -ClusterId (Guid) -ServerName BrokenSfServer -RunAsynchronously $true
<!--NeedCopy-->

Parameters

-ClusterId

The if of the cluster to perform operation on.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ServerName

The name of the server to remove from cluster. The name must be one of the values returned by Get-SfCluster.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-StorefrontUrl

The url that will be used by Receivers to contact Storefront. Http or https absolute urls are accepted.

Type: Uri
Position: Named
Default value: Server name and http binding.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FarmName

Name of the farm that will be used within Store service. Either both FarmName and XmlServices need to be specified or none of them.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-XmlServices

Collection of the url of xml services that will be used inside a farm. The urls neeed to be http or https, be absolute and share the same schema and port. Either both FarmName and XmlServices need to be specified or none of them.

Type: Uri[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RunAsynchronously

If set, the command will run asynchronously.

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

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.Task or Citrix.Storefront.DataModel.Cluster

Returns cluster description or a task, if ran asynchronously.

Remove-SfServerFromCluster
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.