Do I need to specify a Process ID when generating a memory dump?

Yes. When creating a memory dump for the NCache Service or NCache Management Center, the corresponding ProcessId must be specified.

Can I generate a memory dump for a specific cache instead of a process?

Yes. You can specify a cache name using the -CacheName (or -cachename on Linux) parameter to generate a memory dump for that cache.

Can New-MemoryDump be executed on a remote server?

Yes. The -Server (or -server) parameter allows you to initiate memory dump generation on a specified remote server.

New-MemoryDump

Q: What does the New-MemoryDump PowerShell cmdlet do?

It allows users to generate a memory dump of a cache or the NCache Service / NCache Management Center process for diagnostic and troubleshooting purposes.

This PowerShell cmdlet allows users to generate a memory dump of a cache or the NCache Service / NCache Management Center process for diagnostic and troubleshooting purposes. When creating a dump for the NCache Service or Management Center, the corresponding Process ID must be specified to identify the target process.

New-MemoryDump executes asynchronously by default and returns immediately without waiting for dump completion; however, users can specify -WaitForCompletion to block execution until the dump is fully generated. Upon execution, the cmdlet outputs the location on the target server where the memory dump file is saved.

Windows PowerShell
Linux CLI

New-MemoryDump -Server -CacheName -ProcessId [-WaitForCompletion] [-Port] [-Credentials] [-NoLogo]

Important

You must specify either CacheName or ProcessId. One of the two is required to generate the memory dump.

Examples

This command initiates dump generation on server 20.200.20.11 for the cache named demoCache.

New-MemoryDump -Server 20.200.20.11 -CacheName demoCache

This command initiates dump generation on server 20.200.20.11 for Process ID 1234.

New-MemoryDump -Server 20.200.20.11 -ProcessId 1234

This command initiates dump generation on server 20.200.20.11 for Process ID 1234 and waits for the dump generation to complete.

New-MemoryDump -Server 20.200.20.11 -ProcessId 1234 -WaitForCompletion

This command initiates dump generation on server 20.200.20.11 for the cache named demoCache using security credentials.

New-MemoryDump -Server 20.200.20.11 -CacheName demoCache -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 Service is running and a cache with the specified cache-name is registered.	-
`-CacheName*`	`<String>`	Specifies cache name for which the dump needs to be created on the server specified. Note: The cache must already exist on the source server.	-
`-ProcessId*`	`<Integer>`	Specifies the Process ID for which dump needs to be created on the server specified.	-
`-WaitForCompletion`	`<SwitchParameter>`	If specified, the cmdlet does not exit until the memory dump is captured.	False
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-Port`	`<Integer>`	Specifies the server port where the NCache Service is listening.	8250
`-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.	-

new-memorydump -server -cachename -processid [-waitforcompletion] [-port] [-userid] [-password] [-nologo]

Important

You must specify either cachename or processid. One of the two is required to generate the memory dump.

Examples

Important

Please note that you need to enable the ptrace flag for the creation of memory dumps in Linux, else you will get the error: "Permission Denied: Failed to take memory dump. This is due to restricted memory access." Set the value of ptrace_scope to 0 to resolve the error. Please note that this change occurs through the combination of echo, the pipe symbol (|), and the tee command, which altogether writes the new value into the system file with the necessary permissions.

This command initiates dump generation on server 20.200.20.11 for the cache named demoCache.

new-memorydump -server 20.200.20.11 -cachename demoCache

This command initiates dump generation on server 20.200.20.11 for Process ID 1234.

new-memorydump -server 20.200.20.11 -processid 1234

This command initiates dump generation on server 20.200.20.11 for Process ID 1234 and waits for the dump generation to complete.

new-memorydump -server 20.200.20.11 -processid 1234 -waitforcompletion

This command initiates dump generation on server 20.200.20.11 for the cache named demoCache using security credentials.

new-memorydump -server 20.200.20.11 -cachename demoCache -userid john_smith -password pass123

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 Service is running and a cache with the specified cache-name is registered.	-
`-cachename*`	`<String>`	Specifies cache name for which the dump needs to be created on the server specified. Note: The cache must already exist on the source server.	-
`-processid*`	`<Integer>`	Specifies the Process Id for which dump needs to be created on the server specified.	-
`-waitforcompletion`	`<SwitchParameter>`	If specified, the cmdlet does not exit until the memory dump is captured.	False
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-port`	`<Integer>`	Specifies the server port where the NCache Service is listening.	8250
`-userid`	`<String>`	Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory user id.	-
`-password`	`<String>`	Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password.	-

New-MemoryDump

Important

Examples

Properties

Note

Contact Us