Set-BridgeCacheMode

This PowerShell cmdlet enables users to change the mode of a cache participating in an NCache Bridge by setting it as Active or Passive. It is used in WAN replication scenarios to control the direction of data synchronization. An Active cache acts as the primary source and sends updates, while a Passive cache functions as a secondary replica that receives updates.

Set-BridgeCacheMode -Name -CacheFullName `
                    -Mode {Active | Passive} -Server `
                    [-Port] [-Credentials] `
                    [-TlsCertPath] [-TlsCertPassword] `
                    [-NoLogo]

Examples

• This command changes the mode of the clustered cache defaultCache.WestCoast to active mode using the default port 9817.

Set-BridgeCacheMode -Name defaultBridge -Server 20.200.20.11 `
                    -CacheFullName defaultCache.WestCoast -Mode Active `
                    -Port 9817

• This command changes the mode of the clustered cache defaultCache.WestCoast to passive mode.

Set-BridgeCacheMode -Name defaultBridge -Server 20.200.20.11 `
                    -CacheFullName defaultCache.WestCoast -Mode Passive

• This command sets the mode of defaultCache.US in defaultBridge to Active on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Set-BridgeCacheMode -Name defaultBridge -Server 20.200.20.11 `
                    -CacheFullName defaultCache.US -Mode Active `
                    -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

• This command changes the mode of the clustered cache defaultCache.WestCoast to active mode using security credentials.

Set-BridgeCacheMode -Name defaultBridge -Server 20.200.20.11 `
                    -CacheFullName defaultCache.WestCoast -Mode Active `
                    -Credentials(Get-Credential john_smith)

Note

The Set-BridgeCacheMode command can be used even when the load balancer is enabled.

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.	-
-CacheFullName*	<String>	Specifies the name of the clustered cache with its environment name that is to be added to the Bridge.	-
-Mode*	<BridgeCacheStateParam>	Specifies the mode of the Bridge. Can be either Active or Passive.	Active
-Server*	<String>	Specifies the server name where the NCache Bridge Service is running and a Bridge with the specified Bridge-name is registered.	IP of local machine
-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.	-