Commit 72d94ca8 authored by Monica Kenguva's avatar Monica Kenguva Committed by Tomasz Zawadzki
Browse files

rpc: Document env_dpdk_get_mem_stats 



Signed-off-by: default avatarMonica Kenguva <monica.kenguva@intel.com>
Change-Id: If66d05c14e5758f1b27000d33b4098d73c7a51b3
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6851


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 465dbb04

doc/jsonrpc.md

+37 −0
Original line number Diff line number Diff line
@@ -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}