Removes server from the cluster.
Syntax
Remove-SfServerFromCluster -ClusterId <Guid> -ServerName <String> [-StorefrontUrl <Uri>] [-FarmName <String>] [-XmlServices <Uri[]>] [-RunAsynchronously <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Detailed 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.
Parameters
-ClusterId<Guid>
The if of the cluster to perform operation on.
Required? |
true |
Default Value |
|
Accept Pipeline Input? |
false |
-ServerName<String>
The name of the server to remove from cluster. The name must be one of the values returned by Get-SfCluster.
Required? |
true |
Default Value |
|
Accept Pipeline Input? |
false |
-StorefrontUrl<Uri>
The url that will be used by Receivers to contact Storefront. Http or https absolute urls are accepted.
Required? |
false |
Default Value |
Server name and http binding. |
Accept Pipeline Input? |
false |
-FarmName<String>
Name of the farm that will be used within Store service. Either both FarmName and XmlServices need to be specified or none of them.
Required? |
false |
Default Value |
|
Accept Pipeline Input? |
false |
-XmlServices<Uri[]>
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.
Required? |
false |
Default Value |
|
Accept Pipeline Input? |
false |
-RunAsynchronously<Boolean>
If set, the command will run asynchronously.
Required? |
false |
Default Value |
false |
Accept Pipeline Input? |
false |
-LoggingId<Guid>
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.
Required? |
false |
Default Value |
|
Accept Pipeline Input? |
false |
-AdminAddress<String>
Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.
Required? |
false |
Default Value |
Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Accept Pipeline Input? |
false |
Return Values
Citrix.Storefront.Sdk.Task or Citrix.Storefront.DataModel.Cluster
Returns cluster description or a task, if ran asynchronously.
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-SfServerFromCluster -ClusterId (Guid) -ServerName BrokenSfServer -RunAsynchronously $true
Removes Server "BrokenSfServer" from a Cluster with id (Guid).