Product Documentation

Set-SfCluster

Nov 17, 2015

Sets the parameters on the given cluster.

Syntax

Set-SfCluster -ClusterId <Guid> [-StorefrontUrl <Uri>] [-FarmName <String>] [-XmlServices <Uri[]>] [-RunAsynchronously <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Sets the parameters on the given cluster and propagate the changes to all servers within a given cluster.

Parameters

-ClusterId<Guid>

The if of the cluster to perform operation on.

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

Set-SfCluster -StorefrontUrl http://SfUrl -ClusterId (Guid) -RunAsynchronously $true

Sets a Storefront Url in a Cluster with id (Guid). Propagates changes to all servers that are part of the cluster.