Get-Bridges
This cmdlet enables the user to list the total bridges registered on the server along with their status.
Get-Bridges [-Port] [-Server] `
[-Credentials] [-TlsCertPath] `
[-TlsCertPassword] [-NoLogo]
Examples
- This command displays all bridges currently registered on the provided server.
Get-Bridges -Server 20.200.20.11
- This command displays all bridges currently registered on the specified server with mutual TLS (mTLS) enabled. 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.
Get-Bridges -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
-TlsCertPassword "clientKeyPassword"
- This command displays all bridges currently registered on the provided server using security credentials.
Get-Bridges -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 |
|---|---|---|---|
-Server |
<String> |
Specifies a server name where the NCache Bridge Service is running. | - |
-Port |
<Integer> |
Specifies the port on which the NCache Bridge Service is listening. | 9817 |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-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. |
False |
-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. |
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. | - |