Remove-BridgeNode
This PowerShell cmdlet removes a server node from the specified NCache Bridge, which is used for asynchronous cache replication and synchronization across connected cache instances. It is commonly used to scale down Bridge infrastructure, decommission servers, perform maintenance, or update Bridge topology. After removal, the Bridge configuration is updated automatically to maintain replication continuity.
Remove-BridgeNode -Name -Server `
[-Port] [-Credentials] `
[-TlsCertPath] [-TlsCertPassword] `
[-NoLogo]
Examples
- This command removes Bridge server node 20.200.20.12 from the Bridge named defaultBridge on Port 9817.
Remove-BridgeNode -Name defaultBridge -Server 20.200.20.12 `
-Port 9817
- This command removes 20.200.20.12 from defaultBridge using mutual TLS (mTLS). 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.
Remove-BridgeNode -Name defaultBridge -Server 20.200.20.12 `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command removes Bridge server node 20.200.20.12 from the Bridge named defaultBridge using security credentials.
Remove-BridgeNode -Name defaultBridge -Server 20.200.20.12 `
-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. This server will be removed from the specified Bridge. | - |
-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. |
- |