Share via

Start-ServiceFabricClusterConfigurationUpgrade

Module:
ServiceFabric Module

Upgrades a cluster configuration.

Syntax

Default (Default) 

Start-ServiceFabricClusterConfigurationUpgrade
    [-ClusterConfigPath] <String>
    [-HealthCheckRetryTimeoutSec <UInt32>]
    [-HealthCheckWaitDurationSec <UInt32>]
    [-HealthCheckStableDurationSec <UInt32>]
    [-UpgradeDomainTimeoutSec <UInt32>]
    [-UpgradeTimeoutSec <UInt32>]
    [-MaxPercentUnhealthyApplications <Byte>]
    [-MaxPercentUnhealthyNodes <Byte>]
    [-MaxPercentDeltaUnhealthyNodes <Byte>]
    [-MaxPercentUpgradeDomainDeltaUnhealthyNodes <Byte>]
    [-ApplicationHealthPolicies <ApplicationHealthPolicyMap>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Start-ServiceFabricClusterConfigurationUpgrade cmdlet upgrades a cluster configuration by using a cluster configuration file in JavaScript Object Notation (JSON) format.

Examples

Example 1: Upgrade cluster configuration

PS C:\> Start-ServiceFabricClusterConfigurationUpgrade -ClusterConfigPath "configurationV2.json"

This cmdlet upgrades cluster configuration based on the cluster configuration file.

Parameters

-ApplicationHealthPolicies

{{Fill ApplicationHealthPolicies Description}}

Parameter properties

Type:ApplicationHealthPolicyMap
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

-ClusterConfigPath

Specifies the path of the cluster configuration 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

-HealthCheckRetryTimeoutSec

Specifies the duration, in seconds, after which Service Fabric retries the health check if the previous health check fails.

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

-HealthCheckStableDurationSec

Specifies the duration, in seconds, that Service Fabric waits in order to verify that the cluster is stable before moving to the next upgrade domain or completing the upgrade. This wait duration prevents undetected changes of health right after the health check is performed.

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

-HealthCheckWaitDurationSec

Specifies the duration, in seconds, that Service Fabric waits before it performs the initial health check after it finishes the upgrade on the upgrade domain.

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

-MaxPercentDeltaUnhealthyNodes

Specifies the maximum tolerated percentage of delta unhealthy nodes that can have aggregated health states of error. If the current unhealthy nodes do not respect the percentage relative to the state at the beginning of the upgrade, the cluster is unhealthy.

Parameter properties

Type:Byte
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

-MaxPercentUnhealthyApplications

Specifies the maximum tolerated percentage of applications that can have aggregated health state of error. If the upgrade exceeds this percentage, the cluster is unhealthy.

Parameter properties

Type:Byte
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

-MaxPercentUnhealthyNodes

Specifies the maximum percentage of nodes that can have aggregated health states of error. If the current unhealthy applications do not respect this percentage, the cluster is considered unhealthy.

Parameter properties

Type:Byte
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

-MaxPercentUpgradeDomainDeltaUnhealthyNodes

Specifies the maximum percentage of upgrade domain delta unhealthy nodes that can have aggregated health states of error. If there is any upgrade domain where the current unhealthy nodes do not respect the percentage relative to the state at the beginning of the upgrade, the cluster is considered unhealthy.

Parameter properties

Type:Byte
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

-UpgradeDomainTimeoutSec

Specifies the maximum time, in seconds, that Service Fabric takes to upgrade a single upgrade domain. After this period, the upgrade fails.

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

-UpgradeTimeoutSec

Specifies the maximum time, in seconds, that Service Fabric takes for the whole upgrade. After this period, the upgrade fails.

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

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