rpc: Document env_dpdk_get_mem_stats

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: If66d05c14e5758f1b27000d33b4098d73c7a51b3
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6851
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Monica Kenguva 2021-03-11 20:42:58 +00:00 committed by Tomasz Zawadzki
parent 465dbb040c
commit 72d94ca821

View File

@ -1231,6 +1231,43 @@ Example response:
}
}
~~~
## env_dpdk_get_mem_stats {#rpc_env_dpdk_get_mem_stats}
Write the dpdk memory stats to a file.
### Parameters
This method has no parameters.
### Response
The response is a pathname to a text file containing the memory stats.
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "env_dpdk_get_mem_stats",
"id": 1
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"filename": "/tmp/spdk_mem_dump.txt"
}
}
~~~
# Block Device Abstraction Layer {#jsonrpc_components_bdev}
## bdev_set_options {#rpc_bdev_set_options}