Share via

Unregister-ServiceFabricClusterPackage

Module:
ServiceFabric Module

Unregisters Service Fabric runtime installation version and/or cluster manifest version from the cluster.

Syntax

Both (Default) 

Unregister-ServiceFabricClusterPackage
    -CodePackageVersion <String>
    -ClusterManifestVersion <String>
    [-Force]
    [-TimeoutSec <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Code 

Unregister-ServiceFabricClusterPackage
    -CodePackageVersion <String>
    [-Code]
    [-ClusterManifestVersion <String>]
    [-Force]
    [-TimeoutSec <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Config 

Unregister-ServiceFabricClusterPackage
    -ClusterManifestVersion <String>
    [-Config]
    [-CodePackageVersion <String>]
    [-Force]
    [-TimeoutSec <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Unregister-ServiceFabricClusterPackage cmdlet unregisters Service Fabric runtime installation version and/or cluster manifest version from the cluster. The versions should be unregistered from the cluster if the versions are no longer used. This cmdlet will fail if the cluster is currently using the version.

The list of all registered Service Fabric runtime installation versions registered with the cluster can be obtained by using the Get-ServiceFabricRegisteredClusterCodeVersion cmdlet.

The list of all registered cluster manifest versions registered with the cluster can be obtained by using the Get-ServiceFabricRegisteredClusterConfigVersion cmdlet.

To manage Service Fabric clusters, start Windows PowerShell by using the Run as administrator option. Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

Examples

Example 1: Unregister both cluster manifest and runtime installation version from cluster

PS C:\> Unregister-ServiceFabricClusterPackage -ClusterManifestVersion "V2" -CodePackageVersion "2.0.59.0"

This command unregisters cluster manifest version "V2" and runtime installation version "2.0.59.0" from the cluster.

Example 1: Unregister just the cluster manifest version from cluster

PS C:\> Unregister-ServiceFabricClusterPackage -Config -ClusterManifestVersion "V2"

This command unregisters cluster manifest version "V2" from the cluster.

Example 1: Unregister just the runtime installation version from cluster

PS C:\> Unregister-ServiceFabricClusterPackage -Code -CodePackageVersion "2.0.59.0"

This command unregisters runtime installation version "2.0.59.0" from the cluster.

Parameters

-ClusterManifestVersion

Specifies the cluster manifest version to unregister from the cluster.

Parameter properties

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

Parameter sets

Both
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Config
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Code

Indicates that only the Service Fabric runtime installation version needs to be unregistered from the cluster.

Parameter properties

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

Parameter sets

Code
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CodePackageVersion

Specifies the runtime installation version to unregister from the cluster.

Parameter properties

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

Parameter sets

Both
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Code
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Config

Indicates that only the Service Fabric cluster manifest version needs to be unregistered from the cluster.

Parameter properties

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

Parameter sets

Config
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-Force

Forces the command to run without asking for user confirmation.

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

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

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