Share via

Copy-ServiceFabricClusterPackage

Module:
ServiceFabric Module

Copies a Service Fabric runtime installation file and/or cluster manifest to the image store.

Syntax

Both (Default) 

Copy-ServiceFabricClusterPackage
    -CodePackagePath <String>
    -ClusterManifestPath <String>
    [-ImageStoreConnectionString <String>]
    [-CodePackagePathInImageStore <String>]
    [-ClusterManifestPathInImageStore <String>]
    [-CertStoreLocation <StoreLocation>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Code 

Copy-ServiceFabricClusterPackage
    -CodePackagePath <String>
    [-Code]
    [-ClusterManifestPath <String>]
    [-ImageStoreConnectionString <String>]
    [-CodePackagePathInImageStore <String>]
    [-CertStoreLocation <StoreLocation>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Config 

Copy-ServiceFabricClusterPackage
    -ClusterManifestPath <String>
    [-Config]
    [-CodePackagePath <String>]
    [-ImageStoreConnectionString <String>]
    [-ClusterManifestPathInImageStore <String>]
    [-CertStoreLocation <StoreLocation>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Copy-ServiceFabricClusterPackage cmdlet copies a Service Fabric runtime installation file and/or cluster manifest to the image store.

After copying the package to the image store, use the Register-ServiceFabricClusterPackage cmdlet to register the package.

After registering the package to the image store, use the Remove-ServiceFabricClusterPackage cmdlet to remove the package from the image store.

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: Copy code and manifest to the image store

PS C:\> Copy-ServiceFabricClusterPackage -ClusterManifestPath "\\configStore\ClusterManifests\CH1\ClusterManifest_123.xml" -CodePackagePath "\\codeStore\MsiFiles\ServiceFabric.2.0.59.0.msi" -ImageStoreConnectionString "fabric:ImageStore"

This command copies the specified MSI and cluster manifest file to the image store. When the CodePackagePathInImageStore or ClusterManifestPathInImageStore parameters are not provided, the file name is used by default.

Example 2: Copy only cluster manifest to the image store

PS C:\> Copy-ServiceFabricClusterPackage -Config -ClusterManifestPath "\\configStore\ClusterManifests\CH1\ClusterManifest_123.xml" -ClusterManifestPathInImageStore ClusterManifest.xml -ImageStoreConnectionString "fabric:ImageStore"

This command copies the specified cluster manifest to ClusterManifest.xml in the image store.

Example 3: Copy only runtime installation file to the image store

PS C:\> Copy-ServiceFabricClusterPackage -Code -CodePackagePath "\\codeStore\MsiFiles\ServiceFabric.2.0.59.0.msi" -CodePackagePathInImageStore ServiceFabric.msi -ImageStoreConnectionString "fabric:ImageStore"

This command copies just the specified MSI file to ServiceFabric.msi in the image store.

Parameters

-CertStoreLocation

{{Fill CertStoreLocation Description}}

Parameter properties

Type:StoreLocation
Default value:None
Accepted values:CurrentUser, LocalMachine
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

-ClusterManifestPath

Specifies the path to a Service Fabric cluster manifest.

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

-ClusterManifestPathInImageStore

Specifies the relative path in the image store where the cluster manifest should be copied to.

Parameter properties

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

Parameter sets

Both
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Config
Position:Named
Mandatory:False
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 copied to the image store.

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 file path to a Service Fabric runtime installation file. This file can be a MSI, CAB, or DEB file.

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

-CodePackagePathInImageStore

Specifies the relative path in the image store where the Service Fabric runtime installation file should be copied to.

Parameter properties

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

Parameter sets

Both
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Code
Position:Named
Mandatory:False
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 copied to the image store.

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

-ImageStoreConnectionString

Specifies the connection string for the Service Fabric image store. Read more about the image store connection string.

Parameter properties

Type:String
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 timeout in seconds, for the operation. By default, the maximum timeout value is limited to 1800 seconds.

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