Which parameter is required for Start-Bridge?

The Name parameter is required.

What is the default port for Start-Bridge?

The default value of the Port parameter is 9817.

Which server is used by default?

If Server is not specified, the IP address of the local machine is used.

Start-Bridge

Q: What does Start-Bridge do?

Start-Bridge starts the specified Bridge on the specified server, including the caches involved.

The Start-Bridge cmdlet starts the specified Bridge on the specified server, including the caches involved.

Start-Bridge -Name [-Port] `
             [-Server] [-Credentials] `
             [-TlsCertPath] [-TlsCertPassword] `
             [-NoLogo]

Examples

This command starts Bridge named defaultBridge on local server, using port 9817 by default.

Start-Bridge -Name defaultBridge

This command starts Bridge defaultBridge existing on 20.200.20.11, using port 9817.

Start-Bridge -Name defaultBridge -Server 20.200.20.11 `
             -Port 9817

This command starts Bridge defaultBridge on servers 20.200.20.11 and 20.200.20.12.

Start-Bridge -Name defaultBridge -Server "20.200.20.11,20.200.20.12"

This command starts defaultBridge on the specified server. It runs from a machine where NCache is not installed and connects to the server using mutual TLS (mTLS). The client certificate C:\certs\client.pem authenticates the machine running the cmdlet, and -TlsCertPassword decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Start-Bridge -Name defaultBridge -Server 20.200.20.11 `
             -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

This command starts Bridge named defaultBridge on local server, using security credentials.

Start-Bridge -Name defaultBridge -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 name(s) of one or more Bridge(s) to be started which are registered on the server.	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-Port`	`<Integer>`	The port on which NCache Bridge is listening.	9817
`-Server`	`<String>`	The server name/IP on which the NCache Bridge Service is running.	IP of local machine
`-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.	-

Start-Bridge

Examples

Properties

Note

Contact Us