New-Bridge

This PowerShell cmdlet enables the users to create a new Bridge between one or more than one cache server nodes.

New-Bridge -Name -Server `
           [-BridgePort] [-ConnectionRetryInterval] `
           [-MaxQueueSize] [-NoLogo] `
           [-Port] [-QueueOptimized] `
           [-QueueReplicationInterval] [-ReplicatorQueueSize] `
           [-TlsCertPath] [-TlsCertPassword] `
           [-Credentials]

Examples

  • This command creates a new Bridge defaultBridge on server 20.200.20.11.
New-Bridge -Name defaultBridge -Server 20.200.20.11
  • The following command creates a new Bridge named defaultBridge on server 20.200.20.11 using Port 9817.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -Port 9817
  • This command creates a new Bridge defaultBridge on servers 20.200.20.11 (active mode) and 20.200.20.12 (passive mode) using the default Bridge Port 9816 with default MaxQueueSize.
New-Bridge -Name defaultBridge -Server "20.200.20.11,20.200.20.12" `
           -BridgePort 9816 -MaxQueueSize 2048
  • This command creates a new Bridge defaultBridge on servers 20.200.20.11 (active mode) and 20.200.20.12 (passive mode) with a replicator queue size of 100 MB.
New-Bridge -Name defaultBridge -Server "20.200.20.11,20.200.20.12" `
           -ReplicatorQueueSize 100
  • The following command creates a new Bridge named defaultBridge on server 20.200.20.11 and sets the queue replication interval to 2 seconds.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -QueueReplicationInterval 2
  • The following command creates a new Bridge named defaultBridge on server 20.200.20.11 with the -QueueOptimized switch enabled.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -QueueOptimized
  • The following command creates a new Bridge named defaultBridge on server 20.200.20.11 with -ConnectionRetryInterval set to 5 seconds.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -ConnectionRetryInterval 5
  • This command creates 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.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
  • This command creates a new Bridge defaultBridge on server 20.200.20.11 using security credentials.
New-Bridge -Name defaultBridge -Server 20.200.20.11 `
           -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. -
-BridgePort <Integer> Specifies the port of the server on which the server listens. -
-ConnectionRetryInterval <Integer> Specifies the connection retry interval (in seconds) for bridge. 5
-MaxQueueSize <Integer> Specifies the max Bridge queue size which is part of the cache size. 2048 MB
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False
-Server* <String> Specifies the NCache server names where Bridge should be configured, separated by commas, e.g., 20.200.20.11,20.200.20.12. The server specified first will be added as Bridge active node. -
-Port <Integer> Specifies the port on which the NCache Bridge service is listening. 9817
-QueueOptimized <SwitchParameter> Specifies if optimized queue is to be used. False
-QueueReplicationInterval <Integer> Specifies the interval (in seconds) for Bridge queue replication. 2
-ReplicatorQueueSize <Integer> Specifies the Bridge max queue size which is part of the cache size. 2048 MB
-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. -