Citrix Daas SDK

Set-SfCluster

August 9, 2024

Contributed by:

C C

Sets the parameters on the given cluster.

Syntax

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

Description

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

Examples

EXAMPLE 1

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

Set-SfCluster -StorefrontUrl http://SfUrl -ClusterId (Guid) -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

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

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 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Set-SfCluster

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ClusterId

-StorefrontUrl

-FarmName

-XmlServices

-RunAsynchronously

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Storefront.Sdk.Task or Citrix.Storefront.DataModel.Cluster

Related Links

In this article