Set-SfCluster
Sets the parameters on the given cluster.
Syntax
Set-SfCluster
[-StorefrontUrl <Uri>]
-ClusterId <Guid>
[-FarmName <String>]
[-XmlServices <Uri[]>]
[-RunAsynchronously <Boolean>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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
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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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.