Share via

New-ServiceFabricCluster

Module:
ServiceFabric Module

Creates a new standalone Service Fabric cluster.

Syntax

Default (Default) 

New-ServiceFabricCluster
    [-ClusterConfigurationFilePath] <String>
    -FabricRuntimePackagePath <String>
    [-NoCleanupOnFailure]
    [-Force]
    [-FabricIsPreInstalled]
    [-MaxPercentFailedNodes <Int32>]
    [-TimeoutInSeconds <UInt32>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The New-ServiceFabricCluster cmdlet creates a new standalone Service Fabric cluster based on a configuration file in JavaScript Object Notation (JSON) format and a Service Fabric runtime package CAB file.

The cmdlet orchestrates installations from the controller computer.

Examples

Example 1: Create a cluster

$newServiceFabricClusterSplat = @{
    ClusterConfigurationFilePath = "D:\standalone\ClusterConfig.Unsecure.DevCluster.json"
    FabricRuntimePackagePath = "D:\deployanywhere\MicrosoftAzureServiceFabric.cab"
}
New-ServiceFabricCluster @newServiceFabricClusterSplat

This command creates a cluster based on the input cluster configuration path and runtime CAB package.

Example 2: Create a cluster without clean up if failures are encountered

$newServiceFabricClusterSplat = @{
    ClusterConfigurationFilePath = "D:\standalone\ClusterConfig.Unsecure.DevCluster.json"
    FabricRuntimePackagePath = "D:\deployanywhere\MicrosoftAzureServiceFabric.cab"
    NoCleanupOnFailure = -NoCleanupOnFailure
}
New-ServiceFabricCluster @newServiceFabricClusterSplat

This command creates a cluster based on the input cluster configuration path and runtime CAB package, and for deployment failure, Fabric resources are not cleaned up on the target computers.

Parameters

-ClusterConfigurationFilePath

Specifies the path of the cluster configuration JSON file.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FabricIsPreInstalled

Bypasses Service Fabric runtime installation and clean runtime validation, such that only the node is configured.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FabricRuntimePackagePath

Specifies the path of the Service Fabric package CAB file.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

{{Fill Force Description}}

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxPercentFailedNodes

Maximum percentage of nodes allowed to fail during cluster creation. If more than this percentage of nodes fail, the cluster creation will fail and roll back. If not specified, any node failures will fail cluster creation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoCleanupOnFailure

Indicates that the system should retain Fabric data if the cluster cannot fully come up.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeoutInSeconds

The number of seconds to wait for the operation to complete before timing out.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object