Start-BridgeStateTransfer
This PowerShell cmdlet enables the user to initiate a state transfer between the source and target caches connected through an existing NCache Bridge. It triggers on-demand data synchronization from a specified source cache to a target cache within a WAN replication topology, ensuring data consistency across distributed sites. The Start-BridgeStateTransfer cmdlet requires the bridge name, bridge server, and fully qualified source and target cache names. It is commonly used for initial cache population, resynchronization after network outages or node downtime, onboarding new caches or nodes, and enforcing data consistency in disaster recovery or multi-region deployments. The cmdlet also supports secure clusters through credential-based authentication.
Start-BridgeStateTransfer -Name -Server `
-SourceCache -TargetCache `
[-Port] [-Credentials] `
[-TlsCertPath] [-TlsCertPassword] `
[-NoLogo]
Examples
- This command initiates state transfer from source cache defaultCache.WestCoast to target cache defaultCache.EastCoast for defaultBridge running on 20.200.20.11 using Port 9817.
Start-BridgeStateTransfer -Name defaultBridge -Server 20.200.20.11 `
-SourceCache defaultCache.WestCoast -TargetCache defaultCache.EastCoast `
-Port 9817
- This command starts state transfer from defaultCache.US to defaultClusteredCache.US through defaultBridge on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses
C:\certs\client.pemto authenticate the machine running the cmdlet. The-TlsCertPasswordparameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Start-BridgeStateTransfer -Name defaultBridge -Server 20.200.20.11 `
-SourceCache defaultCache.US -TargetCache defaultClusteredCache.US `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command initiates state transfer from source cache defaultCache.WestCoast to target cache defaultCache.EastCoast for defaultBridge running on 20.200.20.11 using security credentials.
Start-BridgeStateTransfer -Name defaultBridge -Server 20.200.20.11 `
-SourceCache defaultCache.WestCoast -TargetCache defaultCache.EastCoast `
-Credentials (Get-Credential john_smith)
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-Name* |
<String> |
Specifies the name of the Bridge registered on the server. | - |
-Server* |
<String> |
Specifies the server name where the NCache Bridge Service is running and a Bridge with the specified Bridge-name is registered. | - |
-SourceCache* |
<String> |
Specifies the full source cache name with environment name from which state transfer is to be initiated. | - |
-TargetCache* |
<String> |
Specifies the full target cache name with environment name for state transfer. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-Port |
<Integer> |
Specifies the port on which the NCache Bridge Service is listening. | 9817 |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. | - |
-TlsCertPath |
<string> |
Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using New-NCacheTlsCertificate. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use -CustomCertificatePath. |
- |
-TlsCertPassword |
<string> |
Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. |
- |