From a60865bff69b65f5aa8b3cf604af8774e19a934f Mon Sep 17 00:00:00 2001 From: Shuhei Matsumoto Date: Sat, 5 Sep 2020 23:52:00 +0900 Subject: [PATCH] doc/jsonrpc: Add missing content for the existing nvmf_subsystem_remove_listener RPC Signed-off-by: Shuhei Matsumoto Change-Id: Id889eceee9b2560df585ccaf665c98b7739da37b Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4078 Tested-by: SPDK CI Jenkins Reviewed-by: Aleksey Marchuk Reviewed-by: Jim Harris --- doc/jsonrpc.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 4496930c6..8fe0e9cb5 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -4477,6 +4477,49 @@ Example response: } ~~~ +## nvmf_subsystem_remove_listener method {#rpc_nvmf_subsystem_remove_listener} + +Remove a listen address from an NVMe-oF subsystem. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +nqn | Required | string | Subsystem NQN +tgt_name | Optional | string | Parent NVMe-oF target name. +listen_address | Required | object | @ref rpc_nvmf_listen_address object + +### Example + +Example request: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "method": "nvmf_subsystem_remove_listener", + "params": { + "nqn": "nqn.2016-06.io.spdk:cnode1", + "listen_address": { + "trtype": "RDMA", + "adrfam": "IPv4", + "traddr": "192.168.0.123", + "trsvcid": "4420" + } + } +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + ## nvmf_subsystem_add_ns method {#rpc_nvmf_subsystem_add_ns} Add a namespace to a subsystem. The namespace ID is returned as the result.