Get-CacheLogsList
This enables the user to get all the log files in NCache log files directory or the log file of a specific cache. If no cache is specified, all log files on the cache server are displayed. For the Partition-Replica topology, the logs of the replica are also displayed.
Get-CacheLogsList [-CacheName] -Server `
[-TlsCertPath] [-TlsCertPassword] `
[-Credentials]
Examples
- This command gets the log files of defaultCache from the specified server.
Get-CacheLogsList -Server 20.200.20.11 -CacheName defaultCache
- This command gets all the log files from the specified server.
Get-CacheLogsList -Server 20.200.20.11
- This command lists the available log files for defaultCache 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-CacheLogsList -Server 20.200.20.11 -Name defaultCache `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command gets the log files of defaultCache from the specified server, using security credentials.
Get-CacheLogsList -Server 20.200.20.11 -CacheName defaultCache `
-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 |
|---|---|---|---|
-CacheName |
<String> |
Specifies the name of the cache for which the list of logs needs to be displayed. NOTE: The cache must already exist on the source server. |
- |
-Server* |
<String> |
Specifies a server name where the NCache Service is running and a cache with the specified cache name is registered. | - |
-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> |
Specifies the path to the client PEM certificate used to authenticate this cmdlet when the target NCache server requires Mutual TLS. This parameter is required for Mutual TLS connections even when the cmdlet runs on an NCache server. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. Relative paths are resolved against the current PowerShell location, and the file must exist. You can generate a client certificate using New-NCacheTlsCertificate. | - |
-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. |
- |