Invoke-ServerLogger

The Invoke-ServerLogger PowerShell cmdlet is an important troubleshooting tool used for real-time troubleshooting within NCache clusters. It enables administrators to turn on low-level logging for the socket-server and all connected clients at the same time. This is essential for auditing network latency, communication bottlenecks, and tracing error messages. The logs are stored in the NCache installation directory of NCache in the folder %NCHOME%\log-files as part of this PowerShell cmdlet execution.

Invoke-ServerLogger [-Enable] [-Disable] `
                    [-NoLogo] [-Port] `
                    [-TlsCertPath] [-TlsCertPassword] `
                    [-Server] [-Credentials]

Examples

• This command enables socket server logs.

Invoke-ServerLogger -Enable

• This command disables socket server logs.

Invoke-ServerLogger -Disable

• This command enables server logging using mutual TLS (mTLS). 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.

Invoke-ServerLogger -Enable -TlsCertPath "C:\certs\client.pem" `
                    -TlsCertPassword "clientKeyPassword"

• This command enables socket server logs, using security credentials.

Invoke-ServerLogger -Enable -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
-Enable	<SwitchParameter>	Enables error and detailed logging on the server side.	False
-Disable	<SwitchParameter>	Disables error and detailed logging on the server side.	False
-NoLogo	<SwitchParameter>	Suppresses display of the logo banner.	False
-Port	<Integer>	Specifies the server port where the NCache Service is listening.	9803
-Server	<String>	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered.	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.	-