Register-ServiceFabricClusterPackage
Registers Service Fabric runtime installation file and/or cluster manifest with the cluster.
Syntax
Both (Default)
Register-ServiceFabricClusterPackage
-CodePackagePath <String>
-ClusterManifestPath <String>
[-TimeoutSec <Int32>]
[<CommonParameters>]
Code
Register-ServiceFabricClusterPackage
-CodePackagePath <String>
[-Code]
[-ClusterManifestPath <String>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Config
Register-ServiceFabricClusterPackage
-ClusterManifestPath <String>
[-Config]
[-CodePackagePath <String>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Description
The Register-ServiceFabricClusterPackage cmdlet registers a Service Fabric cluster manifest and/or a Service Fabric runtime installation file.
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: Register a package that contains both code and configuration
PS C:\> Register-ServiceFabricClusterPackage -ClusterManifestPath "ClusterManifest.xml" -CodePackagePath "ServiceFabric.msi"
This command registers both the cluster manifest and MSI file with the cluster.
Example 2: Register only the cluster manifest
PS C:\> Register-ServiceFabricClusterPackage -Config -ClusterManifestPath "ClusterManifest.xml"
This command registers just the cluster manifest with the cluster.
Example 3: Register only the runtime installation file
PS C:\> Register-ServiceFabricClusterPackage -Code -CodePackagePath "ServiceFabric.msi"
This command registers just the runtime installation file with the cluster.
Parameters
-ClusterManifestPath
Specifies the path to a Service Fabric cluster manifest file in the ImageStore. This path specified in ClusterManifestPathInImageStore in Copy-ServiceFabricClusterPackage cmdlet should be provided here.
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
Specifies that only Service Fabric runtime installation file has to be registered with 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 |
-CodePackagePath
Specifies the path to a Service Fabric runtime installation file in the ImageStore. This path specified in CodePackagePathInImageStore in Copy-ServiceFabricClusterPackage cmdlet should be provided here.
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
Specifies that only Service Fabric cluster manifest file has to be registered with 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 |
-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.