What does Remove-BridgeCache do?

Remove-BridgeCache removes an existing clustered cache from a specified NCache Bridge. After removal, the cache no longer participates in Bridge replication.

Which parameters are required for Remove-BridgeCache?

The Name, CacheFullName, and Server parameters are required.

What does the Force parameter do?

The Force parameter allows forceful removal of a cache from a running Bridge.

What is the default port for Remove-BridgeCache?

The default value of the Port parameter is 9816.

Can Remove-BridgeCache be used when a load balancer is enabled?

Yes. Remove-BridgeCache can remove caches from Bridges even when the load balancer is enabled.

Remove-BridgeCache

This PowerShell cmdlet enables the user to remove an existing clustered cache from a specified Bridge. After removal, the cache will no longer be involved in bridge replication, though any existing data on the target cache remains until manually cleared.

Remove-BridgeCache -Name -CacheFullName `
                   -Server [-Force] `
                   [-Port] [-Credentials] `
                   [-TlsCertPath] [-TlsCertPassword] `
                   [-NoLogo]

Examples

This command removes an existing clustered cache named defaultCache.WestCoast from the Bridge named defaultBridge on 20.200.20.11 using the default Port 9816.

Remove-BridgeCache -Name defaultBridge -Server 20.200.20.11 `
                   -CacheFullName defaultCache.WestCoast -Port 9816

This command removes the clustered cache defaultCache.WestCoast forcefully from the Bridge named defaultBridge, even if the Bridge is running.

Remove-BridgeCache -Name defaultBridge -Server 20.200.20.11 `
                   -CacheFullName defaultCache.WestCoast -Force

This command removes defaultCache.US from 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.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.

Remove-BridgeCache -Name defaultBridge -Server 20.200.20.11 `
                   -CacheFullName defaultCache.US -TlsCertPath "C:\certs\client.pem" `
                   -TlsCertPassword "clientKeyPassword"

This command removes an existing clustered cache named defaultCache.WestCoast from the Bridge named defaultBridge on 20.200.20.11 using security credentials.

Remove-BridgeCache -Name defaultBridge -Server 20.200.20.11 `
                   -CacheFullName defaultCache.WestCoast -Credentials (Get-Credential john_smith)

Note

The Remove-BridgeCache command can be used to remove caches from bridges 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 clustered cache name with the environment that has to be removed from the Bridge.	-
`-Server*`	`<String>`	Specifies the server name where the NCache Bridge Service is running and a Bridge is registered with the specified Bridge-name.	IP of local machine
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-Force`	`<SwitchParameter>`	Specifies forceful removal of cache from running Bridge.	False
`-Port`	`<Integer>`	Specifies the port on which the NCache Bridge Service is listening.	9816
`-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.	-

Remove-BridgeCache

Examples

Note

Properties

Note

Contact Us