Citrix Virtual Apps and Desktops SDK

Set-Sfcluster

August 3, 2023

Contributed by:

Sets the parameters on the given cluster.

Syntax

Set-SfCluster -ClusterId <Guid> [-StorefrontUrl <Uri>] [-FarmName <String>] [-XmlServices <Uri[]>] [-RunAsynchronously <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ClusterId	The if of the cluster to perform operation on.	true	false
StorefrontUrl	The url that will be used by Receivers to contact Storefront. Http or https absolute urls are accepted.	false	false	Server name and http binding.
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.	false	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.	false	false
RunAsynchronously	If set, the command will run asynchronously.	false	false	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

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

Description

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

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

Set-Sfcluster

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-Sfcluster

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Storefront.Sdk.Task Or Citrix.Storefront.Datamodel.Cluster

Examples

Example 1

Description

In this article