What is the purpose of the Environment parameter in Add-BridgeCache?

The Environment parameter appends a unique suffix to the cache name within the bridge (for example, demoCache.WestCoast). This creates a distinct logical identifier for the cache instance, allowing multiple cache instances with the same base name to coexist within a bridge without naming conflicts.

What is the difference between Active and Passive bridge modes?

An Active node handles primary replication traffic and can send/receive data, while a Passive node acts as a standby/failover site. Passive nodes receive data from Active sites and only take over the active role if the primary site fails, ensuring high availability for disaster recovery.

Why are administrative credentials required for Add-BridgeCache?

If security is enabled on the cluster or bridge, you must provide LDAP/Active Directory credentials for a user with bridge management rights. This prevents unauthorized users from modifying the global synchronization topology.

Add-BridgeCache

This PowerShell cmdlet enables users to add an existing clustered cache to a specified NCache Bridge for WAN replication. It allows a cache to be associated with a defined environment and optionally configured in Active or Passive mode, enabling data synchronization, disaster recovery, and high availability across distributed cache clusters.

Windows PowerShell
Linux CLI

Add-BridgeCache -CacheName -Name -Environment -Server -CacheServer [-Mode {Active | Passive}] [-Port] [-NoLogo] [-Credentials]

Examples

This command adds an existing clustered cache named demoCache to the Bridge demoBridge running on 20.200.20.11. The cache name will now be demoCache.WestCoast.

Add-BridgeCache -Name demoBridge -Server 20.200.20.11 -CacheName demoCache -CacheServer 20.200.20.12 -Environment WestCoast

This command adds an existing clustered cache named demoCache to the Bridge demoBridge running on 20.200.20.11. The cache name will now be demoCache.WestCoast using security credentials.

Add-BridgeCache -Name demoBridge -Server 20.200.20.11 -CacheName demoCache -CacheServer 20.200.20.12 -Environment WestCoast -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
`-CacheName*`	`<String>`	Specifies the name of the clustered cache to be added to the Bridge. Note: The cache must already exist on the source server.	-
`-Name*`	`<String>`	Specifies the name of the Bridge registered on the server.	-
`-Environment*`	`<String>`	Specifies the clustered cache environment. Cache name and environment act as a unique identifier of Bridge cache.	-
`-Server*`	`<String>`	Specifies the server name where the NCache Bridge Service is running and a Bridge with the specified Bridge-name is registered.
`-CacheServer*`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered.	-
`-Mode`	`<BridgeCacheStateParam>`	Specifies the mode of the Bridge. Can be either `Active` or `Passive`.	Active
`-Port`	`<Integer>`	Specifies the port on which the NCache Bridge Service is listening.	8260
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-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.	-

add-bridgecache -cachename -name -environment -server -cacheserver [-mode {active | passive}] [-port] [-nologo] [-userid] [-password]

Examples

This command adds an existing clustered cache named demoCache to the Bridge demoBridge running on 20.200.20.11. The cache name will now be demoCache.WestCoast.

add-bridgecache -name demoBridge -server 20.200.20.11 -cachename demoCache -cacheserver 20.200.20.12 -environment WestCoast

This command adds an existing clustered cache named demoCache to the Bridge demoBridge running on 20.200.20.11. The cache name will now be demoCache.WestCoast using security credentials.

add-bridgecache -name demoBridge -server 20.200.20.11 -cachename demoCache -cacheserver 20.200.20.12 -environment WestCoast -userid john_smith -password pass123

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
`-cachename*`	`<String>`	Specifies the name of the clustered cache to be added to the Bridge. Note: The cache must already exist on the source server.	-
`-name*`	`<String>`	Specifies the name of the Bridge registered on the server.	-
`-environment*`	`<String>`	Specifies the clustered cache environment. Cache name and environment act as a unique identifier of Bridge cache.	-
`-server*`	`<String>`	Specifies the server name where the NCache Bridge Service is running and a Bridge with the specified Bridge-name is registered.
`-cacheserver*`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered.	-
`-mode`	`<BridgeCacheStateParam>`	Specifies the mode of the Bridge. Can be either `Active` or `Passive`.	Active
`-port`	`<Integer>`	Specifies the port on which the NCache Bridge Service is listening.	8260
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-userid`	`<String>`	Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory user id.	-
`-password`	`<String>`	Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password.	-

Add-BridgeCache

Examples

Properties

Note

Contact Us