Send-MemoryDump
This PowerShell cmdlet enables the user to send a memory dump to the FTP server. You will need to specify the path of the memory dump where it is currently stored and the URL of the FTP server to which you will send the dump. The purpose of this cmdlet is to send a memory dump file from a server where NCache is installed to the FTP server.
Send-MemoryDump -Path -FtpServerUrl `
[-FtpServerCredentials] [-WaitForCompletion] `
[-Port] [-Server] `
[-TlsCertPath] [-TlsCertPassword] `
[-Credentials] [-NoLogo]
Examples
- This command sends the memory dump from a local server to the FTP server using port 9803.
Send-MemoryDump -Path "C:\MemoryDump.DMP" -FtpServerUrl "ftp://20.200.20.11/home/files/" `
-FtpServerCredentials ftpuser -Port 9803
- This command sends the memory dump from the 20.200.20.12 server to the FTP server and waits for completion before exiting.
Send-MemoryDump -Path "C:\MemoryDump.DMP" -FtpServerUrl "ftp://20.200.20.11/home/files/" `
-FtpServerCredentials ftpuser -Server 20.200.20.12 `
-WaitForCompletion
- This command uploads
C:\MemoryDump.DMPfrom the specified server toftp://20.200.20.11//home/files/using ftpuser credentials and waits for the upload to complete. It runs from a machine where NCache is not installed, connects to the NCache server using mutual TLS (mTLS), and usesC:\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.
Send-MemoryDump -Path "C:\MemoryDump.DMP" -FtpServerUrl "ftp://20.200.21.11//home/files/" `
-FtpServerCredentials ftpuser -Server 20.200.20.12 `
-WaitForCompletion -TlsCertPath "C:\certs\client.pem" `
-TlsCertPassword "clientKeyPassword"
- This command sends the memory dump from a local server to the FTP server, using security credentials.
Send-MemoryDump -Path "C:\MemoryDump.DMP" -FtpServerUrl "ftp://20.200.20.11/home/files/" `
-FtpServerCredentials ftpuser -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 |
|---|---|---|---|
-Path* |
<String> |
Specifies the path of the memory dump to be sent. | - |
-FtpServerUrl* |
<String> |
Specifies the URL of the FTP server to which the memory dump will be sent. | - |
-FtpServerCredentials |
<pscredential> |
Specifies the FTP server credentials used for authorization. | - |
-WaitForCompletion |
<SwitchParameter> |
Specifies if the command should not exit until the complete memory dump is sent. | False |
-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 |
-Port |
<Integer> |
Specifies the port on which the NCache Service is listening. | 9803 |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. The credentials should belong to a user with appropriate permissions at the node. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-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. |
- |