Developer Documentation
Citrix Daas SDK

New-SfCluster

August 9, 2024
Contributed by: 
C C

Creates new Storefront cluster with default set of services.

Syntax

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

Description

The server will have a default set of services containing fully-functionaly Storefront server with Authentication, Store, Receiver for Web and Desktop Appliance.

Examples

EXAMPLE 1

Creates a new cluster on server “SfServer”. The server will have a default set of services containing fully-functionaly Storefront server with Authentication, Store, Receiver for Web, Desktop Appliance site and the required infrastructure. The Store service will have a farm named “XdSiteName” that will contain servers farm1 and farm2, whose will be contacted using http on default port 80.

New-SfCluster -FarmName "XdSiteName" -XmlServices http://farm1,http://farm2 -ServerName SfServer -RunAsynchronously $true
<!--NeedCopy-->

Parameters

-ServerName

The name of the server to build a cluster on. 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

-FarmName

Name of the farm that will be used within Store service.

Type: String
Position: Named
Default value: None
Required: True
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.

Type: Uri[]
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

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

New-SfCluster
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C 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.